Update README.md

This commit is contained in:
Rainer 2025-06-21 23:04:27 +02:00
parent 854b985f30
commit a08a86dc40

View file

@ -43,12 +43,12 @@ OR
Clone the Git repository to a base directory.
-```bash
```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
-```
```
### 2. Global Configuration
@ -70,7 +70,7 @@ To add a world, copy the template `site_generator/examples/web.conf.template` in
## 📂 Directory Structure
The system now uses a modular structure to improve maintainability:
-```md
```md
/opt/luweb/
├── config.sh
├── generate_map.sh
@ -100,40 +100,40 @@ The system now uses a modular structure to improve maintainability:
└── <world_name>/
├── map.png
└── map_info.txt
-```
```
## 🚀 Usage
### 1. Map and Data Generation
The `generate_map.sh` script creates the map, tiles, and metadata for a specific world.
-```bash
```bash
# Generate assets for the world in the 'world' directory
./generate_map.sh world
-```
```
### 2. Website Generation
The `generate_site.sh` script builds the entire website for all worlds that have a `web.conf`.
-```bash
```bash
# Generate the complete website
./generate_site.sh
-```
```
### 3. Live Status Check
The `check_server_status.sh` script checks the online status of all configured worlds. It should be run very frequently.
-```bash
```bash
# Check the server status
./check_server_status.sh
-```
```
### 4. Automation (Cronjob)
Setting up cronjobs is recommended for fully automatic operation.
**Example for `crontab -e`:**
-```bash
```bash
# Generate map assets for 'world' once per hour
0 * * * * /opt/luweb/generate_map.sh world >> /var/log/luweb/cron.log 2>&1
@ -142,7 +142,7 @@ Setting up cronjobs is recommended for fully automatic operation.
# 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
-```
```
## 📄 License
**MIT License**