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.
50 commits 2 branches 9 tags 2.3 MiB
Find a file
kuroppoi 6370457be7 Now using item titles where it's appropriate
2021-04-24 23:18:51 +02:00
api Open source commit 2021-04-17 21:59:53 +02:00
bootstrap Added a stop command notification 2021-04-23 15:06:55 +02:00
gameserver Now using item titles where it's appropriate 2021-04-24 23:18:51 +02:00
gradle/wrapper Open source commit 2021-04-17 21:59:53 +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
build.bat Open source commit 2021-04-17 21:59:53 +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
gradlew.properties 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 Updated README.md 2021-04-18 00:35:54 +02:00
settings.gradle Open source commit 2021-04-17 21:59:53 +02:00

README.md

Brainwine

Brainwine is a private server written in Java for a game called Deepworld, 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 nowhere near finished. Expect to encounter bad code, bugs and missing features! Brainwine is currently only compatible with the Steam version of Deepworld.

Setup

Setting up your client

Before you can connect to your (or someone elses) server, you must first let Deepworld know to where it should connect. To do this, open the Registry Editor and navigate to HKEY_CURRENT_USER\SOFTWARE\Bytebin LLC\Deepworld. Look for a String Value called gateway or create it if it doesn't exist. Change the value to local if you wish to connect to an instance running on your PC, otherwise enter the host address and port of the server you wish to join. For example: 12.345.67.89:5001 If you did everything correctly, your client should now be ready.

Setting up the server

Setting up your own server is as easy as downloading this repository and running gradlew build in a command prompt. Alternatively, you can run the provided build.bat file. After the build task has finished, the output jar will be located in the build directory. To start the server, simply run the jar file with a simple command line such as java -jar brainwine.jar -Xms128m -Xmx512m. Be aware that Java 8 or newer is required to run Brainwine. If for whatever reason you are unable to create a build, you can download the latest release package here. Note that these aren't always up-to-date, though!

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!