docs bigger refactor
This commit is contained in:
parent
fa9a50b60e
commit
f6d9feacec
6 changed files with 83 additions and 50 deletions
|
|
@ -1,8 +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.
|
||||
|
||||
# Name
|
||||
This data block encodes for the name of an item.
|
||||
- Field name: `name`
|
||||
- Field type: `String`
|
||||
- Example: `"name":"Singularity"`
|
||||
- **NOTES FOR GEAR TYPE ITEMS**:
|
||||
- It must be a valid Wynncraft item name for it to display as intended.
|
||||
- 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. 
|
||||
36
docs/blocks/powder.md
Normal file
36
docs/blocks/powder.md
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
# Powders
|
||||
- This data block encodes for powders present on the item.
|
||||
- Field name: `powders`
|
||||
- Field type: `Array[type, tier, amount]`
|
||||
- Field range: `0` to `255` powders total.
|
||||
- ## Type
|
||||
- This is the type of powder that is present.
|
||||
- Field name: `type`
|
||||
- Field type: `Char`
|
||||
- Field potential values: `E`,`T`,`W`,`F`,`A`
|
||||
- Field fallback value (if invalid): `T`
|
||||
- These values represent Earth, Thunder, Water, Fire, and Air.
|
||||
- ## Tier
|
||||
- This is the powder tier, although it really doesn't do anything as by default Wynntils only encodes to and accepts Tier 6.
|
||||
- Field name: `tier`
|
||||
- Field type: `Unsigned 8-bit Integer`
|
||||
- Field range: `1` to `6`
|
||||
- ## Amount (OPTIONAL)
|
||||
- For each entry in the `powders` array, this is the amount of powders encoded.
|
||||
- Field name: `amount`
|
||||
- Field type: `Unsigned 8-bit Integer`
|
||||
- Field range: `1` to `255`
|
||||
- Field fallback value (if not provided): `1`
|
||||
## EXAMPLE of the Powders array
|
||||
```
|
||||
"powders": [
|
||||
{ "type":"T", "tier":6, "amount":5 },
|
||||
{"type" :"e","tier":1,"amount":5},
|
||||
{"type": "F", "tier": 3,"amount":1},
|
||||
{ "type" : "w" , "tier":6 }
|
||||
]
|
||||
```
|
||||
## Which items can have powders?
|
||||
Powders can only be encoded on an item that originally supported powders in the first place.
|
||||
Unfortunately you can't add powders to an item that didn't originally have them.
|
||||
e.g. can't put powder on depressing shears, as depressing weapons don't have powder slot.
|
||||
8
docs/blocks/powderlimit.md
Normal file
8
docs/blocks/powderlimit.md
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
# Powder Limit
|
||||
- This data block encodes for the number of powders allowed.
|
||||
- It doesn't do anything useful, it isn't the powder limit visible on the item.
|
||||
- If you are encoding powders, this must be present, and must be more than or equal to the number of powders you have encoded.
|
||||
- Field name: `powder_limit`
|
||||
- Field type: `Unsigned 8-bit Integer`
|
||||
- Field range: `0` to `255`
|
||||
- Example: `"powder_limit": 255`
|
||||
17
docs/blocks/shiny.md
Normal file
17
docs/blocks/shiny.md
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
# Shiny
|
||||
This data block encodes for Shiny data present on gear items.
|
||||
- Field name: `shiny`
|
||||
- Field type: `{key, value}`
|
||||
- Example: `"shiny": {"key": "playersKilled","value": 20}`
|
||||
- ## Key
|
||||
- This is the type of the shiny stat present.
|
||||
- The potential keys for any shiny value are listed [HERE](https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Data-Storage/shiny_stats.json).
|
||||
- Field name: `key`
|
||||
- Field type: `String`
|
||||
- Example: `"key": "playersKilled"`
|
||||
- ## Value
|
||||
- This is the value of the shiny stat present.
|
||||
- Field name: `value`
|
||||
- Field type: `Signed 64-bit Integer`
|
||||
- Field range: `-9,223,372,036,854,775,808` to `9,223,372,036,854,775,807`
|
||||
- Example: `"value":"20"`
|
||||
6
docs/blocks/type.md
Normal file
6
docs/blocks/type.md
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
# Item type
|
||||
- This data block encodes for the type of the item that's being encoded.
|
||||
- This will support crafteds in the future, but for now the value MUST be `"Gear".`
|
||||
- Field name: `item_type`
|
||||
- Field type: `String`
|
||||
- Example: `"item_type": "Gear"`
|
||||
|
|
@ -1,4 +1,6 @@
|
|||
# Config Guide
|
||||
|
||||
## The required blocks
|
||||
According to the [Wynntils Artemis encoding proposal Github Issue](https://github.com/Wynntils/Wynntils/issues/2246),
|
||||
the allowed blocks should look like this:
|
||||
|
||||
|
|
@ -17,50 +19,14 @@ However, it's inaccurate. This is what it SHOULD look like:
|
|||
| `4` | Crafted Consumable Item | Custom Consumable Type, Uses, Requirements | Effects, NameAfter, Custom Identifications |
|
||||
| `5` | Crafted Item from Recipe | TODO | TODO |
|
||||
|
||||
## Shiny ID
|
||||
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 value is the shown amount.
|
||||
## Item type
|
||||
WIP. This will support crafteds in the future, but for now you must have this:
|
||||
```
|
||||
"item_type": "Gear"
|
||||
```
|
||||
|
||||
## Powders
|
||||
## Documentation for each block:
|
||||
- [Item type](blocks/type.md)
|
||||
- [Name](blocks/name.md)
|
||||
- [Shiny](blocks/shiny.md)
|
||||
- [Powder Limit](blocks/powderlimit.md)
|
||||
- [Powder](blocks/powder.md)
|
||||
|
||||
### Powder Limit
|
||||
Powder limit cannot be increased beyond 255. This is because the powder count is stored as a byte.
|
||||
Potential value range: 0<->255.
|
||||
|
||||
### Format
|
||||
Inside the "powders":[ ] array, set it up in the following structure.
|
||||
**{ "type":"$TYPE", "tier":$TIER, "amount": $AMOUNT }**
|
||||
**TYPE** is stored as a single character.
|
||||
Potential Values: "E" "T" "W" "F" "A" . These represent Earth, Thunder, Wind, Fire, Air.
|
||||
**TIER** is stored as a single digit integer.
|
||||
Potential value range: 1<->6.
|
||||
**AMOUNT** is stored as an integer. It is optional. If not provided it falls back to 1.
|
||||
Potential value range: 1<->255.
|
||||
#### Other things about powder format:
|
||||
Each value in the array must have a comma at the end except the last.
|
||||
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)
|
||||
```
|
||||
"powders": [
|
||||
{ "type":"T", "tier":6, "amount":5 },
|
||||
{"type" :"e","tier":1,"amount":5},
|
||||
{"type": "F", "tier": 3,"amount":1},
|
||||
{ "type" : "w" , "tier":6 }
|
||||
]
|
||||
```
|
||||
Note that the last powder block in array has no comma at the end.
|
||||
### Which items can have powders?
|
||||
Powders can only be encoded on an item that originally supported powders in the first place.
|
||||
Unfortunately you can't add powders to an item that didn't originally have them.
|
||||
e.g. can't put powder on depressing shears, as depressing weapons don't have powder slot.
|
||||
|
||||
## Identifications
|
||||
### Format
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue