Skyblock Resource API improvments & additions

[HacktheTime]

Firstival some president:

Now that the official wiki no longer exists, data parsing is even harder. Especially for things like the loot tables and mob API ids (sb profiles endpoint). But fully up to date data from the community side was hard already previously. Due to this a fully automatic API would be great. NEU Repo is the best solution right now and it is not that rare to be incomplete or not updated. It's just so much to manage.

The API changes may seem like a major performance tanker but maybe it could be made so they are generated only once after a version update? That would make it not too big of an issue.

I would also like to ask for the alpha network to receive its own API (Resources only). While it probably should be disabled while it is closed or only the last time it was opened data it would be good to get all the resource data so our code (and texture packs) can be updated as well during that time. (I am currently working on a kotlin parser with things such as automatic generation for references to items etc.)

1) Better Skyblock Items API.

There exists an endpoint right now but it has a MAJOR issue. It's missing the item description / Tooltip. It has some other very cool and useful data but tooltip and description is just so important.

I would suggest keeping the https://API.hypixel.net/resources/skyblock/items like it is but add description to it. I would also suggest adding an item stack {gzipped item nbt} of it that is created based on a completely fresh player with level 0 stats etc.

Add all items including things such as Pets and Attribute Shard. For later including their requirements.
Also add recipes to them.

2) Mobs & Bestiary.

The only reliable source we have on mob data is the bestiary, but even that does not contain all mobs and is missing the API id.

Mobs:
[
{

• Name (as it appears in game, Formatted String like §cRat)
• Description (Bestiary)
• Health
• Damage? (Appears in Bestiary so why not.)
• Magic Damage Resistance (Appears in Bestiary so why not.)
• Mob Types []
• API-id
• Loot table or Loot table endpoint id reference.
• Killing XP orbs.
• Killing Coins.
• Kill awarding XP amounts (fishing,...)
• Possible Spawn locations (Island → Positions)? (If possible)
• Vanilla Mob type. (Player or Sheep for example.)
• If Player Textures of the players. If Resource Packs Models for Mobs happen I would replace the texture with the model in the texture pack. Based on whether mobs may have multiple textures at some point ("random") it should be a list or single line.
  }
  ]

Bestiary should be based on the island it is on. I would suggest essentially using the format NEU uses. Given that the API id is now usable it should be OK. Neu Repo BE Link

3) Loot tables

A lot of Loot tables are not available right now. Given that the Loot tables could often be unknown but sound like they might be easy to auto publish (excluding secondary data such as requirements with the exception of maybe ids for requirements where they get reused?)

Mobs could contain the Data directly or a reference to this one.

If things like the Corpses in Mineshafts would use a System like this they could be exposed automatically without second thoughts. The question is the Ids used. Maybe use the mob id for mobs. But what about other things. Do Blocks list it?

The Wiki previously said stuff like 2-4 ink sacks 50% of the time. This was a major issue when you wanted to calculate things accurately.

I suggest special ids for some things:
mobs: API_id like cow_1
block: block_id
Minion: COW_GENERATOR...

{
    "data": {
        "loottableid": [
            {
                "id": "skyblockid",
                "chance": (double?),
                "amount": 1 (could be redundant if 1)
            }
        ]
    }
}

4) NPCs

Npcs are rather annoying at times.

• name (formatted)
• id (hypixel id for stuff like quests?)
• Guis (id reference to guis section)
• location (position and island)
• abiphone data. (nullable, if it's a requirement like the ones with items maybe reuse those? for items a item requirement and of the id and amount would be cool.)
• Chat Lines. (idk how possible it is to expose this data but it would be good to have. Since modern dialogues contain chat prompts 24/7 nowadays at least those should be linkable to each other somehow. So dialogue caused by an option should be made so it's flat makable.)

5) Guides

Right now there are the Guides like the Enchanting Guide (/eg), Sea Creature Guide (/scg) and so on.

Exposing their Data as an API Endpoint would make sense.

This should for example have data like the weights and fishing pools of mobs, the allowed types (water/lava etc)

6) GUIs

To be realistic. The Game has a LOT of GUIs. Some of which are dynamic. Having an API for GUIs with all possible options a slot can have would be sick though. Especially static shops like Farm Merchant should have a gui here. Item claims should be possible too.

Too reduce the Data size I suggest the following:

• Add Presets for the Shops. For example say gui type shop and then define shop as preset once. Afterwards only define overwrite in the inventory.
• Add Grouping. If things are the same across multiple slots in a row group them via slot ids. "0-9" for example
• Shortcut the black stained glass panes to just PANE and Air to AIR instead of gzipped nbt data.

Data Formatting:

• id
• inventory name
• slots

{
    "0-9": PANE,
    "10": [
        Gripped Item Data 1 (Wither Essence Perk 1 tier 1),
        Gripped Item Data 2 (Wither Essence Perk 1 tier 2),
        ...
    ]
    "12": AIR,
    ...
}

• access command (nullable. for example /be. since this is not direct this might not be as easy to implement but be nice to have.)

7) Blocks

This is a weird one. I only thought of this for Stuff like End Nodes (loot tables) but the longer I think of it the more it makes sense. This Data should be easily expos-able. Aside from that appears on island tags.

• name
• vanilla type
• block strength / sweep strength,...
• mining speed (we would need a formula that we can use to calc instant break, normal breaks etc.)
• block type. (Ore, Dwarven Mineral, Block, Non - Ore,... Log/Tree?)
• loot table (id)
• appears on island [] (Idk how possible this is but it could be very interesting)

8 Shards

There are a lot of different shards in the game.

While the general data such as the amounts needed for each level and the requirements for them could be added since they are that uniform it's not that needed.

data []

• itemid of the shard. (reference to /items.)
• attribute name
• attribute API id (for personal API)
• attribute family
• attribute category
• fusion data (including special fusions)
• • This should include either all matching id combos or self applyable filter such as requirements via raity, type etc. Or where 1 specfic is needed that specific via id.

9) Levelling

Levelling Data is available for the player endpoint already. a Public Resource Endpoint for it is missing however.

I don’t use this API myself as of now and I don’t see a major need aside from the tasks as in the level guide to have a description and the API ids listed so we actually now what ids things have in the personal API.

• looking for more suggestions!

Offtopic

#701 Also contains some Bingo API suggestions but since this Stuff is not mainstream it was split off.

[lunaynx]

A lot of this sounds reasonable, but some of it, like NPC dialogue, as useful as it may be for wiki editors, sounds overkill and likely won't happen. It would completely spoil the whole charm of each update immediately on release day, and they'd have to be very careful to hide any potential "secret" dialogue they may want players to discover on their own first.

[HacktheTime]

Isn't this already a goner due to alpha?

Also dialogue can be useful since it means you can just get those with typing for modding. I actually would have a use for that.