Giter VIP home page Giter VIP logo

dat-schema's Introduction

PoE dat schema

Source of truth schema for dat files.

Using

Each commit triggers a CI build that exports schema to JSON. You can always curl latest version at github.com/poe-tool-dev/dat-schema/releases/download/latest/schema.min.json

Structure of JSON file is described in src/types.ts

Schema

The schema is based on GraphQL syntax.

Supported scalar types

Type Description
bool Boolean
string String
i32 Signed Integer
f32 Floating Point Number
rid Index to a Row in a Foreign Table

The rid type is intended to be used temporarily until we know the name of foreign table.

The other type for temporary use is _, which is only allowed inside array [_]. You will find it useful if you know that a column is an array but don't know of which type (because they are all zero-length).

Defining relations

  • Using a row index

    Example BaseItem: BaseItemTypes

  • Using a matching value in column (like in relational databases)

    Example SkillId: ActiveSkills @ref(column: "Id")

Supported directives

Directive Description
@ref(column: String) Defines a relation
@unique All values in a column are different
@localized Content of column differs depending on the language
@file(ext: String) Value in a column is a file path
@files(ext: [String]) Value in a column is a common prefix for several files (often with different extensions)
@tags(list: [String]) Add tags to the table as metadata that can be used by tools

dat-schema's People

Contributors

aang521 avatar acbeaumo avatar ansq avatar brather1ng avatar eingin avatar evanwarner avatar exilekit avatar heartofphos avatar lvlvllvlvllvlvl avatar moonovermira avatar snosme avatar yetsiawyeung avatar zaafar avatar zao avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

dat-schema's Issues

ItemClasses > CanBeCorrupted is not correct

The supposed purpose of this column is not correct. All Heist equipment can be corrupted, all Leaguestones are inherently corrupted, and it looks like rare mod conversion can generate corrupted flasks, but these rows all have a false value. Something else is going on with this column.

rids in ItemClasses were changed to enum table names (i32)

#7 changed two rid fields in ItemClasses to enum references (ItemClassCategory and ItemStance). Since the schema file generation turns enum references into i32s, the schema for the table is now smaller than before.

I'm not sure what the best course of action would be here. Since there are probably more of these cases and there is also at least one the other way around (enum-like reference to a type, Maps.MapSeriesKey), maybe some directive for the special cases that allows overriding how the schema generator handles the reference (e.g. @typeReference and @enumReference)?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.