docs update

This commit is contained in:
endernon 2024-12-31 15:39:55 +00:00
parent c5a30d0d46
commit 522a92f864
3 changed files with 21 additions and 3 deletions

View file

@ -37,7 +37,7 @@ run `cargo install idmangler-cli`.
- https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Reference/id_keys.json
- https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Data-Storage/shiny_stats.json
### 3) Actually generating an item
- Read through the provided `config.md` document. You can get the web version [HERE](https://git.frfrnocap.men/endernon/idmangler-cli/src/branch/main/config.md).
- Read through the provided `config.md` document. You can get the web version [HERE](docs/config.md).
- Once you have read through it, use one of the provided json files to create your own json.
- Run the program with it.
- Windows: run `idmangler-cli.exe --config CONFIG_FILE_PATH`

View file

@ -1,4 +1,22 @@
# Values Guide
# Config Guide
According to the [Wynntils Artemis encoding proposal Github Issue](https://github.com/Wynntils/Wynntils/issues/2246),
the allowed blocks should look like this:
![An image of the original encoding proposal table, present on GitHub](encodingproposaltable.png)
However, it's inaccurate. This is what it SHOULD look like:
##### Key to Type Mapping Table
| 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 | Name, Damage, Defense, Custom Identifications, Powders |
| `4` | Crafted Consumable Item | Custom Consumable Type, Uses, Requirements | Effects, Name, Custom Identifications |
| `5` | Crafted Item from Recipe | TODO | TODO |
## Name
**Name** is stored as a String. It must be a valid Wynncraft item for it to display as intended.
## Shiny ID
@ -32,7 +50,7 @@ The use of spaces is optional, as well as letter case for the $TYPE value.
The keys ("type" "tier" "amount") must All be lowercase.
If type is invalid, it will default back to being Thunder powder.
#### Powders Example (yes, this looks wacky to show that this is allowed)
```json
```
"powders": [
{ "type":"T", "tier":6, "amount":5 },
{"type" :"e","tier":1,"amount":5},

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB