# BuildContest Plugin<\/p>\n
BuildContest is a Velocity plugin that simplifies the setup of dedicated servers for each team in a building contest. The plugin uses Docker Compose to start sub-servers and automatically transfers players to their respective sub-servers for the contest. Team configurations and server information are persistently stored.<\/p>\n
## Features<\/p>\n
– **Automatic Sub-Server Creation**: Create team servers using HTTP API calls with Docker Compose, and register them with Velocity.
\n– **Automatic Player Transfer**: Players are automatically transferred to their corresponding sub-servers when joining the main server.
\n– **Permission Control**: Authenticate HTTP requests using Bearer Token.
\n– **Prevent Duplicate Participation**: When adding a team, if a player already exists in another team, they cannot join other teams.<\/p>\n
## Installation Steps<\/p>\n
1. **Prepare the Environment**
\n – Install Velocity proxy server.
\n – Ensure Docker and Docker Compose are installed and properly configured.<\/p>\n
2. **Create a Minecraft Contest Server Image (Sub-Server)**
\n – It’s recommended to use Little Wrench as the server base.
\n – Set the port to `25565` and ensure it can be accessed correctly via the proxy, including proper `forwarding-mode` settings.
\n – Create a Dockerfile for building the server image.
\n – Build the image, e.g., `docker build -t minecraft-contest:latest .`
\n – Create a `docker-compose.yml` file for starting the sub-server.<\/p>\n
3. **Download the Plugin**
\n – Jump to version page<\/p>\n
4. **Configure the Plugin**
\n – Place the plugin jar file in the `plugins\/` directory of Velocity.
\n – Start the Velocity server once to generate the configuration files, then stop the server to adjust settings.<\/p>\n
5. **Configure Files**
\n – Modify `config.yml` in the `plugins\/BuilderContest\/` directory to set up ports and other settings.
\n – Place `docker-compose-default.yml` in the plugin directory as the template for starting sub-servers.<\/p>\n
6. **Start the Server**
\n – Start the server and retrieve the `bearer-token` from the generated `config.yml`.<\/p>\n
## Configuration File Description<\/p>\n
**config.yml**
\n“`yaml
\nktor:
\n http-port: 8080 # HTTP service port.
\n port-start: 30000 # Starting port for sub-servers.
\n bearer-token: # Bearer Token; leave this empty on first use.
\n allow-host: “*” # Allowed host addresses.
\n“`<\/p>\n
**docker-compose-default.yml Example**
\n– Use `#SERVER_NAME_PLACEHOLDER` as the placeholder for the Docker container name.
\n– Use `#SERVER_PORT_PLACEHOLDER` as the placeholder for the port.
\n“`yaml
\nversion: ‘3.8’
\nservices:
\n minecraft_server:
\n image: minecraft-contest:latest
\n container_name: “#SERVER_NAME_PLACEHOLDER”
\n ports:
\n – #SERVER_PORT_PLACEHOLDER:25565
\n volumes:
\n # Mount the local world directory to the specified path in the container
\n – .\/worlds\/#SERVER_NAME_PLACEHOLDER\/world:\/app\/world
\n environment:
\n EULA: “TRUE”
\n restart: unless-stopped
\n“`<\/p>\n
## Usage Instructions<\/p>\n
### HTTP API<\/p>\n
– After the plugin starts, an HTTP service will be launched on port `8080` by default.
\n– Key API endpoint:
\n – **Add Team**: `POST \/team\/add`, requires Bearer Token authentication, with `teamId`, `teamName`, and `members` as payload fields.<\/p>\n
### Example Request<\/p>\n
“`bash
\ncurl –location –request POST ‘http:\/\/localhost:8080\/team\/add’
\n–header ‘Content-Type: application\/json’
\n–header ‘Authorization: Bearer sSCj4piDoEfV2zIo_C8lD7S4ul0YlVOyBr2BkKpdsTI (Retrieve this from config.yml)’
\n–data-raw ‘{
\n “teamId”: “team_1”,
\n “teamName”: “Team 1”,
\n “members”: [“Hanamizu_”, “user1”]
\n}’
\n“`<\/p>\n","protected":false},"excerpt":{"rendered":"
BuildContest plugin automatically creates Minecraft sub-servers using Docker and transfers players to their respective contest servers.<\/p>\n","protected":false},"featured_media":35509,"template":"","meta":{"_minecraft_slug":"buildcontest","_minecraft_project_id":"TqRJEKRj","_minecraft_author":"Hanamizu","_minecraft_license":"GPL-3.0-or-later","_minecraft_downloads":63,"_minecraft_follows":2,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"buildcontest.zip","_minecraft_size_bytes":34326902,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-15T20:41:11.314278Z","_minecraft_date_created":"2024-09-16T21:53:29.988972Z","_minecraft_date_modified":"2024-09-15T11:45:38.182648Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/buildcontest","_minecraft_icon_attachment_id":35509,"_minecraft_imported_at":"2026-06-01T17:16:01+00:00","_minecraft_import_hash":"9570eca91c42d91ce537eb61b8390203","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[126,91,92,985],"mod_loader":[986],"minecraft_version":[49,50,51,52,53,54,55,56,57,58,59,36,60,93,94,101,102,62,37],"class_list":["post-35508","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-management","mod_category-storage","mod_category-utility","mod_category-velocity","mod_loader-velocity","minecraft_version-1-17","minecraft_version-1-17-1","minecraft_version-1-18","minecraft_version-1-18-1","minecraft_version-1-18-2","minecraft_version-1-19","minecraft_version-1-19-1","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-19-4","minecraft_version-1-20","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6","minecraft_version-1-21","minecraft_version-1-21-1"],"yoast_head":"\n