therbron/SNIR-MC
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Initialise repository with appropriate README

Browse Source
This commit is contained in:
Tanguy Herbron 2021-04-30 14:40:07 +02:00
commit c415649b17
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# SNIR's minecraft server
## Usage
Game server for the Minecraft game. It includes configurations for server optimization and quality of life. The repository also contains the map, which can be downloaded separately and used independently.
## Requirements
Do deploy this instance, you only need to install `docker-compose` and `docker`.
## Installation
To deploy a copy of this instance, you might want to modify where the volumes are pointing to.
Then run
```
docker-compose up -d
```
All necessary images should be downloaded automatically and the service should be started in the background.
## Minecraft update
When an update is release by Mojang, the `jar` file must be updated and further configuration might be necessary to keep server optimization and quality of life improvements.