Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/legopitstop/mcaddon
Minecraft: Bedrock Edition development kit
https://github.com/legopitstop/mcaddon
add-on bedrock-edition behaviorpack development-kit json mcaddon mcpack minecraft resourcepack
Last synced: about 1 month ago
JSON representation
Minecraft: Bedrock Edition development kit
- Host: GitHub
- URL: https://github.com/legopitstop/mcaddon
- Owner: legopitstop
- License: mit
- Created: 2024-01-13T00:14:40.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-03-17T04:44:37.000Z (9 months ago)
- Last Synced: 2024-03-17T07:20:06.138Z (9 months ago)
- Topics: add-on, bedrock-edition, behaviorpack, development-kit, json, mcaddon, mcpack, minecraft, resourcepack
- Language: Python
- Homepage: https://pypi.org/project/mcaddon/
- Size: 27.3 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# mcaddon
[](https://pypi.org/project/mcaddon/)
[](https://www.python.org/downloads//)
[](https://github.com/ambv/black)
[](https://github.com/legopitstop/mcaddon/issues)
Utility functions for creating Minecraft Bedrock Add-Ons.
Documentation: https://mcaddon.readthedocs.io/
## Installation
Install the module with pip:
```bat
pip3 install mcaddon
```
Update existing installation: `pip3 install mcaddon --upgrade`
## Requirements
| Name | Description |
|--|--|
| [`mclang`](https://pypi.org/project/mclang/) | Read and write to .lang files. |
| [`molang`](https://pypi.org/project/molang/) | Molang to Python Translator & interpreter written in pure Python. |
| [`commentjson`](https://pypi.org/project/commentjson/) | Add Python and JavaScript style comments in your JSON files. |
| [`jsonschema`](https://pypi.org/project/jsonschema/) | An implementation of JSON Schema validation for Python |
| [`chevron`](https://pypi.org/project/chevron/) | Mustache templating language renderer |
| [`Pillow`](https://pypi.org/project/pillow/) | Python Imaging Library (Fork) |
| [`numpy`](https://pypi.org/project/numpy/) | Fundamental package for array computing in Python |
| [`PyGLM`](https://pypi.org/project/PyGLM/) | OpenGL Mathematics library for Python |
## Our Goal?
Our goal is to create a library that can create a mcaddon or mcpack from the ground up using Python.
## Features
- Load packs from any format version.
- Supports [mustache](https://mustache.github.io/) logic-less templates.
## Examples
### Block
```Python
from mcaddon import *
blk = Block('test:on_interact_change_state_block')
blk.add_component(OnInteractComponent(event='test_event'))
blk.add_event('test_event', SetBlockProperty({'custom:direction': "1"}))
blk.save('block.json')
```
### Item
```Python
from mcaddon import *
blk = Item('minecraft:blaze_rod')
blk.add_component(FuelComponent(12.0))
blk.add_component(MaxStackSizeComponent(64))
blk.add_component(IconComponent('blaze_rod'))
blk.add_component(HandEquippedComponent(True))
blk.add_component(DisplayNameComponent('Blaze Rod'))
blk.save('item.json')
```
## Command-line interface
```
usage: mcaddon [-h] [-V] [-W []]
options:
-h, --help show this help message and exit
-V, --version print the mcaddon version number and exit.
-W [], --watch []
Watches this Python file for changes.
```
## Road map
- Resource packs
- [ ] animation_controllers
- [ ] animations
- [ ] attachables
- [ ] biomes_client.json
- [ ] block models
- [ ] entity
- [ ] flipbook_textures.json
- [ ] font
- [ ] materials
- [ ] particles
- [ ] pieces
- [ ] render_controllers
- [ ] sounds
- [ ] sounds.json
- [ ] texture set
- [ ] ui
- [x] blocks.json
- [x] entity models
- [x] item_textures.json
- [x] terrain_textures.json
- [x] texts
- [x] textures
- Behavior packs
- [ ] entities
- [ ] spawn_rules
- [ ] structures
- [x] blocks
- [x] cameras
- [x] feature_rules
- [x] features
- [x] items
- [x] loot_tables
- [x] recipes
- [x] texts
- [x] trading
- [x] volume
- [x] block_culling
- Skin packs
- [x] Addons
- contents.json
- cli
- update mcaddon/mcpack
- [x] Support to load all format versions. (At least all versions that are used in vanilla packs)
- Support to import packs. (for both singleplayer and on dedicated server)
- Make Model and Texture support common 3D rendering libraries; pygame, moderngl, etc
- Toolchain to load packs
- scripting - Convert Python to the Official Minecraft [Scripting and API](https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/minecraft-server?view=minecraft-bedrock-stable).