Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Overviewer Removed #5

Merged
merged 1 commit into from
Sep 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 4 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Aims:
- minimal setup effort
- unrestricted potential (setup now, tweak later)
- incremental backups
- map generated & http hosted (using [overviewer](https://overviewer.org))

## Getting Started

Expand Down Expand Up @@ -116,28 +115,13 @@ Added FraggyMuffin to the whitelist

Press `[Ctrl]+[D]` to exit the RCON-CLI. This is likely the only time you'll need to access RCON in this way. All future commands can be done inside minecraft itself.

## Online Map (Overviewer)
## Dynmap

An online map can be generated of your world, viewable online.
The [dynmap](https://github.com/webbukkit/dynmap) plugin provides a live view of the world, and players in it.

```
$ ./mc map
Creating volume "minecraft-ds-java_overviewer" with default driver
Creating minecraft-ds-java_overviewer-gen_run ... done
2023-06-09 07:37:19 Welcome to Minecraft Overviewer version 0.19.10 (13c1bdd)!
2023-06-09 07:37:19 Generating textures...
2023-06-09 07:37:27 Preprocessing...
2023-06-09 07:37:34 Rendering 1909 total tiles.
99% [=====================================] 1895 23.22t/s eta 00h 00m 00s
2023-06-09 07:38:56 Rendering complete!
2023-06-09 07:38:57 Your render has been written to '/tmp/export', open index.html to view it.
```

You can then view it on port `8088`: http://localhost:8088

<img src="doc/img/map-01-overworld.png" width=45% />
You can then view it on port `8123`: http://localhost:8123

Note: Switch on/off renders such as `RENDER_CAVES`, and `RENDER_NIGHT` in the [`docker-compose.yml`](./docker-compose.yml) file. Or create your own custom configuraiton by editing [`overviewer-config.py`](./overviewer-config.py) directly.
<img src="doc/img/dynmap-01-world-flat.png" width=45% />

## Backup

Expand Down Expand Up @@ -200,7 +184,6 @@ If this dosn't suit your purposes, please ignore the `./mc backup` feature of th
Aim:

- Backup daily (clear out after 30 days)
- Generate map (CPU intensive, do during expected downtime)

When running `./mc init` in the previous section, a `tasks.cron` file will have been crated.

Expand Down Expand Up @@ -239,6 +222,5 @@ Tooling:
$ ./mc rcon RCON interface to server (must be running)

Cron tasks
$ ./mc map Genreate overviewer map files
$ ./mc backup Create incremental backup of server
```
Binary file added doc/img/dynmap-01-world-flat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/img/map-01-overworld.png
Binary file not shown.
32 changes: 1 addition & 31 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,37 +13,7 @@ services:
- ./data:/data
stdin_open: true
tty: true
#restart: unless-stopped

overviewer: # note: doesn't update automatically
image: python:slim
ports:
- 8088:8000
volumes:
- overviewer:/srv/www:ro
command: python3 -m http.server -d /srv/www
#restart: unless-stopped

# Tooling (not automatically run)
overviewer-gen:
image: marctv/minecraft-overviewer
volumes:
- ./data:/tmp/server:ro
- ./overviewer-config.py:/tmp/config/config.py:ro
- overviewer:/tmp/export
environment:
# Comment out to remove renders,
# or edit overviewer-config.py directly.
#RENDER_SLICES: 1
#RENDER_NIGHT: 1
#RENDER_CAVES: 1
#RENDER_HEATMAP: 1
RENDER_NETHER: 1
RENDER_END: 1
# Logging Level
LOGGING_LEVEL: INFO # set to DEBUG to learn more
profiles:
- tools
restart: unless-stopped

volumes:
overviewer:
9 changes: 0 additions & 9 deletions mc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ Tooling:
$ ./mc rcon RCON interface to server (must be running)

Cron tasks
$ ./mc map Genreate overviewer map files
$ ./mc backup Create incremental backup of server

ENDHELPTEXT
Expand Down Expand Up @@ -86,13 +85,6 @@ rcon() {
$DOCKER_COMPOSE exec ds-java rcon-cli "$@"
}

map() {
# bugfix: cron job
# mitigation for "docker-compose: command not found"... root cause unknown
export PATH=$PATH:/usr/local/bin
$DOCKER_COMPOSE run --rm overviewer-gen
}

backup() {
bash scripts/backup.sh
}
Expand All @@ -117,7 +109,6 @@ case "$1" in

# Tools:
rcon) rcon "${@:2}" ;;
map) map "${@:2}" ;;
backup) backup "${@:2}" ;;

# Help Text
Expand Down
156 changes: 0 additions & 156 deletions overviewer-config.py

This file was deleted.

3 changes: 0 additions & 3 deletions scripts/templates/tasks.cron.jinja2
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Backup
00 3 * * * {{ USER }} bash {{ PWD }}/mc backup > {{ PWD }}/task-backup.log 2>&1

# Overviewer - generate map (incremental)
30 3 * * * {{ USER }} bash {{ PWD }}/mc map > {{ PWD }}/task-map.log 2>&1