https://github.com/cyclopsmc/infobook-html-evilcraft

Output the EvilCraft infobook as HTML
https://github.com/cyclopsmc/infobook-html-evilcraft

hacktoberfest

Last synced: 3 days ago
JSON representation

Output the EvilCraft infobook as HTML

• Host: GitHub
• URL: https://github.com/cyclopsmc/infobook-html-evilcraft
• Owner: CyclopsMC
• License: mit
• Created: 2019-07-25T15:40:18.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-07-28T15:51:15.000Z (4 months ago)
• Last Synced: 2024-07-28T16:28:00.053Z (4 months ago)
• Topics: hacktoberfest
• Language: TypeScript
• Homepage: https://evilcraft.rubensworks.net/book/
• Size: 20.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 - EvilCraft

[![Build Status](https://github.com/CyclopsMC/infobook-html-evilcraft/workflows/Build%20and%20Deploy/badge.svg)](https://evilcraft.rubensworks.net/book/)

Output EvilCraft 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/blood_infuser_recipe.json`: The blood infuser recipe registry.

* `registries/envir_acc_recipe.json`: The environmental accumulator registry.

* `registries/broom_modifiers.json`: The broom modifiers registry.

## Requirements

### Icon Generation

This phase should be done using the [Item 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).