vttc08/mcaselector repository overview

⁠Docker container for MCASelector

This project implements a Docker container for MCASelector⁠.

I used the jlesage jlesage/docker-baseimage-gui⁠ with Ubuntu 22.04 as the base image to build this container (alpine do not work due to MCASelector requiring JavaFX).

The project allows Minecraft admins to modify chunks with a powerful GUI tool directly in browser without having to copy and paste the world save to a local machine. This could be useful for editing worlds on a VPS/headless server, editing a world with slow non-local network/VPN connections or allowing multiple admins to edit the world without constantly transferring the world save.

⁠An external tool to export or delete selected chunks and regions from a world save of Minecraft Java Edition.

⁠Limitations

Fullscreen do not work - this is documented in here⁠

• To enable fullscreen, you'll need to manually click the maximize icon on the top right of the window every time you start/restart the container
• The windows size in Openbox for this software is inconsistent, to change the size of a window in Openbox:
  • Hold down the Alt key and right-click on the window to the direction you want to resize it.

If you know the cause or how to fix this, feel free to make a pull request.

⁠Table of Content

• Docker Run Command⁠
• Docker-Compose⁠
• Updates⁠
  • Container⁠
  • Application⁠
• Additional Information⁠
  • MCASelector⁠
  • Docker Image Configuration⁠
• Development⁠
  • Reproduce the Fullscreen Bug⁠

⁠Docker Run Command

NOTE: The Docker command provided in this quick start is given as an example and parameters should be adjusted to your need.

Launch the MCASelector docker container with the following command:

docker run -d \
    --name=mcaselector \
    -p 5800:5800 \
    -v /docker/minecraft-server/world:/world:rw \
    -v /appdata/mcaselector:/config:rw \
    vttc08/mcaselector

Where:

• /appdata/mcaselector: This is where the application stores its configuration, states, log and any files needing persistency.
• /docker/minecraft-server/world: This is where the world save of Minecraft Java Edition which you want to edit in MCASelector.

⚠ MCA Selector modifies and deletes chunks in your Minecraft world. Please make backups of your world before using.

• If you do not wish to edit the chunks and save it directly to your server, you should mount your backup world instead and copy that once the edit is successful.

Browse to http://your-host-ip:5800 to access the MCASelector GUI.

⁠Docker-Compose

version: '3'
services:
  mcaselector:
    image: vttc08/mcaselector
    container_name: mcaselector
    ports:
      - "5800:5800"
      - "5900:5900"
    volumes:
      - "/docker/minecraft-server/world:/world:rw"
      - "/appdata/mcaselector:/config:rw"
    environment:
      - USER_ID=1000
      - GROUP_ID=1000
      - TZ=America/New_York
      - KEEP_APP_RUNNING=1
      - MEMORY=4G
    restart: unless-stopped

⁠Updates

⁠Container

To update the container, you can run the following commands which will pull the latest container image, then re-run the container with the same parameters as before:

docker pull vttc08/mcaselector

or using docker compose

docker compose pull
docker compose up -d --force-recreate

⁠Application

This container image may not follow the latest release of MCASelector or you want to run a different version of MCASelector without building an entire container. To update:

• Download the latest release of MCASelector from here⁠ using wget or curl on your server.
  • if you use a bind mount, simply replace the jar file in /config with the new jar file
  • if you use a volume or other method, you can copy the jar file into the container

  docker cp mcaselector.jar mcaselector:/config
  

  Copy

⁠Additional Information

⁠MCASelector

To documentation for MCASelector can be found here⁠.

There are also YouTube tutorials

• How To Reset Chunks In Your Minecraft World!⁠ by Farzy⁠
• How To Clear Unwanted Chunks In Minecraft 1.16 | MCASelector Tutorial⁠ by Muriako⁠
• Preparing Your World for the Nether Update! - The Minecraft Survival Guide⁠ starting at 2:52⁠ by Pixlriffs⁠
• How To Reset The End Dimension! - The Minecraft Survival Guide⁠ starting at 8:45⁠ by Pixlriffs⁠

Not all features of MCASelector may work, if you encounter any issues and do not encounter it when running MCASelector natively, please open an issue here⁠.

⁠Docker Image Configuration

The above docker-compose⁠ file is a good starting point for configuring jlesage GUI containers. For advanced configuration such as changing the resolution, password authentication, ports and logging, consult the base image documentation⁠ for those options.

⁠Development

If you want to contribute to this project, you can fork/clone this repository and make a pull request.

git clone https://github.com/vttc08/docker-mcaselector.git
cd docker-mcaselector

Build the image

docker build . -t mcaselector

If you want to publish the image via Github Action. Make sure to set the DOCKER_USERNAME and DOCKER_TOKEN in the repository secrets and change DOCKER_IMAGE_NAME in .github/workflows/build-image.yml.

⁠Reproduce the Fullscreen Bug

jlesage images uses rootfs/etc/openbox/main-window-selection.xml to make a window fullscreen. You can read official documentation on the full screen here⁠. Change the main-window-selection.xml to this to reproduce.

<Type>normal</Type>
<Name>net.querz.mcaselector.ui.Windows</Name>