https://github.com/xia-mc/clang-mc

A Development Toolchain for Minecraft Datapacks.
https://github.com/xia-mc/clang-mc

compiler llvm minecraft minecraft-datapack programming stdlib toolchain

Last synced: about 23 hours ago
JSON representation

A Development Toolchain for Minecraft Datapacks.

• Host: GitHub
• URL: https://github.com/xia-mc/clang-mc
• Owner: xia-mc
• License: apache-2.0
• Created: 2025-02-12T18:18:20.000Z (2 days ago)
• Default Branch: main
• Last Pushed: 2025-02-12T18:26:23.000Z (2 days ago)
• Last Synced: 2025-02-12T19:33:30.387Z (2 days ago)
• Topics: compiler, llvm, minecraft, minecraft-datapack, programming, stdlib, toolchain
• Language: mcfunction
• Homepage:
• Size: 31.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


English | [简体中文](./README_CN.md)

# clang-mc

## A Development Toolchain for Minecraft Datapacks

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)

[![Issues](https://img.shields.io/github/issues/xia-mc/clang-mc)](https://github.com/xia-mc/clang-mc/issues)

![Version](https://img.shields.io/badge/Minecraft-1.21_and_later-blue)



> [!NOTE]

> `clang-mc` is in the early stages of development, and many features are not yet complete. Contributions and feedback are welcome!

## Introduction

`clang-mc` is a **compiler toolchain** designed specifically for **Minecraft datapack development**. It aims to provide a more efficient and maintainable development environment while offering a standard library to reduce redundant implementations of common functionalities.

Minecraft datapack development has long suffered from **poor readability, maintenance challenges, and functional limitations**. For example:

- **Lack of modern programming language features**: String manipulation, floating-point arithmetic, and large integer operations are extremely difficult to implement.

- **Disorganized code structure**: Datapacks often rely on a large number of manually written commands, and many requirements must be indirectly implemented using multiple `.mcfunction` files, making reuse and expansion difficult.

This project seeks to address these issues to some extent.

Check out [Wiki](https://github.com/xia-mc/clang-mc/wiki) to learn more.

---

## Roadmap

- [x] **Basic implementation of the `stdlib` standard library**, establishing a low-overhead virtual machine model on `mcfunction`.

- [x] **Write a wiki** to define calling conventions, register conventions, stack conventions, etc.

- [ ] **Implement an assembler (IR)** to translate IR into `mcfunction` code based on `stdlib`.

- [ ] **Develop a parser** to convert assembly code into IR objects.

- [ ] **Create a showcase** to demonstrate the advantages of this project and how it improves datapack readability while reducing redundant implementations.

- [ ] **Enhance `stdlib`** with more advanced abstractions.

- [ ] **(Long-term goal) Implement an LLVM backend** to generate assembly code (IR).

- [ ] **(Long-term goal) Achieve compatibility with C/C++/Rust ecosystems**, leveraging LLVM to extend the capabilities of `mcfunction`.

---

## Contributions

Contributions are welcome! Feel free to submit issues or pull requests.  

Please note that this project is still in its early stages, and we greatly appreciate any feedback or suggestions.

---

## Acknowledgments

Without these projects, `clang-mc` would not exist:

- [Minecraft](https://www.minecraft.net) - The sandbox game developed by Mojang Studios.

- [LLVM](https://llvm.org) - A powerful compiler infrastructure, open-sourced under the Apache License 2.0.

Special thanks to all contributors in the open-source community!