# vmangos-docker

**Repository Path**: game-boy/vmangos-docker

## Basic Information

- **Project Name**: vmangos-docker
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2020-11-16
- **Last Updated**: 2021-11-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://travis-ci.org/tonymmm1/vmangos-docker.svg?branch=master)](https://travis-ci.org/tonymmm1/vmangos-docker)
# vmangos-docker

## Release: 0.5.0

This is a project that is based on the VMaNGOS core running on Docker. 

Source code from https://github.com/vmangos/core.

Website code from https://github.com/FusionGen/FusionGen.

The configuration should be configured to work with localhost games and can be edited by changing the realmd.realmd table and adding the correct server information.
Changing the exposed port for mysql should also be considered if not removing it all together. Website functionality will be configured with a separate function within setup.sh.

### Arm Notice:

Make sure operating system is 64bit and that thread count should be 2 for <= 4GB ram.

### Requirements:

* [Git 1.8.3+](https://git-scm.com/)

* [Docker-CE 18.06.00+](https://docs.docker.com/get-docker/)

* [Docker Compose 1.22.0+](https://docs.docker.com/compose/install/)

* [Operating System is 64 bit](https://en.wikipedia.org/wiki/64-bit_computing)
    ([Currently Raspbian is only 64bit beta](https://www.raspberrypi.org/blog/latest-raspberry-pi-os-update-may-2020/))

* [Python 3.5+](https://www.python.org/downloads/)

* [Tmux(recommended for docker attach)](https://github.com/tmux/tmux/wiki/Getting-Started)

### Step 1:
#### a.) Place dependencies as listed below:

* /src/data 
* /src/data/maps
* /src/data/mmaps
* /src/data/vmaps
* /src/data/5875(adjust according to patch release)
* /src/data/5875/dbc

#### b.) Configuration Files:

* Server config: 	/config
* Database config: 	/env/db.env
* VMaNGOS: 		/vmangos
* Database volume: 	/var/lib/docker/volumes/vmangos_database
* Website config: 	/web
* CCache:		/src/ccache

### Step 2:
#### a). Run setup.py for creating containers and for managing this project. Default flags are already applied and a help menu can be shown.
  
```
chmod +x 
./setup.py 
```

Help menu:

```
./setup.py -h
```

#### b). Configure realm ip address
Use mysql-workbench or from the vmangos_database container edit the ip address column in realmd.realmlist to set the ip that will be exposed for connections(public ip required for internet). Using the account and password for the mangos user or the root user as can be configured in db.env. 

### Step 3:
#### a). Website file configuration

Make sure to edit /web/site.conf and change the server_name

```
vim web/site.conf
server_name ${FQDN};
```

#### b). Website installation

1. Visit http://${FQDN}/install
2. Proceed with installation steps 

### Step 4: Maintenence
#### a). Updating all repos

```
./setup.py -m 0 --update
```

#### b). Cleaning CCache

```
./setup.py --ccache
```

#### c). Cleaning unused Docker Containers

```
./setup.py --docker
```

### Command line options:

```
Vmangos-Docker cli

optional arguments:
  -h, --help  show this help message and exit
  -m M        Select mode
              	0 = website(default)
              	1 = no website
              	3 = reset all files
  --update    Use update mode
  -t T        Input number of threads to use for compiling, values 1-2(2 default) for <4GB ram
  -u U        Requires running with sudo, Use user:group 1000:1000(default)
  -c C        Input Client version to compile
              	4222 = 1.2.4
              	4297 = 1.3.1
              	4375 = 1.4.2
              	4449 = 1.5.1
              	4544 = 1.6.1
              	4695 = 1.7.1
              	4878 = 1.8.4
              	5086 = 1.9.4
              	5302 = 1.10.2
              	5464 = 1.11.2
              	5875 = 1.12.1(default)
  -a A        Enable anticheat
              	0 = Disable Anticheat(default)
              	1 = Enable Anticheat
  --ccache    Clean CCache(exclusive)
  --docker    Docker Clean(exclusive)
  -v          Increase output verbosity
```

Example command config

```
./setup.py -m 0 -t 2 -u 1000:1000 -c 5875 -a 0 
```

### List of Commands:
#### General commands(All docker-compose commands must be run from within the project directory)

For non-website configs make sure to replace docker-compose with docker-compose -f noweb-docker-compose.yml

```
docker-compose up (Creates and runs containers with console output)
docker-compose up -d (Creates and detaches from running containers)
docker-compose ps (Lists all running containers)
docker-compose stop (Stops containers without destroying)
docker-compose restart (Restart containers)
docker-compose down (Destroys containers)
docker-compose down -v (Destroys containers and volumes)
docker-compose exec vmangos_(container) bash (Executes bash inside container of choice)
docker ps (Lists all running docker processes)
#using tmux/screen is recommended to not kill
docker attach (applies to the vmangos_mangos/realmd/database) session
```