Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cassiancc/pyrite-toolkit
A NodeJS powered data generator that makes Pyrite possible.
https://github.com/cassiancc/pyrite-toolkit
Last synced: 13 days ago
JSON representation
A NodeJS powered data generator that makes Pyrite possible.
- Host: GitHub
- URL: https://github.com/cassiancc/pyrite-toolkit
- Owner: cassiancc
- Created: 2024-06-05T16:48:02.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-12-03T16:09:06.000Z (19 days ago)
- Last Synced: 2024-12-03T17:24:02.673Z (19 days ago)
- Language: JavaScript
- Homepage: https://modrinth.com/mod/pyrite
- Size: 359 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pyrite Toolkit
The Pyrite Toolkit is a collection of Node.JS scripts that are used for various mod development tasks with a focus on datagen, originally developed for my [Pyrite](https://modrinth.com/mod/pyrite) mod. Since then, I've worked to add additional features to make it useful to my other mods, and maybe even people other than myself.
## Requirements
- [Node.js](https://nodejs.org/en)
## Data Generator
The main `generate.js` script is the primary script used for Pyrite. It generates blockstates, models, language entries, and loot tables for all blocks and items in Pyrite. It is designed to output these files in a format compatible with 1.20.1-1.21.4. It relies on various scripts to achieve this (see section on Helpers.)
#### Example Usage
```bash
node generate.js pyrite
```
# Standalones
These are functions that can work standalone and are therefore not Pyrite specific.
## Flip
This script (`standalones/flip.js`) can be used to flip text or an entire language file. Just provide the path to the `en_us.json` language file or `lang` directory as a CLI argument, and the toolkit will create a upside down language file from an `en_us.json` file in the directory.
### Example Usage
```bash
node standalones/flip.js /home/cassian/Desktop/Pyrite/resources/lang/en_us.json
```
## Resource Pack Path Fixer
This script (`standalones/rp-path-fixer`) loops through a provided resource pack, replacing broken paths wherever possible. At the moment, it replaces spaces with underscores, and converts all textures to lowercase. As this is the newest script, it's undergoing active development to make it more usable.
### Example Usage
```bash
node standalones/rp-path-fixer.js /home/cassian/Desktop/ResourcePack/
```
# Data Generator Helpers
These are various helper functions that work in the background to handle file writing, namespaced ID handling, and mod constants.
#### Tag Helpers
Various helper functions designed to aid the creation of Minecraft tags.
#### Model Helpers
Various helper functions designed to create block models and items.
#### Model Writers
Various helper functions designed to write models to disk.
#### Blockstate Helpers
Various helper functions designed to create blockstates.
#### Blockstate Writers
Various helper functions designed to write blockstates.
#### Translation Helpers
Various helper functions designed to aid in translating Pyrite.
#### Resource Generator
This will eventually become the main script where blocks can be added and deleted.
#### Recipe Helpers
Various helper functions designed to aid in creating shapeless, shaped, and stonecutting recipes.