luanti-web/README.md

# Luanti-Web: A dynamic website-toolkit

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.

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

* **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 & Area Display:** Dynamically loads player positions and protected areas, displaying them as interactive overlays on the live map.
* **Layer Control:** A menu on the map allows toggling the visibility of players, parent areas, and sub-areas (parcels).
* **Map Archive:** Automatically saves a daily snapshot of the map and makes it available through a toggle 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.sh` and a `web.conf` file for every one of your worlds.
* **Automation-Ready:** Designed for unattended execution via scheduling tools like `cron`.

## 🔧 Prerequisites

To run this system, the following software packages must be installed on your server:

* **bash:** The scripting language used for the entire project.
* **vips:** A high-performance image processing library.
    * *Debian/Ubuntu Install:* `sudo apt-get install libvips-tools`
* **ImageMagick:** Currently still required for the `identify` command (to read image dimensions).
    * *Debian/Ubuntu Install:* `sudo apt-get install imagemagick`
* **GDAL/OGR:** Provides the `gdal2tiles.py` script for tile generation.
    * *Debian/Ubuntu Install:* `sudo apt-get install gdal-bin python3-gdal`
* **SQLite3:** The command-line tool to query the game databases (`players.sqlite`, `auth.sqlite`).
    * *Debian/Ubuntu Install:* `sudo apt-get install sqlite3`
* **bc:** The "basic calculator" command-line tool, required for calculations in scripts.
    * *Debian/Ubuntu Install:* `sudo apt-get install bc`
* **jq:** A command-line JSON processor, used by `sync_areas.sh`.
    * *Debian/Ubuntu Install:* `sudo apt-get install jq`
* **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.

An included script (`check_dependencies.sh`) can automatically verify all important dependencies.

## ⚙️ Installation & Setup

### 1. Project Files

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/`.

OR

Clone the Git repository to a base directory.

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

### 2. Global Configuration

The main configuration file is `config.sh`. You must edit this file to match your server's environment.

### 3. Per-World Configuration

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. To add a world, copy the template `site_generator/examples/web.conf.template` into the data directory of the respective world and adjust the values.

## 📂 Directory Structure

-```md
/opt/luweb/
├── config.sh
├── generate_map.sh
├── generate_site.sh
├── check_server_status.sh
├── check_dependencies.sh
├── sync_players.sh
├── sync_areas.sh
├── minetestmapper (executable)
├── site_generator/
│   ├── functions/
│   │   └── generators/
│   │       └── ...
│   ├── templates/
│   └── examples/
├── web_content/
└── worldmaps_output/
    └── <world_name>/
        ├── map.png
        └── map_info.txt
-```

## 🚀 Usage & Automation (Cronjob)

The scripts are designed for automated execution. Set them up using `crontab -e`.

-```bash
# (Frequently) Update player and server status
* * * * * cd /opt/luweb && ./sync_players.sh >> /var/log/luweb/cron.log 2>&1
*/5 * * * * cd /opt/luweb && ./check_server_status.sh >> /var/log/luweb/cron.log 2>&1

# (Hourly) Generate the base map and tiles
0 * * * * cd /opt/luweb && ./generate_map.sh >> /var/log/luweb/cron.log 2>&1

# (Infrequently) Sync area data and rebuild the static site
45 */12 * * * cd /opt/luweb && ./sync_areas.sh >> /var/log/luweb/cron.log 2>&1
30 */12 * * * cd /opt/luweb && ./generate_site.sh >> /var/log/luweb/cron.log 2>&1
-```

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

(License text as before)

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