README to english

2025-06-21 23:03:03 +02:00 · 2025-06-21 23:03:03 +02:00 · 854b985f30
commit 854b985f30
parent 8d691f994e
1 changed files with 70 additions and 70 deletions
--- a/README.md
+++ b/README.md
@ -1,83 +1,83 @@
-# Luanti-Web: Ein dynamisches Webseiten-Toolkit
+# Luanti-Web: A dynamic website-toolkit

-Willkommen beim Luanti Web Generator! Entstanden aus einer Leidenschaft für kreative Sandbox-Spiele, bietet dieses Hobby-Projekt ein leistungsstarkes, automatisiertes Toolkit zur Erstellung einer schönen und funktionsreichen statischen Webseite für Ihren Minetest- oder Luanti-Server. Präsentieren Sie Ihren Server, Ihre Welten, verfolgen Sie Ihre Spieler und informieren Sie Ihre Community.
+Welcome to the Luanti Web Generator! Born from a passion for creative sandbox gaming, this hobby project provides a powerful, automated toolkit for generating a beautiful and feature-rich static website for your Minetest or Luanti server. Showcase your server, worlds, track your players, and inform your community.

-Dieses System ist von Grund auf so konzipiert, dass es modular, leicht konfigurierbar und perfekt für kleine Gemeinschaften ist, die ohne großen Aufwand eine Webpräsenz wünschen.
+This system is designed from the ground up to be modular, easily configurable, and perfect for small communities who want web presence without the hassle.

 ## ✨ Features

-* **Automatisierte Kartenerstellung:** Nutzt `minetestmapper`, um hochauflösende PNG-Karten Ihrer Spielwelten zu erstellen.
-* **Performante Bildverarbeitung:** Verwendet `vips`, eine extrem schnelle und speichereffiziente Bibliothek, um auch riesige Karten (getestet bis 64k x 64k Pixel) für das Web zu skalieren.
-* **Gekachelte Kartenerstellung:** Nutzt `gdal2tiles.py`, um performante, zoombare Kartenkacheln für ein flüssiges Benutzererlebnis zu erstellen.
-* **Dynamischer Karten-Viewer:** Implementiert einen interaktiven Karten-Viewer mit **OpenLayers**, angetrieben von den generierten Kartenkacheln, inklusive digitalem Zoom über die höchste Auflösung hinaus.
-* **Live-Spieler-Tracking:** Lädt dynamisch Spielerpositionen und zeigt sie als Marker auf der Live-Karte an, inklusive individuell gestalteter Popups.
-* **Karten-Archiv:** Speichert automatisch einen täglichen Snapshot der Karte und macht ihn über eine Dropdown-Auswahl auf der Welt-Detailseite verfügbar.
-* **Vorlagen-gesteuerte Seitengenerierung:** Baut alle statischen HTML-Seiten aus einfachen, anpassbaren Vorlagen.
-* **Flexible Konfiguration:** Einfache Konfiguration durch eine zentrale, globale `config.sh` und eine `web.conf`-Datei für jede Ihrer Welten.
-* **Automatisierungs-bereit:** Konzipiert für die unbeaufsichtigte Ausführung über Planungswerkzeuge wie `cron`.
+* **Automated Map Generation:** Leverages `minetestmapper` to create high-resolution PNG maps of your game worlds.
+* **Performant Image Processing:** Uses `vips`, a high-performance and memory-efficient library, to scale even huge maps (tested up to 64k x 64k pixels) for the web.
+* **Tiled Map Generation:** Uses `gdal2tiles.py` to create performant, zoomable map tiles for a smooth user experience.
+* **Dynamic Map Viewer:** Implements an interactive map viewer using **OpenLayers**, powered by the generated map tiles, including digital zoom beyond the highest resolution.
+* **Live Player Tracking:** Dynamically fetches and displays player locations as markers on the live map, including custom-styled popups.
+* **Map Archive:** Automatically saves a daily snapshot of the map and makes it available through a dropdown viewer on the world detail page.
+* **Template-Driven Site Generation:** Builds all static HTML pages from simple, customizable templates.
+* **Flexible Configuration:** Configuration is easy with a central global config and a `web.conf` file for every one of your worlds.
+* **Automation-Ready:** Designed for unattended execution via scheduling tools like `cron`.

-## 🔧 Voraussetzungen
+## 🔧 Prerequisites

-Um dieses System zu betreiben, müssen die folgenden Softwarepakete auf Ihrem Server installiert sein:
+To run this system, the following software packages must be installed on your server:

-* **bash:** Die Skriptsprache, die für das gesamte Projekt verwendet wird.
-* **vips:** Eine hochperformante Bildverarbeitungsbibliothek, die `convert` (ImageMagick) ersetzt.
+* **bash:** The scripting language used for the entire project.
+* **vips:** A high-performance image processing library that replaces `convert` (ImageMagick).
    * *Debian/Ubuntu Install:* `sudo apt-get install libvips-tools`
-* **ImageMagick:** Wird aktuell noch für den Befehl `identify` (zum Auslesen von Bilddimensionen) benötigt.
+* **ImageMagick:** Currently still required for the `identify` command (to read image dimensions).
    * *Debian/Ubuntu Install:* `sudo apt-get install imagemagick`
-* **GDAL/OGR:** Stellt das `gdal2tiles.py`-Skript für die Kachelerstellung bereit.
+* **GDAL/OGR:** Provides the `gdal2tiles.py` script for tile generation.
    * *Debian/Ubuntu Install:* `sudo apt-get install gdal-bin python3-gdal`
-* **minetestmapper:** Das ausführbare Programm zur Erstellung der Karten aus den Weltdaten. Muss im Projektverzeichnis platziert werden.
-* **iproute2:** Stellt das `ss`-Kommando für den `check_server_status.sh` bereit (auf den meisten Systemen vorinstalliert).
-* **Webserver:** Ein Webserver wie Nginx oder Apache wird benötigt, um die generierten statischen Dateien auszuliefern.
+* **minetestmapper:** The executable used to render maps from world data. Must be placed within the project directory.
+* **iproute2:** Provides the `ss` command for `check_server_status.sh` (usually pre-installed on most systems).
+* **Web Server:** A web server like Nginx or Apache is needed to serve the generated static files.

-Ein mitgeliefertes Skript (`check_dependencies.sh`) kann alle wichtigen Abhängigkeiten automatisch überprüfen.
+An included script (`check_dependencies.sh`) can automatically verify all important dependencies.

 ## ⚙️ Installation & Setup

-### 1. Projektdateien herunterladen/klonen
+### 1. Download/Clone Project Files

-Laden Sie den **letzten Build** von der [Releases-Seite](https://git.geigernet.eu/rainer/luanti-web/releases) herunter und entpacken Sie ihn in ein Basisverzeichnis auf Ihrem Server, z.B. `/opt/luweb/`.
+Download the **latest build** from the [Releases-Page](https://git.geigernet.eu/rainer/luanti-web/releases) and extract it to a base directory on your server, such as `/opt/luweb/`.

-ODER
+OR

-Klonen Sie das Git-Repository in ein Basisverzeichnis.
+Clone the Git repository to a base directory.

-```bash
-git clone https://git.geigernet.eu/rainer/luanti-web.git /opt/luweb
+-```bash
+git clone [https://git.geigernet.eu/rainer/luanti-web.git](https://git.geigernet.eu/rainer/luanti-web.git) /opt/luweb
 cd /opt/luweb
-# Alle Skripte ausführbar machen
+# Make all scripts executable
 chmod +x generate_map.sh generate_site.sh check_server_status.sh check_dependencies.sh
-```
+-```

-### 2. Globale Konfiguration
+### 2. Global Configuration

-Die Hauptkonfigurationsdatei ist `config.sh`. Sie müssen diese Datei bearbeiten, um sie an die Umgebung Ihres Servers anzupassen.
+The main configuration file is `config.sh`. You must edit this file to match your server's environment.

-**Wichtige Variablen in `config.sh`:**
+**Key variables in `config.sh`:**

-* `BASE_SCRIPT_DIR`: Das Wurzelverzeichnis des Projekts (z.B. `/opt/luweb`).
-* `MINETESTMAPPER_WORLD_DATA_BASE_PATH`: Der Pfad zum Datenverzeichnis Ihrer Minetest/Luanti-Welten.
-* `WEB_ROOT_PATH`: Das Document-Root Ihrer Webseite, in das die generierten Dateien platziert werden (z.B. `/var/www/IhreDomain.de/web`).
-* `LOG_DIR_BASE`: Das Verzeichnis, in das Logdateien geschrieben werden (z.B. `/var/log/luweb`).
+* `BASE_SCRIPT_DIR`: The root directory of the project (e.g., `/opt/luweb`).
+* `MINETESTMAPPER_WORLD_DATA_BASE_PATH`: The path to your Minetest/Luanti worlds' data directory.
+* `WEB_ROOT_PATH`: The document root of your website where the generated files will be placed (e.g., `/var/www/your-domain.com/web`).
+* `LOG_DIR_BASE`: The directory where log files will be written (e.g., `/var/log/luweb`).

-### 3. Konfiguration pro Welt
+### 3. Per-World Configuration

-Das System ist so konzipiert, dass **nur Welten mit einer `web.conf`-Datei** im Web-Frontend angezeigt werden. Dies gibt Ihnen die volle Kontrolle darüber, welche Welten öffentlich sichtbar sind.
+The system is designed so that **only worlds with a `web.conf` file** will be displayed in the web frontend. This gives you full control over which worlds are publicly visible.

-Um eine Welt hinzuzufügen, kopieren Sie die Vorlage `site_generator/examples/web.conf.template` in das Datenverzeichnis der entsprechenden Welt (z.B. `<server-pfad>/worlds/meine_welt/web.conf`) und passen Sie die Werte an.
+To add a world, copy the template `site_generator/examples/web.conf.template` into the data directory of the respective world (e.g., `<server-path>/worlds/my_world/web.conf`) and adjust the values.

-## 📂 Verzeichnisstruktur
+## 📂 Directory Structure

-Das System verwendet nun eine modulare Struktur, um die Wartbarkeit zu erhöhen:
-```md
+The system now uses a modular structure to improve maintainability:
+-```md
 /opt/luweb/
 ├── config.sh
 ├── generate_map.sh
 ├── generate_site.sh
 ├── check_server_status.sh
 ├── check_dependencies.sh
-├── minetestmapper (ausführbare Datei)
+├── minetestmapper (executable)
 ├── site_generator/
 │   ├── functions/
 │   │   ├── 01_utils.sh
@ -100,51 +100,51 @@ Das System verwendet nun eine modulare Struktur, um die Wartbarkeit zu erhöhen:
    └── <world_name>/
        ├── map.png
        └── map_info.txt
-```
+-```

 ## 🚀 Usage

-### 1. Karten- und Daten-Generierung
+### 1. Map and Data Generation

-Das `generate_map.sh`-Skript erzeugt die Karte, Kacheln und Metadaten für eine spezifische Welt.
-```bash
-# Erzeugt die Assets für die Welt im Verzeichnis 'world'
+The `generate_map.sh` script creates the map, tiles, and metadata for a specific world.
+-```bash
+# Generate assets for the world in the 'world' directory
 ./generate_map.sh world
-```
+-```

-### 2. Webseiten-Generierung
+### 2. Website Generation

-Das `generate_site.sh`-Skript baut die gesamte Webseite für alle Welten, die eine `web.conf` besitzen.
-```bash
-# Generiert die komplette Webseite
+The `generate_site.sh` script builds the entire website for all worlds that have a `web.conf`.
+-```bash
+# Generate the complete website
 ./generate_site.sh
-```
+-```

-### 3. Live-Status-Prüfung
+### 3. Live Status Check

-Das `check_server_status.sh`-Skript prüft den Online-Status aller konfigurierten Welten. Es sollte sehr häufig ausgeführt werden.
-```bash
-# Prüft den Server-Status
+The `check_server_status.sh` script checks the online status of all configured worlds. It should be run very frequently.
+-```bash
+# Check the server status
 ./check_server_status.sh
-```
+-```

-### 4. Automatisierung (Cronjob)
+### 4. Automation (Cronjob)

-Für den vollautomatischen Betrieb wird die Einrichtung von Cronjobs empfohlen.
+Setting up cronjobs is recommended for fully automatic operation.

-**Beispiel für `crontab -e`:**
-```bash
-# Generiere die Karten-Assets für 'world' einmal pro Stunde
+**Example for `crontab -e`:**
+-```bash
+# Generate map assets for 'world' once per hour
 0 * * * * /opt/luweb/generate_map.sh world >> /var/log/luweb/cron.log 2>&1

-# Prüfe den Server-Status alle 2 Minuten
+# Check the server status every 2 minutes
 */2 * * * * /opt/luweb/check_server_status.sh >> /var/log/luweb/cron.log 2>&1

-# Baue die Webseite (z.B. für neue Admins, geänderte Beschreibungen) zweimal täglich neu
+# Re-build the website (e.g., for new admins, changed descriptions) twice a day
 0 */12 * * * /opt/luweb/generate_site.sh >> /var/log/luweb/cron.log 2>&1
-```
+-```

-## 📄 Lizenz
+## 📄 License
 **MIT License**
 Copyright (c) 2025 Rage87 - rage87@geigernet.eu

@ -166,5 +166,5 @@ 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.

-## 👤 Autoren
+## 👤 Authors
 * **Rage87** (Main-Developer)