https://github.com/paradigmmc/mc-schemas
Repository for documenting all sorts of Minecraft configuration files
https://github.com/paradigmmc/mc-schemas
Last synced: 4 months ago
JSON representation
Repository for documenting all sorts of Minecraft configuration files
- Host: GitHub
- URL: https://github.com/paradigmmc/mc-schemas
- Owner: ParadigmMC
- License: gpl-3.0
- Created: 2023-06-12T15:07:27.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-27T10:19:23.000Z (almost 3 years ago)
- Last Synced: 2025-01-18T16:24:24.053Z (over 1 year ago)
- Size: 18.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mc-schemas
This repository contains schemas for all sorts of Minecraft related formats and configuration files.
> [!NOTE]
> Calling all developers! PR your mod/plugin/etc's config schemas here!
## Folder Structure
Basically: `{type}/[{owner}/{name}]/{side}/**/*.json`
Side is either `client`, `server` or `both`
### Types
- `minecraft`: The base game
- `minecraft/config/{SIDE}/*`
- `modloader`: Mod loaders
- `modloader/{fabric,quilt,forge}/{SIDE}/*`
- `servers`: bukkit, paper, etc
- `servers/{platform}/*`
- `proxies`
- `proxies/{velocity,bungeecord,...}/*`
- `mods`: Config files for mods
- `mods/{modloader}/{author}/{name}/{version}/{SIDE}/*`
- `plugins`: Config files for plugins
- `plugins/{platform}/{author}/{name}/{version}/*`
- `dev`: Formats for developing things
- `dev/modpacks/`: Modpack formats (mrpack/packwiz/cf etc)
- `dev/mods/{loader}/`: quilt.mod.json etc
- `dev/plugins/{platform}/`: plugin.yml etc
- `dev/resource_packs/` Resource pack formats
- `dev/datapacks/`
### Schema Format
- Schemas must use the `https://json-schema.org/draft/2020-12/schema` draft
- File names should be the real file name + `.json`, for example `options.txt`'s schema file would be `options.txt.json`
## Why?
- More accessible information/better documentation
- Editors can have nice features such as autocomplete, validation, hover info, etc.
Any ideas? Feel free to open an issue or a PR!