diff --git a/README.md b/README.md index b2ea47e..04e6b39 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,69 @@ -# Emerald Legacy Workshop - -Welcome to the **Emerald Legacy Workshop**! This repository serves as the central registry for community-driven content used by the Emerald Legacy Launcher. +
+ Emerald Legacy Launcher Logo +

Emerald Legacy Workshop

+

Central registry for community-driven content used by the Emerald Legacy Launcher.

+ +

+ Version + License + Platforms +

+
## About -The Workshop is a free, open-source alternative to the Minecraft Marketplace. It allows the community to share: -- **Skins Packs**: High-quality character skins. -- **Texture Packs**: Resource updates for Title Updates. +The Workshop is a free, open-source alternative to the Minecraft Marketplace for LCE. It allows the community to share: +- **Skins Packs** +- **Texture Packs** - **DLCs**: Expansion packs, maps, etc. +- **Mods**: Using mod loaders, of course. +- **Worlds** ## How to Contribute We welcome contributors! To add your content to the workshop: 1. **Fork this repository.** -2. **Upload your content**: Create a subfolder and place your assets (zips, thumbnails) in the `assets/` folder or host them via GitHub Releases in your own repo. -3. **Update `workshop.json`**: Add your item to the list following the schema below. +2. **Upload your content**: Create a subfolder with your mod ID and place your assets (zips, thumbnails). +3. **Update `meta.json` in your subfolder**: Add your item to the list following the schema below. 4. **Submit a Pull Request**: Our team will review your submission for quality and safety. ## Schema Details -Every item in `workshop.json` must follow this structure: +Your `meta.json` must follow this structure: | Field | Type | Description | |---|---|---| | `id` | String | A unique identifier (kebab-case). | | `name` | String | Display name of the item. | -| `author` | String | Your name or organization. | +| `author` | String | Your Github username. | | `description`| String | A short summary of what the item does. | -| `category` | String | Must be `Skins`, `Packs`, or `DLC`. | -| `thumbnail` | URL | A 1:1 image (PNG/JPG) for the preview. | -| `downloadUrl`| URL | Direct link to a `.zip` file of the content, it can be directly inside your folder on /assets/ or a repo's release. | +| `category` | String or String[] | Must be `Skin`, `Texture`, `World`, `Mod`, `DLC`, or multiple ones in a list. | +| `thumbnail` | String | File name for your 1:1 image (PNG/JPG/SVG/GIF) for the preview. | +| `zips`| Object | Names of your `.zip` files to extract. | | `version` | String | Semantic versioning (e.g. `1.0.0`). | +## Example `meta.json` (jsonc, remove comments) +```jsonc +{ + "id": "my-amazing-mod", // ID + "name": "My Awesome Mod", // Name + "author": "neoapps-dev", // Github username + "description": "Adds back Ruby items", // Description + "category": ["Mod", "DLC"], // Category + "thumbnail": "thumbnail.png", // Thumbnail filename + "zips": { // Object ("file-name.zip": "path/in/the/game/directory/to/extract/it/in) + "ruby.zip": "", // empty means the root of the game directory + "texture.zip": "{MediaDir}/DLC" // placeholders are handled by Emerald + }, + "version": "1.0.0" +} +``` + +## Supported Placeholders +- `{MediaDir}`: Path to the Windows64Media, or Common/Media for 4JCraft +- `{GameHDD}`: Saves directory +- `{DLCDir}`: Path to `{MediaDir}/DLC` +- `{MobDir}`: Path to Common/res/mob (contains default skins) + ## License By contributing to this repository, you agree to license your manifest entries under the **MIT License**. The content itself (skins/packs) must be compatible with FOSS distribution.