# systems.sister.item

> Published by [vault.pds.sister.systems](https://lexicon.garden/identity/did:plc:e2gllbtzj3go3vaiimn4qmls)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:e2gllbtzj3go3vaiimn4qmls/systems.sister.item)
- [Documentation](https://lexicon.garden/lexicon/did:plc:e2gllbtzj3go3vaiimn4qmls/systems.sister.item/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:e2gllbtzj3go3vaiimn4qmls/systems.sister.item/examples)

## Definitions

### `systems.sister.item`

**Type**: `record`

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `icon` | `blob` | No |  |
| `name` | `string` | Yes |  |
| `tags` | `array` | No |  |
| `stats` | `array` | No |  |
| `hidden` | `boolean` | No |  |
| `rarity` | `string` | Yes |  |
| `creator` | `string` | No |  |
| `giftUri` | `string` | No |  |
| `equipped` | `boolean` | No |  |
| `giftFrom` | `string` | No |  |
| `itemType` | `string` | Yes |  |
| `openedAt` | `string` (datetime) | No |  |
| `openedBy` | `string` | No |  |
| `tradable` | `boolean` | No |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `receivedAt` | `string` (datetime) | No |  |
| `description` | `string` | No |  |
| `lootboxRkey` | `string` | No |  |
| `unusualEffect` | `string` | No |  |
| `sourceCrateRkey` | `string` | No |  |
| `levelRequirement` | `integer` | No |  |

### `systems.sister.item#stat`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes |  |
| `value` | `integer` | Yes |  |

## Raw Schema

```json
{
  "id": "systems.sister.item",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "name",
          "rarity",
          "itemType",
          "createdAt"
        ],
        "properties": {
          "icon": {
            "type": "blob",
            "accept": [
              "image/*"
            ],
            "maxSize": 2000000
          },
          "name": {
            "type": "string",
            "maxLength": 128,
            "minLength": 1
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 64,
              "minLength": 1
            },
            "maxLength": 50
          },
          "stats": {
            "type": "array",
            "items": {
              "ref": "#stat",
              "type": "ref"
            },
            "maxLength": 50
          },
          "hidden": {
            "type": "boolean"
          },
          "rarity": {
            "enum": [
              "common",
              "uncommon",
              "rare",
              "epic",
              "legendary",
              "unusual"
            ],
            "type": "string"
          },
          "creator": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1
          },
          "giftUri": {
            "type": "string",
            "maxLength": 512,
            "minLength": 1
          },
          "equipped": {
            "type": "boolean"
          },
          "giftFrom": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1
          },
          "itemType": {
            "enum": [
              "weapon",
              "armor",
              "consumable",
              "cosmetic",
              "material",
              "misc",
              "crate",
              "table",
              "toolkit",
              "helperCrate",
              "shovel",
              "glasses"
            ],
            "type": "string"
          },
          "openedAt": {
            "type": "string",
            "format": "datetime"
          },
          "openedBy": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1
          },
          "tradable": {
            "type": "boolean"
          },
          "createdAt": {
            "type": "string",
            "format": "datetime"
          },
          "receivedAt": {
            "type": "string",
            "format": "datetime"
          },
          "description": {
            "type": "string",
            "maxLength": 4096
          },
          "lootboxRkey": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1
          },
          "unusualEffect": {
            "enum": [
              "burning_flames",
              "scorching_flames",
              "sunbeams",
              "cloud_9",
              "arcana",
              "chiroptera_inzanium",
              "dark_fate",
              "spellbound",
              "vivid_plasma",
              "purple_energy",
              "blue_phosphorus"
            ],
            "type": "string"
          },
          "sourceCrateRkey": {
            "type": "string",
            "maxLength": 256,
            "minLength": 1
          },
          "levelRequirement": {
            "type": "integer",
            "minimum": 0
          }
        }
      }
    },
    "stat": {
      "type": "object",
      "required": [
        "name",
        "value"
      ],
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 64,
          "minLength": 1
        },
        "value": {
          "type": "integer"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```