diff --git a/README.md b/README.md index 1a1d0446..8c857063 100644 --- a/README.md +++ b/README.md @@ -52,17 +52,32 @@ cd azerothcore-wotlk/modules git clone https://github.com/liyunfan1223/mod-playerbots.git --branch=master ``` -Then, in the `docker-compose.yml` file, in the `volumes` section of the `ac-worldserver` container, add the modules folder to the volumes, like so: +Afterwards, create a `docker-compose.override.yml` file in the `azerothcore-wotlk` directory. This override file allows for mounting the modules directory to the `ac-worldserver` service which is required for it to run. Put the following inside and save: -```bash -volumes: - - ${DOCKER_VOL_ETC:-./env/dist/etc}:/azerothcore/env/dist/etc - - ${DOCKER_VOL_LOGS:-./env/dist/logs}:/azerothcore/env/dist/logs:delegated - - ${DOCKER_VOL_DATA:-ac-client-data}:/azerothcore/env/dist/data/:ro - - ./modules:/azerothcore/modules +```yml +services: + ac-worldserver: + volumes: + - ./modules:/azerothcore/modules:ro ``` -Then, run `docker compose up -d --build`. For more information, refer to the [Install With Docker](https://www.azerothcore.org/wiki/install-with-docker) page. +Additionally, this override file can be used to set custom configuration settings for `ac-worldserver` and any modules you install as environment variables: + +```yml +services: + ac-worldserver: + environment: + AC_RATE_XP_KILL: "1" + AC_AI_PLAYERBOT_RANDOM_BOT_AUTOLOGIN: "1" + volumes: + - ./modules:/azerothcore/modules:ro +``` + +For example, to double the experience gain rate per kill, take the setting `Rate.XP.Kill = 1` from [woldserver.conf](https://github.com/liyunfan1223/azerothcore-wotlk/blob/Playerbot/src/server/apps/worldserver/worldserver.conf.dist), convert it to an environment variable, and change it to the desired setting in the override file to get `AC_RATE_XP_KILL: "2"`. If you wanted to disable random bots from logging in automatically, take the `AiPlayerbot.RandomBotAutologin = 1` setting from [playerbots.conf](https://github.com/liyunfan1223/mod-playerbots/blob/master/conf/playerbots.conf.dist) and do the same to get `AC_AI_PLAYERBOT_RANDOM_BOT_AUTOLOGIN: "0"`. For more information on how to configure Azerothcore, Playerbots, and other module settings as environment variables in Docker Compose, see the "Configuring AzerothCore in Containers" section in the [Install With Docker](https://www.azerothcore.org/wiki/install-with-docker) guide. + +Before building, consider setting the database password. One way to do this is to create a `.env` file in the root `azerothcore-wotlk` directory using the [template](https://github.com/liyunfan1223/azerothcore-wotlk/blob/Playerbot/conf/dist/env.docker). This file also allows you to set the user and group Docker uses for the services in case you run into any permissions issues, which are the most common cause for Docker installation problems. + +Use `docker compose up -d --build` to build and run the server. For more information, including how to create an account and taking backups, refer to the [Install With Docker](https://www.azerothcore.org/wiki/install-with-docker) page. ## Documentation