Skip to content

771835/dovetail

Repository files navigation

Dovetail

English Version | 中文版本

Minecraft数据包编译语言 - 具有部分面向对象特性的解决方案
Dovetail 是一种具有面向对象特征的语言,可以编译成Minecraft 数据包(以下简称数据包)。它旨在将传统命令的过程导向改变为目标导向。 由于技术限制,短期内将不会有新的功能实现提交。

目前状态:

  • 优点: 语法基本可用,能够编译简单程序。
  • 已知局限: 缺乏大量标准库、错误信息不友好、优化器可能引入错误、尚未实现完整的OOP特性和数组借用机制。
  • 生产环境建议: 如果您需要用于生产环境,请考虑使用 MCFPP 或其他成熟的项目。
  • 性质: 相较于clang-mc等追求稳定性的项目,本项目会更偏向使用较为激进的特性和优化,以及对一些内容的实验性处理,这些修改可能不会特殊标注且缺少长期的稳定维护。
  • 语法: 语法更新迭代较快,因此不保证向后兼容,仅发布正式发行版时保证附带示例语法正确,面对对象具体语法待定,可能存在较大变化
  • Minecraft 版本支持: 相较于其他语言,本项目不会有较为稳定的版本支持,即不会长期停留在特定版本,官方支持的后端会将主要精力集中于迭代至 Minecraft 的最新游戏版本,具体支持版本见下文环境要求

目标

  • 一次编写,处处报错编译
  • 基本面对对象支持
  • 完善的依赖库,使开发者不直接操纵指令
  • 低开销数据包
  • 迭代版本跟上我的世界版本大版本更新

长期计划

  • 通过使用前置数据包以提高安全性及性能
  • 优化错误显示
  • 统一日志输出
  • 完善插件api
  • 提高优化效果
  • 寻找尽量节省性能的堆栈实现方法
  • 编译器国际化支持
  • 允许通过简单的语法声明和调用其他数据包
  • 谓词,自定义数据等功能
  • 函数一等公民化
  • 简易事件系统及注解功能
  • 完善内置库

快速开始

环境要求

  • Python 3.11+(支持且推荐使用pypy)
  • Minecraft Java Edition 1.21.4-1.21.5

安装

git clone https://github.com/771835/dovetail.git
cd dovetail
pip install -r requirements.txt
python main.py -O2 xxx.mcdl

代码示例

// 定义函数
fn greet(name: string) {
    print(f"Hello, {name}");
}

// 入口函数(使用@init注解)
@init
fn main() {
    greet("World")
    greet("Bob")
}

贡献

如何参与贡献

  • 提交问题建议:
    • 提交一个 issue,项目作者或其他贡献者会进行修改。
  • 修复或提交问题:
    • 提交一个 issue 或创建拉取请求,等待修复或功能实现。
  • 实现复杂功能:
    • 根据相应功能创建或更新 DFP 文档提案。
    • 待社区讨论达成共识后,克隆新分支进行代码修改。
    • 进行测试,确保功能正确。
    • 合并代码至主分支。

关于AI工具使用

本项目允许在编写过程中使用AI等辅助工具,但请务必对生成的代码进行审查。每个贡献中,AI等工具所占代码比例不得超过30%。

FAQ

Q: 为什么不支持递归?
A: 递归需要运行时维护栈帧,在Minecraft中实现性能消耗较大,因此建议将递归算法改写成迭代实现。
Q: 有技术可以解决递归,但是项目选择忽视?
A: 因为技术所限,以及作者本身精力有限
Q: 为什么编译器提示未知错误并提供堆栈信息?该如何解决? A: 请在 GitHub 提交一个 issue,报告该问题。
Q: 明明我的代码没有错误,生成出的数据包却无法正确执行
A: 请尝试禁用代码优化,若生成的数据包正确执行,请以代码优化错误为issue标题前缀,否则以未知错误作为标题前缀
Q: 为什么生成的数据包在执行时中止?
A: 请尝试使用gamerule指令适当提高maxCommandChainLength规则的数量
Q: 找不到可用后端怎么办?
A: 安装对应后端插件

已知特性(长期内不会修复)

  • 不支持递归
  • 先进的泄漏式内存管理

许可证

本项目采用 Apache 2.0 授权

这意味着您可以自由地将其用于个人或商业目的,无需经过本项目作者或贡献者直接许可。

但是,如果您在项目/产品中使用了本作品并从中获得了商业价值,本项目非常欢迎您通过以下方式予以认可(以下内容不是强制的):

  • 注明来源:在您的产品文档或在关于页面中提及本项目。
  • 分享改进:将您基于本项目所做的改进回馈给社区。
  • 进行贡献:欢迎提交代码、报告问题、改进文档或提出建议,共同让项目变得更好。

感谢您的支持!

鸣谢

参与测试

  • 4424 在项目前期发现了诸多bug并提出了大量具有建设性的意见

代码使用

由于 Minecraft 版本以及实际使用等原因,使用时可能会对以下项目进行一定的必要修改。如果您是以下项目作者或贡献者,且不希望您的项目被使用或修改,请联系本项目作者讨论移除事宜。

  • 项目StringLib 提供了大量不安全但还算快速的字符串操作手段

数据使用

其他推荐

  • 《Feature》 是由香草图书馆团队主办的,面向原版模组(数据包+资源包)开发的短文收集与展示的平台,用于开发者之间的交流,每月更新。

思路来源/大佬鸣谢

  • 大佬zmr-233 提出了解决递归问题的思路(虽然ta推荐的书我都没看,也没实现)
  • 项目MCFPP 处理堆栈的一个不同技术路线的优秀项目
  • 项目clang-mc 十分创新的想法,实现汇编的在mc中的部分支持,潜力巨大

Packages

 
 
 

Contributors