From 02711d1354467110779bec094789f1b4ba9c07c6 Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 8 Jul 2026 16:54:43 +0000 Subject: [PATCH] docs: add features, TOC, star-history sections and issue templates MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Improve README first-impression and navigation, and lower the barrier for community contributions to help the project attract more stars: - Add a '✨ Why this repo?' feature highlight section (EN + DE) - Add a Table of Contents to both READMEs - Add a Star History chart + call-to-action section (EN + DE) - Add GitHub issue templates (bug report, feature request, config) Co-Authored-By: Claude Opus 4.8 Claude-Session: https://claude.ai/code/session_018UA7GQaUJWFiHrJfc6Qb45 --- .github/ISSUE_TEMPLATE/bug_report.yml | 63 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++ .github/ISSUE_TEMPLATE/feature_request.yml | 34 ++++++++++++ README.de.md | 35 ++++++++++++ README.md | 35 ++++++++++++ 5 files changed, 175 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..334e0e4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,63 @@ +name: 🐛 Bug Report +description: Report a problem with a setup, update, or Bedrock script. +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to file a bug report! Please fill in the sections below so we can reproduce and fix the issue quickly. + - type: input + id: script + attributes: + label: Affected script + description: Which script did you run? + placeholder: e.g. setup_minecraft.sh, setup_minecraft_lxc.sh, setup_bedrock.sh, update.sh + validations: + required: true + - type: textarea + id: what-happened + attributes: + label: What happened? + description: A clear and concise description of the bug, including the full error output. + placeholder: Paste the terminal output / error here. + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: How can we reproduce the problem? + placeholder: | + 1. Run `./setup_minecraft.sh` + 2. See error ... + validations: + required: true + - type: dropdown + id: environment + attributes: + label: Environment + description: Where did you run this? + options: + - Proxmox VM + - Proxmox LXC/CT + - Other (specify below) + validations: + required: true + - type: input + id: versions + attributes: + label: Versions + description: Proxmox VE, guest OS, and Java version. + placeholder: e.g. Proxmox VE 8.2, Debian 12, OpenJDK 21 + validations: + required: false + - type: checkboxes + id: checks + attributes: + label: Before submitting + options: + - label: I re-downloaded the latest script from `main`. + required: true + - label: I searched existing issues and this is not a duplicate. + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..b61b794 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: 📖 Documentation & Troubleshooting + url: https://github.com/TimInTech/minecraft-server-Proxmox#troubleshooting + about: Check the README troubleshooting section before opening an issue. + - name: 💬 Questions & Discussion + url: https://github.com/TimInTech/minecraft-server-Proxmox/issues + about: For general questions, please open a regular issue. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..7b7eb77 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,34 @@ +name: 💡 Feature Request +description: Suggest an improvement or a new capability. +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: textarea + id: problem + attributes: + label: Problem / motivation + description: What are you trying to do, and what is missing or hard today? + placeholder: I'm always frustrated when ... + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Proposed solution + description: Describe what you'd like to happen. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + description: Any workarounds or other approaches you thought about. + validations: + required: false + - type: checkboxes + id: checks + attributes: + label: Before submitting + options: + - label: I searched existing issues and this is not a duplicate. + required: true diff --git a/README.de.md b/README.de.md index 368df11..f7b2b4d 100644 --- a/README.de.md +++ b/README.de.md @@ -15,6 +15,35 @@ --- +## ✨ Warum dieses Repo? + +- 🚀 **Installation mit einem Befehl** — ein einziges Skript richtet in Minuten einen produktionsreifen Minecraft-Server (Java **oder** Bedrock) auf Proxmox ein. +- 🧩 **VM *und* LXC/CT** — unterstützt beide Proxmox-Virtualisierungsmodelle, inkl. fertigem CT-Helfer für Bedrock. +- 🔄 **Selbst-aktualisierend** — `update.sh` zieht den neuesten **stabilen** PaperMC-Build über die neue **Fill-v3-API** mit SHA256- + Größenprüfung. +- 🔒 **Sicher voreingestellt** — verifizierte Downloads, zufällige CT-Passwörter, UFW-Firewall-Anleitung und Integritätsprüfungen (keine HTML-Fehlerseiten als `server.jar`). +- 🧠 **Automatisch dimensionierter JVM-Speicher** — skaliert zum Host (`Xms ≈ RAM/4`, `Xmx ≈ RAM/2`, gedeckelt bei 16 G) — kein manuelles Tuning nötig. +- 🛡️ **CI-geprüft** — jedes Shell-Skript wird bei jedem Push mit ShellCheck geprüft. +- 🇩🇪🇬🇧 **Zweisprachige Doku** — vollständige deutsche und englische Dokumentation, synchron gehalten. + +--- + +## 📑 Inhaltsverzeichnis + +- [Voraussetzungen](#-voraussetzungen) +- [Einführung](#einführung) +- [Schnellstart](#schnellstart) +- [Backups](#-backups) +- [Auto-Update](#-auto-update) +- [Konfiguration](#konfiguration) +- [Integrität & Firewall](#integrität--firewall) +- [Proxmox-CT-Helfer (Bedrock)](#proxmox-ct-helfer-bedrock) +- [PaperMC-API-Migration (v2 → Fill v3)](#papermc-api-migration-v2--fill-v3) +- [Admin/Befehle](#-adminbefehle) +- [Fehlerbehebung](#fehlerbehebung) +- [Referenzen](#referenzen) + +--- + ## Quick Links - Server-Befehle: [SERVER_COMMANDS.md](SERVER_COMMANDS.md) @@ -296,6 +325,12 @@ Details zum sicheren Simulations-Workflow findest du in **[SIMULATION.md](SIMULA - Proxmox-Wiki: - Mojang Bedrock Server: +## ⭐ Star-Verlauf + +Wenn dir dieses Projekt Zeit gespart hat: Ein ⭐ hilft anderen, es zu finden, und motiviert zur weiteren Pflege. + +[![Star History Chart](https://api.star-history.com/svg?repos=TimInTech/minecraft-server-Proxmox&type=Date)](https://star-history.com/#TimInTech/minecraft-server-Proxmox&Date) + ## Lizenz [MIT](LICENSE) diff --git a/README.md b/README.md index 3219735..dee494f 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,35 @@ --- +## ✨ Why this repo? + +- 🚀 **One-command install** — a single script provisions a production-ready Minecraft server (Java **or** Bedrock) on Proxmox in minutes. +- 🧩 **VM *and* LXC/CT** — supports both Proxmox virtualization models, plus a ready-made CT helper for Bedrock. +- 🔄 **Self-updating** — `update.sh` pulls the latest **stable** PaperMC build via the new **Fill v3 API** with SHA256 + size validation. +- 🔒 **Secure by default** — verified downloads, random CT passwords, UFW firewall guidance, and integrity checks (no HTML error pages saved as `server.jar`). +- 🧠 **Auto-sized JVM** — memory is scaled to the host (`Xms ≈ RAM/4`, `Xmx ≈ RAM/2`, capped at 16 G) — no manual tuning required. +- 🛡️ **CI-linted** — every shell script is checked with ShellCheck on each push. +- 🇩🇪🇬🇧 **Bilingual docs** — full English and German documentation, kept in sync. + +--- + +## 📑 Table of Contents + +- [Requirements](#-requirements) +- [Introduction](#introduction) +- [Quickstart](#quickstart) — [VM](#vm-dhcp) · [LXC/CT](#lxcct) · [Bedrock](#bedrock) +- [Backups](#-backups) +- [Auto-Update](#-auto-update) +- [Configuration](#configuration) +- [Integrity & Firewall](#integrity--firewall) +- [Proxmox CT Helper (Bedrock)](#proxmox-ct-helper-bedrock) +- [PaperMC API Migration (v2 → Fill v3)](#papermc-api-migration-v2--fill-v3) +- [Admin/Commands](#-admincommands) +- [Troubleshooting](#troubleshooting) +- [References](#references) + +--- + ## Quick Links - Server Commands: [SERVER_COMMANDS.md](SERVER_COMMANDS.md) @@ -297,6 +326,12 @@ For safe simulation workflow details, see **[SIMULATION.md](SIMULATION.md)**. - Proxmox Wiki: - Mojang Bedrock Server: +## ⭐ Star History + +If this project saved you time, a ⭐ helps others discover it and motivates continued maintenance. + +[![Star History Chart](https://api.star-history.com/svg?repos=TimInTech/minecraft-server-Proxmox&type=Date)](https://star-history.com/#TimInTech/minecraft-server-Proxmox&Date) + ## License [MIT](LICENSE)