WynnSource Item Encoding Schema

This is a definition for how each item in WynnCraft is represented in our data structure. We will describe the schema in protobuf which can be used to generate library for multiple languages.

Supported Item Types

• Gears
  • IdentifiedGear
  • UnidentifiedGear
  • CraftedGear
• Consumables
  • Crafted
    • Potion
    • Food
    • Scroll
  • NonCrafted
    • Potion
    • FixedConsumable (e.g. Speed Surge)
• Material
• Ingredient
• Tome
• Charm
• Aspect
• Rune
• DungeonKey
• CrafterBag
• Trinket
• Mounts
  • Horse
• TeleportationScroll
• Corkians
  • CorkianAmplifier
  • CorkianSimulator
  • CorkianInsulator
• Emeralds
  • LiquidEmerald
  • EmeraldBlock
  • Emerald
• EmeraldPouch
• NamedItem (e.g. Quest Items, Ability Shards, etc.)
• UnidentifiedGearBox

Mappings

• Identification Mapping
• Shiny Mapping
• Consumable Mapping we use the same mapping for identification and consumables

Contribution

We use buf to manage our protobuf schema. We use prek to install and run pre-commit hooks.

Before contributing, please make sure to install the pre-commit hooks by running prek install in the root directory of this repository.

Credits

• Wynntils We referenced their encoding schema and id/shiny mapping when designing ours.
• WynnCraft Wiki