diff --git a/docs/blocks/identifications.md b/docs/blocks/identifications.md index 5f83209..bc5627b 100644 --- a/docs/blocks/identifications.md +++ b/docs/blocks/identifications.md @@ -3,6 +3,7 @@ - Not to be confused with [Custom Identifications](identificationscustom.md). - Field name: `ids` - Field type: `Array[id, base, roll]` +- Example: `"id":"1stSpellCost","base":69,"roll":30` - # 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. @@ -15,6 +16,7 @@ - Field name: `base` - Field type: `Signed 32-bit Integer` - Field range: `–2147483648` to `2147483647` + - Example: `"base":69` - # 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`. @@ -24,4 +26,19 @@ - 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). \ No newline at end of file + - ...But for it to be a valid item, `30` to `130` (positive base stat) and `70` to `130` (negative base stat). + - Example: `"roll":30` + +## Example Identifications for a perfect Singularity: +```json + "ids": [ + {"id": "mainAttackDamage","base": 320,"roll": 69}, + {"id": "healthRegenRaw", "base":250 , "roll":130 }, + {"id": "rawDexterity", "base":35 }, + {"id": "walkSpeed", "base":-40 , "roll":69}, + {"id": "mainAttackDamage", "base":15, "roll":130 }, + {"id": "rawMainAttackDamage", "base":444 , "roll":130 }, + {"id": "rawSpellDamage", "base":222 , "roll":130 }, + {"id": "spellDamage", "base":10 , "roll":130 } + ], +``` \ No newline at end of file diff --git a/docs/blocks/powders.md b/docs/blocks/powders.md index 5740355..978b5b5 100644 --- a/docs/blocks/powders.md +++ b/docs/blocks/powders.md @@ -5,29 +5,34 @@ - Field range: `0` to `255` powders total. - ## Type - This is the type of powder that is present. + - These values represent Earth, Thunder, Water, Fire, and Air. - 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. + - Example: `"type":"E"` - ## 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` + - Example: `"tier":6` - ## Amount (OPTIONAL) - For each entry in the `powders` array, this is the amount of powders encoded. + - It is optional, as it's just used to make encoding lots of the same powder easier. + - For example, you could repeat `{"type":"E", "tier":6}` six times, or just do `{"type":"E", "tier":6, "amount":6}` and both would be the same. - Field name: `amount` - Field type: `Unsigned 8-bit Integer` - Field range: `1` to `255` - Field fallback value (if not provided): `1` + - Example: `"amount":6` ## 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 } + {"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? diff --git a/docs/blocks/reroll.md b/docs/blocks/reroll.md index f0f2a97..ea061fe 100644 --- a/docs/blocks/reroll.md +++ b/docs/blocks/reroll.md @@ -1,3 +1,6 @@ -## Rerolls -Optional single value, i8. Stores number of rerolls. If missing or is 0, rerolls are not encoded. -Potential range: 0<->255. \ No newline at end of file +## Rerolls (OPTIONAL) +- This data block encodes the number of rerolls. +- Field name: `rerolls` +- Field type: `Unsigned 8-bit Integer` +- Field range: `0` to `255` +- Example: `"rerolls":"125"` \ No newline at end of file diff --git a/docs/config.md b/docs/config.md index e6785e0..ffbc387 100644 --- a/docs/config.md +++ b/docs/config.md @@ -34,7 +34,7 @@ However, it's inaccurate. This is what it SHOULD look like: - [Defense (NOT IMPLEMENTED YET)](blocks/defense.md) - [Effects (NOT IMPLEMENTED YET)](blocks/effects.md) - [Powder Limit](blocks/powderlimit.md) -- [Powders](blocks/powders) +- [Powders](blocks/powders.md) - [Custom Identifications (NOT IMPLEMENTED YET)](blocks/identifications.md) - [Reroll](blocks/reroll.md)