dev.tsunagite.game

tsunagite.dev

Documentation

A record describing a game hosting leaderboards via Tsunagite.

main record

A record describing a game hosting leaderboards via Tsunagite.

Record Key any Any valid record key

Properties

defaultComponent string record-key Required

The default component for leaderboard sorting.

inputMethods array of string Optional

An array of usable input methods for the game. Optional if the game only has one input method or doesn't separate leaderboards by method.

modes array of string Optional

An array of playable game modes with different gameplay configurations. Optional if the game only has one mode.

scoreComponents object Required

All the components of a score in the game, including grades, lamps, EX score, and whatever other constructs are used.

View raw schema 
{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "judgments",
      "scoreComponents",
      "defaultComponent"
    ],
    "properties": {
      "logo": {
        "type": "blob",
        "accept": [
          "image/png",
          "image/jpeg",
          "image/jxl",
          "image/webp"
        ],
        "maxSize": 8000000,
        "description": "The logo of the game, for display in UI."
      },
      "name": {
        "ref": "dev.tsunagite.translatable",
        "type": "ref",
        "description": "The human-readable name of the game, for display in UI."
      },
      "modes": {
        "type": "array",
        "items": {
          "type": "string",
          "description": "Can be tokens or raw strings.",
          "knownValues": [
            "dev.tsunagite.singles",
            "dev.tsunagite.doubles"
          ]
        },
        "description": "An array of playable game modes with different gameplay configurations. Optional if the game only has one mode."
      },
      "judgments": {
        "type": "array",
        "items": {
          "ref": "dev.tsunagite.types#indexable",
          "type": "ref",
          "description": "Indices will be displayed in ascending order."
        },
        "description": "The obtainable judgments during gameplay."
      },
      "inputMethods": {
        "type": "array",
        "items": {
          "type": "string",
          "description": "Can be tokens or raw strings.",
          "knownValues": [
            "dev.tsunagite.keyboard",
            "dev.tsunagite.gamepad"
          ]
        },
        "description": "An array of usable input methods for the game. Optional if the game only has one input method or doesn't separate leaderboards by method."
      },
      "scoreComponents": {
        "type": "object",
        "properties": {
          "$keyFormat": {
            "type": "string",
            "format": "record-key",
            "maxLength": 32,
            "minLength": 1
          },
          "$valueType": {
            "refs": [
              "#enum",
              "#points",
              "#percentage",
              "#text"
            ],
            "type": "union",
            "description": "If you need a component type that doesn't exist yet, contact @lemmaeof.gay"
          }
        },
        "description": "All the components of a score in the game, including grades, lamps, EX score, and whatever other constructs are used."
      },
      "defaultComponent": {
        "type": "string",
        "format": "record-key",
        "description": "The default component for leaderboard sorting."
      }
    }
  },
  "description": "A record describing a game hosting leaderboards via Tsunagite."
}
enum object

A closed set of indexable named values.

Properties

View raw schema 
{
  "type": "object",
  "required": [
    "name",
    "values"
  ],
  "properties": {
    "name": {
      "ref": "dev.tsunagite.translatable",
      "type": "ref",
      "description": "The human-readable name of this component in UI."
    },
    "values": {
      "type": "array",
      "items": {
        "ref": "dev.tsunagite.types#indexable",
        "type": "ref"
      },
      "description": "The allowed values for this enum to take."
    }
  },
  "description": "A closed set of indexable named values."
}
percentage object

A percentage score with customizable precision.

Properties

maximum integer Required

The maximum allowed percentage for this score.

precision integer Required

The number of decimal places to include in the percentage.

View raw schema 
{
  "type": "object",
  "required": [
    "name",
    "maximum",
    "precision"
  ],
  "properties": {
    "name": {
      "ref": "dev.tsunagite.translatable",
      "type": "ref",
      "description": "The human-readable name of this component in UI."
    },
    "maximum": {
      "type": "integer",
      "default": 100,
      "description": "The maximum allowed percentage for this score."
    },
    "precision": {
      "type": "integer",
      "default": 2,
      "description": "The number of decimal places to include in the percentage."
    }
  },
  "description": "A percentage score with customizable precision."
}
points object

An integer point score, with or without a cap.

Properties

maximum integer Optional

The maximum allowed value for this score.

View raw schema 
{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "ref": "dev.tsunagite.translatable",
      "type": "ref",
      "description": "The human-readable name of this component in UI."
    },
    "maximum": {
      "type": "integer",
      "description": "The maximum allowed value for this score."
    }
  },
  "description": "An integer point score, with or without a cap."
}
text object

A fallback component for displaying arbitrary text.

Properties

View raw schema 
{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "ref": "dev.tsunagite.translatable",
      "type": "ref",
      "description": "The human-readable name of this component in UI."
    }
  },
  "description": "A fallback component for displaying arbitrary text."
}

Lexicon Garden

@