bai0012/mindustry repository overview

⁠Mindustry Server Docker Image

Welcome to the Docker image for the Mindustry server, based on Anuken's Mindustry⁠. Build with 7.0 Build 146⁠

Mindustry is an automation tower defense RTS game written in Java. This Docker image allows you to easily set up and run your own Mindustry server.

⁠Quick Start

To run the Mindustry server using this Docker image, execute the following command:

docker run -d \
  -p 6567:6567/tcp \
  -p 6567:6567/udp \
  -v $(pwd)/my-config:/app/config \
  --name mindustry-server \
  bai0012/mindustry

⁠Explanation of Parameters

• -d: Runs the container in detached mode (in the background).
• -p 6567:6567/tcp and -p 6567:6567/udp: Maps the server's TCP and UDP ports to your host machine, allowing clients to connect.
• -v $(pwd)/my-config:/app/config: Mounts a local directory named my-config to the server's config directory, allowing you to customize server settings.
• --name mindustry-server: Names the running container mindustry-server.
• bai0012/mindustry: The name of the Docker image to use.

⁠Features

• Automated Setup: Quickly deploy a Mindustry server with minimal configuration using Docker.
• Custom Configurations: Easily customize server settings by mounting your own configuration files.
• Portability: Run your server on any platform that supports Docker.

⁠Dedicated Server Commands

The Mindustry server supports various commands for managing gameplay and server settings. Some useful commands include:

• help [command]: Display the command list or get help for a specific command.
• version: Displays server version info.
• exit: Exit the server application.
• host [mapname] [mode]: Open the server with a specific map and mode.
• maps [all/custom/default]: Display available maps.
• status: Display server status.
• players: List all players currently in game.
• kick <username>: Kick a player by name.
• ban <type-id/name/ip> <username/IP/ID>: Ban a player.
• unban <ip/ID>: Unban a player by IP or ID.

For a full list of commands and their descriptions, refer to the Mindustry Wiki - Servers⁠.

⁠Configuration Options

You can customize the server with various configuration options:

• name: The server name as displayed on clients.
• desc: The server description.
• port: The port to host on.
• autoUpdate: Auto-update to the latest version.
• enableVotekick: Enable or disable votekick.
• logging: Enable logging to files.
• whitelist: Use a whitelist for player connections.

For detailed configuration options, refer to the Mindustry Wiki⁠.

Enjoy running your Mindustry server! If you encounter any issues or have suggestions, feel free to reach out to the community or contribute to the project.