commit 787b8abf4dc9d805a3f32e77ecd4a84e8e3fcf12 Author: Andrew P. Harper <115321970+KoopaCode@users.noreply.github.com> Date: Thu Mar 5 21:40:22 2026 -0500 Add project index, templates, and docs diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..18bdc84 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,20 @@ +name: Bug Report +description: Report an issue with projects.json (bad link, wrong info, etc.) +title: "[Bug] " +labels: ["bug"] +body: + - type: textarea + id: what + attributes: + label: What's wrong? + description: Describe the issue - broken URL, wrong project name, duplicate entry, etc. + validations: + required: true + + - type: input + id: affected + attributes: + label: Affected project name or URL + placeholder: "smartcmd / MinecraftConsoles" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/project-request.yml b/.github/ISSUE_TEMPLATE/project-request.yml new file mode 100644 index 0000000..ba66b12 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/project-request.yml @@ -0,0 +1,53 @@ +name: Project Request +description: Request a new project to be added to the Minecraft Legacy index +title: "[Request] " +labels: ["project-request"] +body: + - type: input + id: project-name + attributes: + label: Project Name + description: The display name for the project (e.g. "owner / RepoName") + placeholder: "smartcmd / MinecraftConsoles" + validations: + required: true + + - type: input + id: project-url + attributes: + label: Project URL + description: Full link to the project (GitHub, Archive.org, website, etc.) + placeholder: "https://github.com/owner/repo" + validations: + required: true + + - type: dropdown + id: priority + attributes: + label: Suggested Priority + description: How important is this project to the Legacy community? + options: + - "High (core tools, sources)" + - "Medium (useful projects)" + - "Low (archives, misc)" + validations: + required: true + + - type: textarea + id: description + attributes: + label: Why should this be listed? + description: Brief explanation of what the project is and why it belongs on the index. + placeholder: "This project is a decompiled source mirror of..." + validations: + required: true + + - type: checkboxes + id: confirm + attributes: + label: Confirmation + options: + - label: This project is related to Minecraft Legacy / Console Edition + required: true + - label: This project is not already listed in projects.json + required: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..9a00250 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,19 @@ +## Add Project to Minecraft Legacy Index + +### Project Details + +- **Name:** `owner / ProjectName` +- **URL:** `https://...` +- **Priority:** `(number)` + +### Checklist + +- [ ] `projects.json` is valid JSON (no trailing commas, proper quotes) +- [ ] URL is not already in the list +- [ ] Project is related to Minecraft Legacy / Console Edition +- [ ] Only one project added per PR + +### Description + + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..43bb18b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing to Minecraft Legacy Project Index + +Thanks for helping keep the project list up to date! + +## Adding a project via Pull Request + +1. **Fork** this repository. +2. Open `projects.json` in any text editor. +3. Add your entry to the `repos` array: + +```json +{ + "name": "YourName / YourProject", + "url": "https://github.com/YourName/YourProject", + "priority": 5 +} +``` + +4. **Priority** - use the next number after the last entry. Maintainers may adjust it. +5. Make sure your JSON is valid - no trailing commas, all strings in double quotes. +6. Commit with a message like: `Add YourProject to project list` +7. Open a Pull Request and fill out the template. + +## Requesting a project (no code needed) + +Go to **Issues → New Issue → Project Request** and fill in the form. A maintainer will handle the rest. + +## Guidelines + +- One project per PR. +- Project must be related to Minecraft Legacy / Console Edition. +- No duplicate URLs. +- Keep `projects.json` clean and formatted. + +## JSON validation + +Before submitting, paste your edited `projects.json` into [jsonlint.com](https://jsonlint.com) to check for errors. + +## Questions? + +Open an issue or reach out to the maintainers. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..73e04f9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Minecraft Legacy Community + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..fbbc3cc --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +# Minecraft Legacy - Project Index + +This repository hosts the **projects.json** file that powers the [Minecraft Legacy](https://minecraftlegacy.com) website. The site reads this JSON directly from GitHub to display the community project list. + +## Structure + +``` +projects.json ← The single source of truth for all listed projects +``` + +### `projects.json` format + +```json +{ + "repos": [ + { + "name": "owner / ProjectName", + "url": "https://github.com/owner/ProjectName", + "priority": 1 + } + ] +} +``` + +| Field | Type | Description | +| ---------- | -------- | ------------------------------------------------------------------ | +| `name` | `string` | Display name shown on the site (usually `owner / repo`) | +| `url` | `string` | Full URL to the project (GitHub, Archive.org, etc.) | +| `priority` | `number` | Sort order - lower number = higher on the list. `1` is top priority | + +## How to add a new project + +### Option 1 - Open a Pull Request (recommended) + +1. **Fork** this repo. +2. Edit `projects.json` - add your project entry to the `repos` array. +3. Pick a `priority` number. Use the next available number unless the maintainers say otherwise. +4. **Commit** with a clear message like `Add MyProject to project list`. +5. Open a **Pull Request** using the provided template. + +### Option 2 - Request via Issue + +If you don't want to edit JSON yourself, just open an **Issue** using the "Project Request" template and fill in the details. A maintainer will add it for you. + +## Rules + +- **Valid JSON only** - run your edit through a JSON validator before submitting. +- **No duplicate URLs** - check that your project isn't already listed. +- **Relevant projects only** - must be related to Minecraft Legacy / Console Edition. +- **One project per PR** - keeps reviews simple. + +## How it works + +The [Minecraft Legacy website](https://minecraftlegacy.com) fetches this file directly from: + +``` +https://raw.githubusercontent.com/MinecraftConsole/json/refs/heads/main/projects.json +``` + +Changes merged to `main` go live on the site immediately - no deploy needed. + +## License + +This project list is maintained by the Minecraft Legacy community. See [LICENSE](LICENSE) for details. diff --git a/projects.json b/projects.json new file mode 100644 index 0000000..2e40d37 --- /dev/null +++ b/projects.json @@ -0,0 +1,24 @@ +{ + "repos": [ + { + "name": "smartcmd / MinecraftConsoles", + "url": "https://github.com/smartcmd/MinecraftConsoles", + "priority": 1 + }, + { + "name": "Archive Source Code Dump", + "url": "https://archive.org/download/minecraft-legacy-console-edition-source-code", + "priority": 2 + }, + { + "name": "gradenGnostic / Legacy Launcher", + "url": "https://github.com/gradenGnostic/LegacyLauncher", + "priority": 3 + }, + { + "name": "4jcraft / 4jcraft", + "url": "https://github.com/4jcraft/4jcraft", + "priority": 4 + } + ] +} \ No newline at end of file