From abcc8f9abcd5a51953681c0cf36c937e65c92345 Mon Sep 17 00:00:00 2001
From: kuroppoi <68156848+kuroppoi@users.noreply.github.com>
Date: Sat, 17 Apr 2021 21:59:34 +0200
Subject: [PATCH] Initial commit

---
 LICENSE.md | 22 ++++++++++++++++++++++
 README.md  | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 56 insertions(+)
 create mode 100644 LICENSE.md
 create mode 100644 README.md

diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644
index 0000000..32b59fc
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2021 kuroppoi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..72be884
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# 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.
+
+## 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!
\ No newline at end of file