idmangler-cli/docs/config.md

43 lines
2.3 KiB
Markdown
Raw Normal View History

2024-12-31 15:39:55 +00:00
# Config Guide
2024-12-31 17:27:56 +00:00
## The required blocks
2024-12-31 15:39:55 +00:00
According to the [Wynntils Artemis encoding proposal Github Issue](https://github.com/Wynntils/Wynntils/issues/2246),
the allowed blocks should look like this:
2024-12-31 15:54:45 +00:00
![An image of the original encoding proposal table, present on GitHub](images/encodingproposaltable.png)
2024-12-31 15:39:55 +00:00
However, it's inaccurate. This is what it SHOULD look like:
##### Key to Type Mapping Table
2024-12-31 15:54:45 +00:00
| Key | Type | Required blocks | Optional blocks |
|-----|--------------------------|--------------------------------------------|-------------------------------------------------------------|
| `0` | Gear Item | Name | Identifications, Powders, Shiny, Reroll |
| `1` | Tome Item | Name | Identifications, Reroll |
| `2` | Charm Item | Name | Identifications, Reroll |
| `3` | Crafted Gear Item | Custom Gear Type, Durability, Requirements | NameAfter, Damage, Defense, Custom Identifications, Powders |
| `4` | Crafted Consumable Item | Custom Consumable Type, Uses, Requirements | Effects, NameAfter, Custom Identifications |
| `5` | Crafted Item from Recipe | TODO | TODO |
2024-09-09 23:29:23 +00:00
2024-12-31 17:27:56 +00:00
## Documentation for each block:
- [Item type](blocks/type.md)
- [Custom Gear Type (NOT IMPLEMENTED YET)](blocks/customgeartype.md)
- [Custom Consumable Type (NOT IMPLEMENTED YET)](blocks/customconsumtype.md)
- [Durability (NOT IMPLEMENTED YET)](blocks/durability.md)
- [Requirements (NOT IMPLEMENTED YET)](blocks/requirements.md)
2024-12-31 17:27:56 +00:00
- [Name](blocks/name.md)
- [NameAfter (NOT IMPLEMENTED YET)](blocks/nameafter.md)
2024-12-31 17:27:56 +00:00
- [Shiny](blocks/shiny.md)
- [Identifications](blocks/identifications.md)
- [Damage (NOT IMPLEMENTED YET)](blocks/damage.md)
- [Defense (NOT IMPLEMENTED YET)](blocks/defense.md)
- [Effects (NOT IMPLEMENTED YET)](blocks/effects.md)
2024-12-31 23:36:30 +00:00
- [Powders](blocks/powders.md)
- [Custom Identifications (NOT IMPLEMENTED YET)](blocks/identifications.md)
2024-12-31 21:14:07 +00:00
- [Reroll](blocks/reroll.md)
2024-09-09 23:29:23 +00:00
# Current issues
Crafteds are not implemented