Mecha
A powerful Minecraft command library.
from mecha import Mecha
mc = Mecha()
function = """
execute
as @a # For each "player",
at @s # start at their feet.
anchored eyes # Looking through their eyes,
facing 0 0 0 # face perfectly at the target
anchored feet # (go back to the feet)
positioned ^ ^ ^1 # and move one block forward.
rotated as @s # Face the direction the player
# is actually facing,
positioned ^ ^ ^-1 # and move one block back.
if entity @s[distance=..0.6] # Check if we're close to the
# player's feet.
run
say I'm facing the target!
"""
ast = mc.parse(function, multiline=True)
print(mc.serialize(ast)) # execute as @a at @s anchored eyes facing ...
Introduction
This package provides everything you need for working with Minecraft commands in Python, whether you're looking to process commands or build abstractions on top.
Features
- Extensible and version-agnostic
mcfunctionparser - Clean, immutable and hashable abstract syntax tree with source location
- Command config resolver that flattens and enumerates all the valid command prototypes
- Powerful rule dispatcher for processing specific ast nodes
- Composable ast visitors and reducers
- (soon) Execute arbitrary compilation passes in your
beetpipeline - (soon) Expressive command API for writing commands in Python
Credits
- A few test cases are adapted from
SPYGlass - Multiline example by
AjaxGb(MCC discord) - Multiline syntax derived from the
hangmanplugin - Partially inspired by
Trident
Installation
The package can be installed with pip.
$ pip install mecha
Contributing
Contributions are welcome. Make sure to first open an issue discussing the problem or the new feature before creating a pull request. The project uses poetry.
$ poetry install
You can run the tests with poetry run pytest.
$ poetry run pytest
The project must type-check with pyright. If you're using VSCode the pylance extension should report diagnostics automatically. You can also install the type-checker locally with npm install and run it from the command-line.
$ npm run watch
$ npm run check
The code follows the black code style. Import statements are sorted with isort.
$ poetry run isort mecha tests
$ poetry run black mecha tests
$ poetry run black --check mecha tests
License - MIT
1 Dec 26, 2021
282 Dec 27, 2022
5 Jan 28, 2022
40 Jan 03, 2023
1 Apr 09, 2022
10 Sep 20, 2022
6 Aug 01, 2022
5 Sep 27, 2021
161 Dec 26, 2022
144 Jan 05, 2023
1 Dec 24, 2021
5 Dec 15, 2021
4 Apr 27, 2022
1 Oct 21, 2021
131 Dec 25, 2022
3 Jan 02, 2023
3 Mar 14, 2022
8 Dec 13, 2022
7 Sep 14, 2022
2 Dec 17, 2021