https://github.com/atrufulgium/fronttick
c# compiler and framework targeting Minecraft datapacks
https://github.com/atrufulgium/fronttick
Last synced: 3 months ago
JSON representation
c# compiler and framework targeting Minecraft datapacks
- Host: GitHub
- URL: https://github.com/atrufulgium/fronttick
- Owner: Atrufulgium
- License: mit
- Created: 2022-06-06T16:37:33.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-09T17:48:05.000Z (over 1 year ago)
- Last Synced: 2025-01-16T00:14:07.151Z (5 months ago)
- Language: C#
- Size: 779 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
FrontTick
======
The aim of this project is to simplify creating behavioural Minecraft data packs. As you're probably aware if you found this repo, writing `.mcfunction` files by hand can be a massive pain; the arithmetic is verbose, simple if-statements usually result in several files, loops require recursion, etc.
These things would not be a problem if you had some more sensible language, (say, c#) and compiled down into data packs. That is exactly the purpose of this repo.
Table of Contents
======
1. [Supported Features](#supported-features)
1. [Data types](#data-types)
2. [Data transformation](#data-transformation)
3. [Control flow](#control-flow)
4. [Minecraft-specific](#minecraft-specific)
5. [Higher-level Minecraft framework](#higher-level-minecraft-framework)
6. [Other](#other)
2. [Project Setup](#project-setup)
3. [Using this project](#using-this-project)
4. [Why the name?](#why-the-name)
Supported Features
======
What follows is a list of features that have been implemented *and* unimplemented. Think of it both like a sort of to-do list, in no particular order, and like a reference of what you can do.
For a short tl;dr: no, <feature you care about> isn't implemented yet, and you can't reference *anything* but `MCMirror`. Which should be included in code-form. (You can add the dll with xml comments as a reference for VS though.)
Data types
------
- [x] Integers.
- [ ] Built-in value types other than `int`. (Note: currently `int`, `bool`.)
- [x] Static fields.
- [x] Static properties.
- [x] General structs.
- [ ] Static arrays.
- [ ] Strings.
- [ ] Objects.
- [ ] Recursive data types.
- [ ] Genericism.
- [ ] Inheritance.
Data transformation
------
- [x] Assignments of the form `=` or `∘=` where `∘` is one of `+`, `-`, `*`, `/`, `%`.
- [x] Arbitrary arithmetic.
- [x] Static function calls.
- [x] General function calls.
- [x] Return.
- [x] `ref`, `in`, `out` modifiers. (Note: only for value types.)
- [ ] Recursive function calls.
Control flow
------
- [x] Branching by comparing to constants.
- [x] General branching.
- [x] Goto.
- [ ] Switches.
- [ ] Switches' `goto case`.
- [x] `for`, `while`, `do while` with `break` and `continue`.
- [ ] `foreach`.
- [ ] Throw simple exceptions.
Minecraft-specific
------
- [x] `[MCFunction]` entrypoints to code.
- [x] Tick (any interval) and load code.
- [x] Literal `mcfunction` code.
- [ ] Selectors + `foreach` over selectors.
- [ ] World-specific stuff like `/weather` and `/gamerule`.
- [ ] Read/write blocks.
- [ ] Read/write (block) entities' nbt. (Wiki autogen letsgo.)
Higher-level Minecraft framework
------
- [ ] Custom items.
- [ ] Custom mobs.
- [ ] In a *very* far future: Blockbench support for the above custom mobs.
Other
------
- [x] A very simple in-game testing framework.
- [ ] MSIL support instead of just c# code.
- [ ] More optimised output
- [ ] Proper documentation.
Project Setup
======
To be honest I still don't get how VS works around this kind of stuff. I'm using Roslyn via the packages listed at [the Compiler project's .csproj file](./Compiler/Compiler/Compiler.csproj). In any case, there are four projects in the repo:
- [**`Compiler`**](./Compiler/Compiler):
As the name suggests, this is where the developement of the compiler happens.
(References Roslyn and `MCMirror`.)
- [**`CompilerTests`**](./Compiler/CompilerTests):
Testing the compiler on the c# side of things. These tests are mainly to check whether the transformations work as prescribed, whether the resulting data pack is correct is irrelevant.
(References `Compiler`.)
- [**`IngameTests`**](./Compiler/IngameTests):
Testing the compiler on the Minecraft side of things. These tests do not care about the process of the compiler, but instead test whether the resulting data pack is correct.
(References `MCMirror`.)
- [**`MCMirror`**](./Compiler/MCMirror):
A project to map Minecraft (implementable) features to c# usage. This is what end-users will use when creating data packs.
- There will at some point be a fifth project as sample.
See also [the gotchas](./gotchas.md).
Using this project
======
In order to use this project, in addition to patience, you need two things:
- The compiler itself. You'll probably need to build it from source but maybe you live in the far future where the project's far enough to have releases, *wow*!
In order to use the compiler, there's four options you can read about in [Program.cs](./Compiler/Compiler/Program.cs). I know, the use-friendliness is off the charts (in the wrong direction). In general, you specify a directory to compile, a directory where `MCMirror` lives, a Minecraft worldname, and optionally some namespace.
- The `MCMirror` project. You can reference it all you like in dll form or whatever, but you also need to have the code-form somewhere on your machine to point the compiler to. As such it's convenient to just keep it next to the project you're interested in.
At some point in the far future this will be made more streamlined than this jank.
Why the name?
======
Because `backtick` exists as a unicode character already.