Customizes docs: readme and screenshot

This commit is contained in:
AliasAlreadyTaken 2024-07-02 16:31:22 +02:00
parent c1260d0ada
commit 1c159c47c9
2 changed files with 11 additions and 5 deletions

View File

@ -3,7 +3,7 @@
## Purpose
This mod is a library which brings various food-related functions.
This mod is a library which brings various nodestage-related functions.
## Download
@ -24,7 +24,7 @@ Set to true to enable debug mode
```
yl_api_nodestages.maximum_stages
```
Set this to the maximum stages your food can have.
Set this to the maximum stages your node can have.
## Usage
@ -32,15 +32,17 @@ This mod can be used in singleplayer and multiplayer. It comes with no direct co
### Modmakers
Use the following public functions related to food.
Use the following public functions related to nodestages.
## Limitations
Although this mod intends to achieve everything and more the canned_food mod brings with it, there is no guarantee it will look and feel entirely the same.
* No randomized duration except by registering the same stage as a next_stage again
## Alternatives
This is in parts a rewrite of [canned_food](https://github.com/h-v-smacker/canned_food)
* Implement nodetimers, ABMs or LBMs
## Supported versions
@ -48,6 +50,10 @@ If you use yl_api_nodestages, but something is wrong, please [file a bug](https:
There is no reason to believe it doesn't work anywhere, but you never know.
## Allied projects
* [yl_canned_food](https://gitea.your-land.de/your-land/yl_canned_food/)
## Uninstall
Remove it from your mod folder or deactivate it in your world.mt

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 1020 KiB