https://github.com/cyclopsmc/infobook-html-integrateddynamics
Output the Integrated Dynamics infobook as HTML
https://github.com/cyclopsmc/infobook-html-integrateddynamics
hacktoberfest
Last synced: 24 days ago
JSON representation
Output the Integrated Dynamics infobook as HTML
- Host: GitHub
- URL: https://github.com/cyclopsmc/infobook-html-integrateddynamics
- Owner: CyclopsMC
- License: mit
- Created: 2019-07-16T15:03:16.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-23T14:36:45.000Z (almost 2 years ago)
- Last Synced: 2025-02-19T10:18:51.469Z (over 1 year ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage: https://integrateddynamics.rubensworks.net/book/
- Size: 18.4 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Cyclops Infobook HTML - Integrated Dynamics
[](https://integrateddynamics.rubensworks.net/book/)
Output Integrated Dynamics infobooks as HTML.
This makes use of the [Cyclops Infobook HTML](https://github.com/CyclopsMC/infobook-html) tool with Integrated Dynamics-specific appendix handlers.
## Registries
The following registries are created with this plugin:
* `registries/aspect.json`: The aspect registry.
* `registries/drying_basin_recipe.json`: The drying basin recipe registry.
* `registries/squeezer.json`: The squeezer recipe registry.
* `registries/mechanical_drying_basin_recipe.json`: The mechanical drying basin recipe registry.
* `registries/mechanical_squeezer_recipe.json`: The mechanical squeezer registry.
* `registries/operator.json`: The operator registry.
* `registries/part_aspect.json`: The part to aspects registry.
## Requirements
### Icon Generation
This phase should be done using the [Icon Exporter mod](https://github.com/CyclopsMC/IconExporter).
Simply create a modpack with all the mods that were downloaded in the previous step (including the Item Exporter mod),
start a world, and run the `/iconexporter export 64` command.
Next, copy the resulting contents of `icon-exports-x64` to `icons` in your project directory.
### Configuration
Configure the generator using the following files:
* `modpack.json`: The mods that should be loaded during metadata generation.
* `config.json`: HTML serialization settings.
## Usage
Executing `npm run generate` will do two things:
1. Generate metadata by starting a temporary Forge server.
2. Output HTML to `output/`.
## License
This software is written by [Ruben Taelman](http://rubensworks.net/).
This code is released under the [MIT license](http://opensource.org/licenses/MIT).