Update README.md
Some checks failed
Build / build (push) Has been cancelled

This commit is contained in:
Array in a Matrix 2024-05-01 17:26:34 -04:00 committed by GitHub
parent f89ef059a3
commit f31cf9cc29
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -23,11 +23,19 @@ Brainwine currently supports the following versions of Deepworld:
## Building
#### Prerequisites
### Prerequisites
- Java 8 Development Kit
#### Using docker
```sh
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:
@ -53,16 +61,6 @@ 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.
#### Configurations
```sh
git clone --recurse-submodules https://github.com/kuroppoi/brainwine.git
cd brainwine
./gradlew dist
```
The output will be located in the `/build/dist` directory.
## Usage
Execute `brainwine.jar` to start the program. Navigate to the server tab and press the button to start the server.\