array-in-a-matrix/brainwine
1
0
Fork 0
mirror of https://github.com/array-in-a-matrix/brainwine.git synced 2025-04-02 11:11:58 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
A portable private server for Deepworld.
194 commits 2 branches 9 tags 2.3 MiB
Find a file
Kuroppoi 54a418712f
Alright let's see if this works
2022-04-16 16:32:12 +02:00
.github/workflows Alright let's see if this works 2022-04-16 16:32:12 +02:00
api Username regex 2022-03-05 15:55:29 +01:00
deepworld-config@378fc74df1 Added submodule deepworld-config 2022-04-16 15:09:29 +02:00
gameserver Grab game config from deepworld-config submodule 2022-04-16 15:13:16 +02:00
gradle/wrapper Update Gradle wrapper 2022-04-14 20:17:11 +02:00
shared Fixed indentation issues with concurrent pretty printing 2022-01-05 01:01:05 +01:00
src/main API improvements 2021-07-09 01:51:20 +02:00
.gitattributes Open source commit 2021-04-17 21:59:53 +02:00
.gitignore Open source commit 2021-04-17 21:59:53 +02:00
.gitmodules Added submodule deepworld-config 2022-04-16 15:09:29 +02:00
build.gradle Update log4j to 2.15.0 2021-12-12 16:00:28 +01:00
gradle.properties Improved overall project structure 2021-07-09 01:48:23 +02:00
gradlew Open source commit 2021-04-17 21:59:53 +02:00
gradlew.bat Open source commit 2021-04-17 21:59:53 +02:00
LICENSE.md Initial commit 2021-04-17 21:59:34 +02:00
README.md Update server setup instructions 2022-04-16 15:55:21 +02:00
settings.gradle Improved overall project structure 2021-07-09 01:48:23 +02:00

README.md

Brainwine

build

Brainwine is a Deepworld private server written in Java, made with user-friendliness and portability in mind. Due to the time it will take for this project to be complete (and my inconsistent working on it), brainwine has been prematurely open-sourced and is free for all to use.
Keep in mind, though, that this server is not finished yet. Expect to encounter bad code, bugs and missing features!
Brainwine is currently compatible with the following versions of Deepworld:

  • Steam: v3.13.1
  • iOS: v2.11.0.1
  • MacOS: v2.11.1

Features

A list of all planned, in-progress and finished features can be found here.

Setup

Setting up the client

Before you can connect to a server, a few modifications need to be made to the Deepworld game client.
The exact process of this differs per platform.
You may download an installation package for your desired platform here.

Setting up the server

Prerequisites

  • Java 8 or newer

You can download the latest release here.
Simply extract the .zip or .tar archive wherever you want and run the startup script for your OS.
Alternatively, if you wish to build from source, clone this repository with the --recurse-submodules flag
and run gradlew build in the root directory of the repository.
After the build has finished, the output will be located in build/distributions.

Configurations

On first-time startup, configuration files will be generated which you may modify however you like:

  • api.json Configuration file for news & API connectivity information.
  • loottables.json Configuration file for which loot may be obtained from containers.
  • generators Folder containing configuration files for zone generators.

Contributions

Disagree with how I did something? Found a potential error? See some room for improvement? Or just want to add a feature? Glad to hear it! Feel free to make a pull request anytime. Just make sure you follow the code style! And, apologies in advance for the lack of documentation. Haven't gotten around to do it yet. Sorry!

Issues

Found a bug? Before posting an issue, make sure your build is up-to-date and your issue has not already been posted before. Provide a detailed explanation of the issue, and how to reproduce it. I'll get to it ASAP!