Protocol/protocol.jsonc at main · SkyblockServer/Protocol · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
// All Incoming and Outgoing definitions are based on the Client's POV

{
  // Main
  "Metadata": {
    "id": 1,
    "direction": "incoming",
    "data": {
      "heartbeat_interval": "int"
    }
  },
  "Heartbeat": {
    "id": 2,
    "direction": "outgoing",
    "data": {}
  },
  "SessionCreate": {
    "id": 4,
    "direction": "incoming",
    "data": {
      "session_id": "string",
      "seq": "short"
    }
  },
  "Identify": {
    "id": 3,
    "direction": "outgoing",
    "data": {
      "uuid": "string",
      "username": "string",
      "apiKey": "string"
    }
  },

  // Auctions
  "RequestAuctions": {
    "id": 4,
    "direction": "outgoing",
    "data": {
      "filters": {
        "type": "array",
        "data": {
          // [type (converted to lowercase)] = [value]

          // Category = weapon | armor | accessories | consumables | blocks | misc
          // Rarity = COMMON | UNCOMMON | RARE | EPIC | LEGENDARY | MYTHIC | DIVINE | SPECIAL | VERY_SPECIAL
          // Type = any | auction | bin

          "type": "string",
          "value": "string"
        }
      },
      // Empty string if none
      "query": "string",
      // high_price | low_price | end_near | end_far | random
      "order": {
        "type": "enum",
        "name": "Orders",
        "values": ["high_price", "low_price", "end_near", "end_far", "random"]
      },
      // 0-based index of the first item (includes it)
      "start": "short",
      // Amount of items to get
      "amount": "short"
    }
  },
  "Auctions": {
    "id": 5,
    "direction": "incoming",
    "data": {
      "auctions": {
        "type": "array",
        "data": {
          "auction_id": "string",
          "seller": "string",
          "seller_profile": "string",
          "itemBytes": "string",
          // Stringified block data
          "itemData": "string",
          "data": {
            "type": "object",
            "data": {
              "name": "string",
              "lore": "stringArray",
              "category": {
                "type": "enum",
                "name": "AuctionCategories",
                "values": ["weapon", "armor", "accessories", "consumables", "blocks", "misc"]
              },
              "rarity": {
                "type": "enum",
                "name": "ItemRarities",
                "values": ["COMMON", "UNCOMMON", "RARE", "EPIC", "LEGENDARY", "MYTHIC", "DIVINE", "SPECIAL", "VERY_SPECIAL"]
              }
            }
          },
          "timestamps": {
            "type": "object",
            "data": {
              "start": "long",
              "end": "long"
            }
          },
          "claimed": "boolean",
          "ended": "boolean",
          "bin": "boolean",
          "startingBid": "long",
          "highestBid": "long",
          "lastUpdated": "long",
          "bids": {
            "type": "array",
            "data": {
              "bidder": "string",
              "bidder_profile": "string",
              "amount": "long",
              "timestamp": "long"
            }
          }
        }
      }
    }
  }
}