Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Arcensoth/mcgen
Python utilities for downloading and processing Minecraft's generated data.
https://github.com/Arcensoth/mcgen
Last synced: 2 months ago
JSON representation
Python utilities for downloading and processing Minecraft's generated data.
- Host: GitHub
- URL: https://github.com/Arcensoth/mcgen
- Owner: Arcensoth
- License: mit
- Created: 2021-04-07T18:17:44.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-21T18:55:31.000Z (about 2 years ago)
- Last Synced: 2024-04-01T12:04:02.271Z (3 months ago)
- Language: Python
- Size: 47.9 KB
- Stars: 8
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE.txt
Lists
- awesome-mcc - mcgen - create your own copy of mcdata (Uncategorized / Uncategorized)
README
# mcgen
Python utilities for downloading and processing Minecraft's generated data.
[](https://pypi.org/project/mcgen/)
[](https://pypi.org/project/mcgen/)
[](https://github.com/arcensoth/mcgen)
## Requirements
- Python 3.8+
- Java 11+ (for invoking the Minecraft server's data generator)
## Installation
```bash
pip install mcgen
```
## Usage
```bash
python -m mcgen --help
```
```
mcgen [-h] [--jarpath JARPATH] [--rawpath RAWPATH] [--outpath OUTPATH] [--version VERSION] [--manifest MANIFEST] [--processors [PROCESSORS [PROCESSORS ...]]] [--log LOG]
Download the Minecraft server jar for the specified version, invoke the data generator, and process the output.
optional arguments:
-h, --help show this help message and exit
--jarpath JARPATH Where to download and store the server jar. Default: temp/jars/minecraft_server.{version}.jar
--rawpath RAWPATH Where to store the raw server-generated files. Default: temp/raw/{version}
--outpath OUTPATH Where to write the final processed output. Default: temp/out/{version}
--version VERSION The server version to download and process. Defaults to latest snapshot.
--manifest MANIFEST Where to fetch the version manifest from. Defaults to Mojang's online copy.
--processors [PROCESSORS [PROCESSORS ...]]
Which processors to use in processing the raw server-generated files. Defaults to a set of built-in processors.
--log LOG The level of verbosity at which to print log messages.
```
## Processors
Processors are used to process the raw server-generated data and produce output. They are invoked one after the other, in the order they are defined.
To provide a custom set of processors, use the `--processors` option like so:
```bash
python -m mcgen --processors mcgen.processors.split_registries mcgen.processors.summarize_data
```
### Built-in processors
Several built-in processors are provided in [`mcgen.processors`](./mcgen/processors):
- [`write_version_file`](./mcgen/processors/write_version_file.py) - Write the game version to a file.
- [`convert_json_files`](./mcgen/processors/convert_json_files.py) - Convert json files into another form.
- [`simplify_blocks`](./mcgen/processors/simplify_blocks.py) - Create an optimized summary of blocks.
- [`split_registries`](./mcgen/processors/split_registries.py) - Split `registries.json` into separate files.
- [`summarize_data`](./mcgen/processors/summarize_data.py) - Create a summary of each vanilla registry.
- [`summarize_worldgen`](./mcgen/processors/summarize_worldgen.py) - Create a summary of worldgen reports.
- [`create_all_tags_data_pack`](./mcgen/processors/create_all_tags_data_pack.py) - Generate a data pack with "all" tags.
## Custom processors
Processors are Python modules containing a function with the following signature:
```python
def process(ctx: Context, **options):
...
```
- `ctx` contains information about the processing context
- `options` is a key-value mapping of arbitrary data
## 21w39a
Note that in snapshot 21w39a the `java` command used to invoke the server generator changed:
```bash
# Prior to 21w39a:
java -cp {jar_path} net.minecraft.data.Main --server --reports
# From 21w39a onward:
java -DbundlerMainClass=net.minecraft.data.Main -jar {jar_path} --server --reports
```
If you need to generate data for versions prior to 21w39a, use the `--cmd` option with the older `java` command.