n9gc / mcdjs

通过 JS 来编写指令 ～ Using JS to program Minecraft commands

像写指令一样写 JS

——或者说，像写 JS 一样写指令 。

查看在线文档

安装

若想使用 McdJS 编写指令，首先你需要有一个 McdJS 编译器。 目前来说只有一种方法安装。

安装于本地

1. 配置 Node.js 环境

   本项目基本使用 JS 编写。 要想在本地运行 JS 你首先需要安装 Node.js 环境。

   你可以到 Node.js 官网 上找到匹配自己系统的版本，然后下载安装。

   配好 Node.js 环境的标志是打开终端（ linux 上为 bash 或 zsh ， Windows 上为 cmd.exe 或 powershell ）然后输入

   node -v

   如果得到了类似下方这种格式的版本号，或者只要没出什么一眼看起来是错误的错误，那基本就是配好了。

   v19.8.1
   

2. 获取 McdJS 命令行工具

   一般来说除了特殊需要（例如开发基于 McdJS API 的 JS 库）以外，可以选择使用命令行在终端进行编译。 于是我们需要使用包管理器全局安装 McdJS 及其命令行工具。

   使用 npm 这个会和 Node.js 捆绑安装的包管理器进行安装：

   npm i mcdjs-cli -g

3. 完成

   到此我们已可以通过命令行来使用 McdJS 了。 像这样执行 mcdjsc 即可：

   mcdjsc -v

   一般来说此时会得到当前 McdJS 的版本。 否则要不然是你安装坏了，要不然是本项目还没开发完……

mcdjs's Issues

将一种使用 JS 语法的全新语言作为代指令

目前，代指令是一种基于项目中所定义 API 的 JS 的内部 DSL ，例如

If(select('@e'))
  .Then(() => {
    Command.say('a');
  })
  .Else(() => {
    Command.say('b');
  });

我觉得由此导致的一个较为明显的问题就是代指令过于繁琐。
我在这里把这门语言叫做“旧的语言”。

所以本人希望将一种使用 JS 语法的全新语言作为代指令。
希望效果如下

if ('@e') {
  say('a');
} else {
  say('b');
}

我觉得这门语言暂且可以叫做“新的语言”。

如何实现

对于新的语言的解析，我认为完全可以使用 babylon 、 recast 等现成的 JS 解析器进行解析，而这些解析器得到的 AST 基本是 ESTree 格式。
鉴于开发到目前（2023/6/27），本项目的转译依然是基于一种较为“特别”的 AST 格式，所以我觉得第一个需要做出抉择的问题就是使用了新的语言之后，对于 AST 的操作是继续使用目前的这种特别的格式，还是转为使用 ESTree 格式。

——为了方便，在我写下这些的时候，我粗浅地给目前使用的这个“特别”的格式起了个名字叫做 McdJS APIs Generated AST 简称 MagAST 。

• 改为使用 ESTree

  若我们改为使用 ESTree ，则首先对于 MagAST 的生成和转译等部分要全部重写——基本相当于重写整个项目了。
  其次，考虑到指令究竟跟 JS 不一样，我觉得在符合 ESTree 标准的情况下得到一个可以表示每个命令方块串内每个命令的结构是极为困难的。
  我觉得这也代表通过编写 babel 插件来实现 McdJS 的功能不太现实，因为基本无法通过访问器模式在不破坏 ESTree 标准的情况下进行转译操作。
  因为源 AST 的格式和目标格式究竟是不同的，这大概意味着对树的遍历方式大概是可变的，所以貌似从头实现一个访问器也不简单。

  所以我认为改用 ESTree 是不太现实的。

• 继续使用 MagAST

  若继续使用 MagAST ，就需要考虑把新的语言生成的 ESTree 转为 MagAST 。
  可行的做法本人想到了两种：

  1. 分析整个 ESTree 然后直接转为 MagAST 。
  2. 操作 ESTree 得到旧的语言，再运行旧的语言来得到 MagAST 。

  鉴于目前对 API 的开发已经达到了一定程度，我认为在这里第二种方法更好。
  操作 AST 生成新的 JS 代码正是 babel 等编译器的工作，所以理论上我们只需要开发一个 babel 插件，就可将新的语言编译为旧的语言，简直是皆大欢喜了。

于此，我个人得到的结论是在基于 MagAST 的转译和旧的语言的基础上，可以通过开发一个 babel 插件，使新的语言可以被编译为旧的语言，从而实现新的语言。