endernon/idmangler-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases 7 Packages Wiki Activity Actions

docs bigger update

Browse source
This commit is contained in:
endernon 2024-12-31 15:54:45 +00:00
parent 88092f1456
commit 5e55c04d22
4 changed files with 17 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/blocks/name.md Normal file
View file

@ -0,0 +1,8 @@
## Name
**Name** is stored as a String. It must be a valid Wynncraft item for it to display as intended.
NOTE: in game, the name has a limit of 48 characters.
That means that the final tier Legendary Island item,
"Outlandish Replica Face Mask of Legendary Victory",
only encodes up to "Victor". Thus, it does not work in game.
![frfr.png](../images/outlandish_mask.png)

20
docs/config.md
View file

@ -2,23 +2,21 @@
According to the [Wynntils Artemis encoding proposal Github Issue](https://github.com/Wynntils/Wynntils/issues/2246), According to the [Wynntils Artemis encoding proposal Github Issue](https://github.com/Wynntils/Wynntils/issues/2246),
the allowed blocks should look like this: the allowed blocks should look like this:
![An image of the original encoding proposal table, present on GitHub](encodingproposaltable.png) ![An image of the original encoding proposal table, present on GitHub](images/encodingproposaltable.png)
However, it's inaccurate. This is what it SHOULD look like: However, it's inaccurate. This is what it SHOULD look like:
##### Key to Type Mapping Table ##### Key to Type Mapping Table
| Key | Type | Required blocks | Optional blocks | | Key | Type | Required blocks | Optional blocks |
|-----|--------------------------|--------------------------------------------|--------------------------------------------------------| |-----|--------------------------|--------------------------------------------|-------------------------------------------------------------|
| `0` | Gear Item | Name | Identifications, Powders, Shiny, Reroll | | `0` | Gear Item | Name | Identifications, Powders, Shiny, Reroll |
| `1` | Tome Item | Name | Identifications, Reroll | | `1` | Tome Item | Name | Identifications, Reroll |
| `2` | Charm 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 | | `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, Name, Custom Identifications | | `4` | Crafted Consumable Item | Custom Consumable Type, Uses, Requirements | Effects, NameAfter, Custom Identifications |
| `5` | Crafted Item from Recipe | TODO | TODO | | `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 ## Shiny ID
Inside the Shiny{} list, there will be two elements: "key" and "value". Inside the Shiny{} list, there will be two elements: "key" and "value".
The potential keys for any shiny value are listed here: https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Data-Storage/shiny_stats.json The potential keys for any shiny value are listed here: https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Data-Storage/shiny_stats.json

0
docs/encodingproposaltable.png → docs/images/encodingproposaltable.png
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 47 KiB

BIN
docs/images/outlandish_mask.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 32 KiB