Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/filiprokita/minecraft-atm10-playitgg-docker
Run an "All the Mods 10" Minecraft server with Docker and integrate it with playit.gg for easy access. Includes setup instructions and Docker Compose configuration.
https://github.com/filiprokita/minecraft-atm10-playitgg-docker
all-the-mods atm atm10 containerization docker docker-compose game-servers gaming minecraft minecraft-mods minecraft-server mods playit-gg playitgg server server-setup
Last synced: 4 days ago
JSON representation
Run an "All the Mods 10" Minecraft server with Docker and integrate it with playit.gg for easy access. Includes setup instructions and Docker Compose configuration.
- Host: GitHub
- URL: https://github.com/filiprokita/minecraft-atm10-playitgg-docker
- Owner: FilipRokita
- Created: 2024-09-17T11:05:28.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-17T11:48:38.000Z (3 months ago)
- Last Synced: 2024-12-19T02:09:26.882Z (4 days ago)
- Topics: all-the-mods, atm, atm10, containerization, docker, docker-compose, game-servers, gaming, minecraft, minecraft-mods, minecraft-server, mods, playit-gg, playitgg, server, server-setup
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Minecraft All the Mods 10 Server and playit.gg in Docker
## Overview
This guide explains how to run a Minecraft server for "All the Mods 10" using Docker. It also includes setup instructions for integrating a playit.gg tunnel to allow you and your friends to connect easily.
### This configuration should also work with ANY CurseForge modpack by adjusting the server files accordingly.
**Disclaimer:** Tested with `All The Mods 10-0.52` on `Ubuntu Server 22.04`.
## Prerequisites
- Git, Docker and Docker Compose installed on your server/machine.
- Basic familiarity with Docker and command-line interfaces.
- An account with playit.gg.
## Setup
1. **Clone the Repository**
- To clone the repository, run: `git clone https://github.com/FilipRokita/minecraft-atm10-playitgg-docker`
- To rename the folder to something shorter, run: `mv minecraft-atm10-playitgg-docker atm10srv`
2. **Download Server Files**
- Download the "All the Mods 10" server files from [CurseForge](https://www.curseforge.com/minecraft/modpacks/all-the-mods-10).
3. **Place Server Files**
- Move the downloaded `.zip` file to the `modpacks` folder in your project directory.
4. **Create a playit.gg Account**
- Sign up at [playit.gg](https://playit.gg) if you don’t already have an account.
5. **Set Up Docker-Based Agent**
- Follow the instructions on playit.gg to configure a Docker-based agent. Obtain your secret key and create a tunnel. This will allow external connections to your Minecraft server.
6. **Configure Docker Compose**
- Add your playit.gg secret key to the `docker-compose.yaml` file under the `playit` service's environment section. Replace `` with your actual secret key.
- Replace `` with the actual name of the server files `.zip` file you downloaded e.g. `Server-Files-0.52.zip`.
## Getting Started
### Start the Server
To start the server in detached mode, run:
```bash
docker compose up -d
```
**Note:** You must run this command inside the directory where the docker-compose.yaml file is located.
### Stop the Server
To stop the server and remove the containers, run:
```bash
docker compose down
```
**Note:** You must run this command inside the directory where the docker-compose.yaml file is located.
### Access Minecraft Server Console
To access the Minecraft server's CLI, run:
```bash
docker attach atm10srv-mc-1
```
### Detach from Minecraft Server Console
To safely detach from the CLI without stopping the server, press `[Ctrl] + [P]` followed by `[Ctrl] + [Q]`.
## Uninstall
### Remove Folder
To remove the `atm10srv` folder and all its contents, run:
```bash
rm -rf atm10srv
```
### Clear Unused Docker Resources
**Warning:** This will remove all unused Docker containers, images, volumes, networks, and more. Use with caution.
```bash
docker system prune -a
```
## Troubleshooting
If you encounter any issues or have questions, consider consulting the documentation for Docker, playit.gg or itzg's Minecraft Server on Docker.
- [Docker Docs](https://docs.docker.com/)
- [playit.gg Docs](https://playit.gg/support/)
- [itzg's Minecraft Server on Docker Docs](https://docker-minecraft-server.readthedocs.io/)
---
**Date:** 2024-09-17
**Author:** Filip Rokita
*Feel free to adjust the commands or configurations as needed.*