diff --git a/.gitignore b/.gitignore index fd02649..5e6e72f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ -data +data/* +!data/.gitkeep .env .DS_Store \ No newline at end of file diff --git a/README.md b/README.md index 9827c55..9d694d5 100644 --- a/README.md +++ b/README.md @@ -26,15 +26,7 @@ Copy the `.env.sample` file to `.env`: cp .env.sample .env ``` -Set the `GAME_FOLDER` variable in the `.env` file to path to the `/res` folder in your unpacked `LU` game folder. - -Next, create the `data` folder that's used to store the Postgres and Redis database files to ensure no loss of data: - -```bash -mkdir data -``` - -Deleting this folder will result in your Postgres database being wiped, including all the progress you've made in-game, be cautious when handling this folder! +Set the `GAME_FOLDER` variable in the `.env` file to the absolute path to the `/res` folder in your unpacked `LU` game folder. ## Running @@ -58,4 +50,8 @@ docker-compose down ## Adminer -Uchu Docker also automatically runs [Adminer](https://www.adminer.org), which allows you to easily modify the Uchu database in a user friendly way. After running Uchu Docker you can access Adminer through your browser at [this link](0.0.0.0:8080). Select the `PostgreSQL` database type, set the server to `db` and enter the credentials found in the `.env` file to login. More info on how to use Adminer can be found on their website. \ No newline at end of file +Uchu Docker also automatically runs [Adminer](https://www.adminer.org), which allows you to easily modify the Uchu database in a user friendly way. After running Uchu Docker you can access Adminer through your browser at [this link](0.0.0.0:8080). Select the `PostgreSQL` database type, set the server to `db` and enter the credentials found in the `.env` file to login. More info on how to use Adminer can be found on their website. + +## World ports (Advanced) + +If you wish to change the world ports, you can change the exposed ports in the `.env` file easily. The internal ports are locked by default to `2002` for the charater port and `10000-10100` for the api and world ports. If you wish to change these internal ports update the internal port values in the `.env` file. Ensure that `INTERNAL_API_PORT_RANGE` is updated to match your updated `INTERNAL_API_PORT` and `INTERNAL_MAX_WORLDS`. \ No newline at end of file diff --git a/config.default.xml b/config.default.xml index b1d3ae7..62e0cda 100644 --- a/config.default.xml +++ b/config.default.xml @@ -28,10 +28,10 @@ - $CHARACTER_PORT + $INTERNAL_CHARACTER_PORT true true - $MAX_WORLD_SERVERS + $INTERNAL_MAX_WORLDS false @@ -40,7 +40,7 @@ http localhost - $API_PORT + $INTERNAL_API_PORT diff --git a/data/.gitkeep b/data/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docker-compose.yaml b/docker-compose.yaml index 2f8785b..7cc0a66 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -37,7 +37,7 @@ services: volumes: - ${GAME_FOLDER}:/res ports: - - "2002:${CHARACTER_PORT}" - - "10000-10100:${API_PORT}-${MAX_API_PORT}" + - "${CHARACTER_PORT}:${INTERNAL_CHARACTER_PORT}" + - "${API_PORT_RANGE}:${INTERNAL_API_PORT_RANGE}" tty: true stdin_open: true