LuaDatapack

模组

· 作者 kinderhead

一个允许在数据包中包含 Lua 的简单模组

0 本站下载 0 关注 更新于 3 年前

需要前置:Fabric API

最新 0.11.0-beta · 1.20.1 · Fabric

一键开服(送7天)

Logo

LuaDatapack

允许在 Minecraft 中运行 Lua 脚本。

注意:LuaDatapack 处于测试阶段,因此 API 可能会发生变化。

我目前不太打算在这个项目上投入更多精力。相反,我一直在开发一种专用的编程语言,它可编译为 Minecraft 命令,名为 Amethyst。它比这个更有用,因为它不需要专用的模组。

使用方法

创建一个带有 lua 子文件夹的新数据包。例如:data/foo/lua/bar.lua。

功能特性

  • 底层使用 Cobalt,提供快速的执行时间
  • 可以使用 require 从数据包中包含脚本,并使用 Minecraft 的命名空间 ID 系统
  • 支持 TypeScriptToLua
  • 支持一些常见的实用库

命令

/lua

用法:/lua <name> [<args>]

示例,要运行 data/foo/lua/bar.lua:/lua foo:bar

可以通过 Lua 脚本中的名为 args 的数组访问参数。

API

API 参考文档可在 此处 找到。

标准库

默认包含了一些实用库。

库 路径
json.lua std:json
class.lua std:class
标准 Lua 库 std:math
标准 Lua 库 std:string
标准 Lua 库 std:bit32
标准 Lua 库 std:utf8
命令库 std:commands
存储库 std:storage
配置工具库 std:config

注意:如果你更喜欢不同的 OOP 库,只需将其添加到你的数据包中即可。

项目系统

有一个简单的项目系统,允许自定义哪些脚本可以被执行以及被外部项目(不同命名空间下的脚本)导入。

要自定义你的项目,请在你的命名空间中添加一个 _project.lua 文件。例如,如果命名空间是 foo,那么你可以创建 foo:_project.lua:

return {
    scripts = {"foo:bar"},
    exports = {"foo:baz"},
    depends = {"hello"},

    load = {"foo:load"},
    tick = {"foo:tick"}
}

在上述示例中,foo:bar 是一个通过 /lua 运行的脚本,foo:baz 是一个任何文件都可以 require 的脚本,并且它需要 hello 项目才能正常运行。脚本可以导入同一命名空间中的任何脚本,即使它未包含在 exports 数组中。如果项目不包含 _project.lua,则默认使用 std:_default_datapack:

local config = require("std:config")

return {
    scripts = config.without_underscore(),
    exports = {}
}

注意:并非所有字段都需要显式定义。

如果项目加载失败,其中的所有脚本都无法加载。

贡献

构建此仓库与任何其他 Fabric 模组相同。在游戏启动时,可能会出现库(Cobalt、Apache commons-io 等)无法加载的问题,但通过 VSCode 调试器运行游戏却可以正常工作(原因不明)。

待办事项

  • 优化 Lua API
  • 添加更多 API 功能
  • 减少内部对命令的使用

计划中的功能

链接

源码:

Modrinth:

API 参考:

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源