https://github.com/onelitefeathernet/stelaris-cli
CLI tool to generate Minecraft related data for the programming language dart
https://github.com/onelitefeathernet/stelaris-cli
Last synced: 4 months ago
JSON representation
CLI tool to generate Minecraft related data for the programming language dart
- Host: GitHub
- URL: https://github.com/onelitefeathernet/stelaris-cli
- Owner: OneLiteFeatherNET
- License: apache-2.0
- Created: 2025-03-09T13:58:56.000Z (4 months ago)
- Default Branch: develop
- Last Pushed: 2025-03-09T15:00:45.000Z (4 months ago)
- Last Synced: 2025-03-09T15:25:08.263Z (4 months ago)
- Language: Kotlin
- Size: 247 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
## Stelaris CLI
The `stelaris-cli` is a command-line tool that generates Dart files which contain data from the game Minecraft.
The data is extracted from the game using the [Microtus](https://github.com/OneLiteFeatherNET/Microtus) fork of Minestom
and transformed into Dart files using the code generation library [DartPoet](https://github.com/theEvilReaper/DartPoet).
> [!CAUTION]
> The project is currently in development and is not intended to be used by the public as a finished product.
> Missing data and bugs are to be expected.
### Versioning
For each call of the CLI, a new version tag is created for the generated files. To improve the identification which
version is related for which Minecraft version, the versioning schema follows the one of Minecraft with the addition of
a `-rv` tag. If a version for a specific Minecraft version is generated again, the revision tag will be incremented.
An example of a version tag would be `1.17.1-rv1`. This helps to identify the latest version for a specific Minecraft
version. If a new version is available, the revision tag will be incremented (e.g., `1.17.1-rv2`).
### Usage
The CLI comes with a few arguments which can be used to customize the process of generating the Dart files.
Below is a list of all available arguments:
- `-update ` - Updates the version tag of the generated files
- `-help` - Displays the help message
- `-experimental` - Enables experimental features
#### Examples
### Contributing
The tool does not generate all data from the game, so contributions are welcome. It should be noted that the data should
come from the game and not be added manually. For more information on how to contribute to the project,
see [CONTRIBUTING.md](CONTRIBUTING.md).