finish doc migration
This commit is contained in:
parent
f6d9feacec
commit
468a6d29f1
5 changed files with 34 additions and 18 deletions
27
docs/blocks/identifications.md
Normal file
27
docs/blocks/identifications.md
Normal file
|
@ -0,0 +1,27 @@
|
|||
# Identifications
|
||||
- This data block encodes for identifications on Gear-type items.
|
||||
- Not to be confused with [Custom Identifications](identificationscustom.md).
|
||||
- Field name: `ids`
|
||||
- Field type: `Array[id, base, roll]`
|
||||
- # Id
|
||||
- This is the ID that is used. It corresponds to the Wynntils internal name for an identification.
|
||||
- See [HERE](https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Reference/id_keys.json) for a list.
|
||||
- Field name: `id`
|
||||
- Field type: `String`
|
||||
- Example: `"id":"1stSpellCost"`
|
||||
- # Base
|
||||
- This is the base value. This value defines the range for 0% to 100% of any stat on any item.
|
||||
- It is defined for any item in [THIS](https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Reference/gear.json) data file. Use a json beautifier, then look for `ITEMNAME > identifications > IDENTIFICATION_NAME > raw` for the base value.
|
||||
- Field name: `base`
|
||||
- Field type: `Signed 32-bit Integer`
|
||||
- Field range: `–2147483648` to `2147483647`
|
||||
- # Roll (OPTIONAL)
|
||||
- This is the roll value. It defines the actual roll percent for the identification.
|
||||
- The formula for the final shown percentage on the final item is `BASE * ROLL / 100`.
|
||||
- Positive values are in the range 30-130 due to how Wynncraft handles many Identifications as `(0.3 <-> 1.3) x baseStat`.
|
||||
- If you are trying to find the ROLL value, try your desired roll VALUE **(NOT the roll percentage)** divided by the BASE STAT then round it to the nearest integer.
|
||||
- This value is optional, BUT you should only exclude it when it is a fixed value and not a range, e.g. Skill Points are always fixed.
|
||||
- Field name: `roll`
|
||||
- Field type: `Unsigned 8-bit Integer`
|
||||
- Field range: `0` to `255`
|
||||
- ...But for it to be a valid item, `30` to `130` (positive base stat) and `70` to `130` (negative base stat).
|
0
docs/blocks/identificationscustom.md
Normal file
0
docs/blocks/identificationscustom.md
Normal file
3
docs/blocks/reroll.md
Normal file
3
docs/blocks/reroll.md
Normal file
|
@ -0,0 +1,3 @@
|
|||
## Rerolls
|
||||
Optional single value, i8. Stores number of rerolls. If missing or is 0, rerolls are not encoded.
|
||||
Potential range: 0<->255.
|
|
@ -25,26 +25,12 @@ However, it's inaccurate. This is what it SHOULD look like:
|
|||
- [Name](blocks/name.md)
|
||||
- [Shiny](blocks/shiny.md)
|
||||
- [Powder Limit](blocks/powderlimit.md)
|
||||
- [Powder](blocks/powder.md)
|
||||
- [Powders](blocks/powders)
|
||||
- [Identifications](blocks/identifications.md)
|
||||
- [Custom Identifications](blocks/identifications.md)
|
||||
- [Reroll](blocks/reroll.md)
|
||||
|
||||
|
||||
## Identifications
|
||||
### Format
|
||||
Inside the "ids":[] array, set it up in the following structure.
|
||||
**{"id": "$ID","base": $BASE,"roll": $ROLL}**
|
||||
**ID** is stored as a string corresponding to the Wynntils internal ID string of any roll. See here for a list: https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Reference/id_keys.json .
|
||||
**BASE** is the base roll. The default base data is defined in (WARNING: EXTREMELY MASSIVE TEXT FILE) https://raw.githubusercontent.com/Wynntils/Static-Storage/main/Reference/gear.json .
|
||||
Beautify it then look for `ITEMNAME > identifications > IDENTIFICATIONNAME > raw` for default value. This base value defines the listed ID ranges.
|
||||
**ROLL** defines the actual rolled value for the Identification. The formula is `BASE * ROLL / 100`. Most values are in the range 30-130 due to how Wynncraft handles many Identifications as 30-130 percent of a base stat. Thus, if you are trying to find the ROLL value, try your desired roll **(NOT the roll percentage 1-100)** divided by the BASE then round it to the nearest integer. This value is optional, and you should only exclude it when it is a fixed value e.g. Skill Points.
|
||||
|
||||
## Rerolls
|
||||
Optional single value, i8. Stores number of rerolls. If missing or is 0, rerolls are not encoded.
|
||||
Potential range: 0<->255.
|
||||
|
||||
### Other things about this
|
||||
The format obeys the same json rules as the powders.
|
||||
If you are trying to get the 100% or 0% roll and the value you calculated is close to 130 or 30, change it to 130 or 30 because that is the real value.
|
||||
However, if the value is negative it will be between 70%-130%.
|
||||
|
||||
# Current issues
|
||||
Crafteds are not implemented
|
Loading…
Reference in a new issue