Skip to content

docs: add comprehensive README explaining repository structure and data schemas#8

Merged
plun1331 merged 2 commits intomainfrom
copilot/explain-task-details
Apr 22, 2026
Merged

docs: add comprehensive README explaining repository structure and data schemas#8
plun1331 merged 2 commits intomainfrom
copilot/explain-task-details

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 22, 2026

The README contained only a single line with no explanation of what the data files contain or how they're structured.

Changes

  • Repository overview — folder tree annotated with purpose of each directory and script
  • Per-file schema docs — purpose and JSON shape documented for all 24 data files across skyblock/, skyblock/networth/, and misc/; notable fields (e.g. optional stacking/ultimate/upgrade_stones on enchants, null sentinel in gemstone stat arrays) are called out inline
  • Validation & contributing — documents how to run check.py and sets expectations for contributors

Example of the level of detail added for enchants.json:

{
  "<enchant_name_lowercase>": {
    "name": "<Display Name>",
    "id": "<internal_api_id>",
    "max_table": <max level from enchanting table>,
    "max": <absolute maximum level>,
    "stacking": true,        // present only for stacking enchants
    "ultimate": true,        // present only for ultimate enchants
    "upgrade_stones": {
      "<level>": "<ITEM_ID>" // present only where an upgrade stone is required
    }
  }
}
Original prompt

Explain this

Created from VS Code.

Copilot AI changed the title [WIP] Explain task details and requirements docs: add comprehensive README explaining repository structure and data schemas Apr 22, 2026
Copilot AI requested a review from plun1331 April 22, 2026 02:22
@plun1331 plun1331 marked this pull request as ready for review April 22, 2026 23:23
@plun1331 plun1331 merged commit 672b22f into main Apr 22, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants