|
|
||
|---|---|---|
| .github/workflows | ||
| api | ||
| build-logic | ||
| deepworld-config@6052c53944 | ||
| gameserver | ||
| gradle/wrapper | ||
| shared | ||
| src/main | ||
| .dockerignore | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| build.gradle | ||
| docker-compose.yml | ||
| Dockerfile | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| LICENSE.md | ||
| README.md | ||
| settings.gradle | ||
Brainwine
Brainwine is a Deepworld private server written in Java, designed to be portable and easy to use.
It's still a work in progress, so keep in mind that it's not yet feature-complete. (A to-do list can be found here.)
Brainwine currently supports the following versions of Deepworld:
- Windows:
v3.13.1 - iOS:
v2.11.0.1 - MacOS:
v2.11.1
Quick Local Setup
- Install Java 8.
- Download the latest Brainwine release.
- Run Brainwine, go to the server tab and start the server.
- Go to the game tab and start the game.
- If this isn't available for you, download a patching kit for your platform and follow the instructions there.
- Register a new account and play the game.
Building
Prerequisites
- Java 8 Development Kit
git clone --recurse-submodules https://github.com/kuroppoi/brainwine.git
cd brainwine
./gradlew dist
The output will be located in the /build/dist directory.
Using docker
To host brainwine using a docker you first need to build the image. On your server run the following:
git clone https://github.com/kuroppoi/brainwine && cd brainwine
docker buildx build -t brainwine:latest .
If you want to change the default ports exposed by the image use the --build-arg flag (e.g. --build-arg="GATEWAY_PORT=3000").
Now run the image in a container:
docker run --name "brainwine" --volume $PWD:/data brainwine:latest
If you want to use docker compose run this instead:
docker compose up
The server configuration files and the world data is saved in a docker volume and will accessible from /data/ in the container. Feel free to add or remove options passed to docker or edit the compose file.
Usage
Execute brainwine.jar to start the program. Navigate to the server tab and press the button to start the server.
It is also possible to start the server immediately with no user interface:
# This behavior is the default on platforms that do not support Java's Desktop API.
java -jar brainwine.jar disablegui
To connect to a local or remote server, download a patching kit for your desired platform.
Alternatively, Windows users may use the program's user interface to configure the host settings and start the game.