Add contributing, code of conduct and update readme

CODE_OF_CONDUCT.md

@@ -0,0 +1,122 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+*[email protected]*.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

CONTRIBUTING.md

@@ -0,0 +1,119 @@
+# Contributing to Void
+
+First off, thanks for taking the time to contribute! ❤️
+
+All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
+
+> [!TIP]
+> If you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
+> - Star the project
+> - Refer this project in your project's thread or readme 
+
+## Table of Contents
+
+- [I Have a Question](#i-have-a-question)
+- [I Want To Contribute](#i-want-to-contribute)
+    - [Reporting Bugs](#reporting-bugs)
+    - [Suggesting Enhancements](#suggesting-enhancements)
+    - [Your First Code Contribution](#your-first-code-contribution)
+- [Style Guides](#style-guides)
+    - [Commit Messages](#commit-messages)
+
+
+
+## I Have a Question
+
+> [!NOTE]
+> If you want to ask a question, we assume that you have read the available [Wiki](https://github.com/GregHib/void/wiki) and [Troubleshooting Guide](https://github.com/GregHib/void/wiki/troubleshooting/) pages.
+
+Before you ask a question, it is best to search for existing [Issues](https://github.com/GregHib/void/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
+
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+
+- Open an [Issue](https://github.com/GregHib/void/issues/new).
+- Provide as much context as you can about what you're running into.
+- Provide project and platform versions (jdk version, ide, etc), depending on what seems relevant.
+- [Don't ask to ask, just ask.](https://dontasktoask.com/)
+
+We will then take care of the issue as soon as possible.
+
+## I Want To Contribute
+
+> [!IMPORTANT]
+> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
+
+### Reporting Bugs
+
+#### Before Submitting a Bug Report
+
+A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+
+- Make sure that you are using the latest version.
+- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/GregHib/void/wiki). If you are looking for support, you might want to check [this section](#i-have-a-question)).
+- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/GregHib/void/issues?q=label%3Abug).
+- Also make sure to search the internet (including Stack Overflow) to see if users outside the GitHub community have discussed the issue.
+- Collect information about the bug:
+    - Stack trace (Traceback)
+    - OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+    - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
+    - Possibly your input and the output
+    - Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+
+#### How Do I Submit a Good Bug Report?
+
+> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>.
+
+We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+
+- Open an [Issue](https://github.com/GregHib/void/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
+- Explain the behavior you would expect and the actual behavior.
+- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
+- Provide the information you collected in the previous section.
+
+Once it's filed:
+
+- The project team will label the issue accordingly.
+- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
+- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for Void, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
+
+#### Before Submitting an Enhancement
+
+- Make sure that you are using the latest version.
+- Read the [documentation](https://github.com/GregHib/void/wiki) carefully and find out if the functionality is already covered, maybe by an individual configuration.
+- Perform a [search](https://github.com/GregHib/void/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
+
+#### How Do I Submit a Good Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](https://github.com/GregHib/void/issues).
+
+- Use a **clear and descriptive title** for the issue to identify the suggestion.
+- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
+- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
+- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
+- **Explain why this enhancement would be useful** to most Void players. You may also want to point out the other projects that solved it better and which could serve as inspiration.
+
+### Your First Code Contribution
+
+To submit contributions please [fork the repository](https://github.com/GregHib/void/fork) [check out](README.md#development) the project in your IDE, apply the changes to a branch and [Submit a Pull Request](https://github.com/GregHib/void/pulls).
+
+## Style guides
+
+### Commit Messages
+
+Commit messages should:
+* Briefly explain each change made and the reasoning for them.
+* Start with a capital letter
+* Be written in imperative mood. That is to say; written to fit the sentence "If I apply these changes to my code it will..."
+
+### Code
+
+For content code guidelines see the [Void Wiki](https://github.com/GregHib/void/wiki) and [Philosophy](https://github.com/GregHib/void/wiki/philosophy) pages.
+General code style guidelines should follow the [kotlin coding conventions](https://kotlinlang.org/docs/coding-conventions.html).
+
+## Attribution
+This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

README.md

@@ -1,3 +1,111 @@
-# Void
+<div style="text-align: center;">
+<h1>Void</h1>
+<a href="https://github.com/GregHib/void">
+  <img src="https://i.imgur.com/N8RhzRY.png" alt="void">
+</a>
 
-High performance single player 634 server focusing on knowledge representation and AI architecture.
+<p>Void is a lightweight, high-performance back-end game server emulating the 2011 MMORPG RuneScape (revision 634). It serves as a modern and user-friendly base for others to built-off of.</p>
+
+<a href="#features">Features</a> &nbsp;&bull;&nbsp;
+<a href="#installation">Installation</a> &nbsp;&bull;&nbsp;
+<a href="https://rune-server.org/runescape-development/rs-503-client-and-server/projects/697260-void-634-a.html">Blog</a> &nbsp;&bull;&nbsp;
+<a href="https://github.com/GregHib/void/wiki">Documentation</a> &nbsp;&bull;&nbsp;
+<a href="https://github.com/GregHib/void/issues">Bugs</a>
+</div>
+
+## Features
+
+* Capable of handling thousands of concurrent players
+* Wide range of emulated content
+* AI driven player bots
+* Developer friendly content creation
+* Low memory usage
+
+![void in game picture](https://i.imgur.com/OZ317on.png)
+
+## Installation
+
+### Prerequisites
+
+* Installed Java Development Kit (JDK) 19 or above. https://adoptium.net/en-GB/
+* Downloaded the latest `client.jar` from the [client release page](https://github.com/GregHib/void-client/releases).
+* Downloaded pre-modified cache game files from [cache artifacts](https://mega.nz/folder/ZMN2AQaZ#4rJgfzbVW0_mWsr1oPLh1A).
+
+> [!TIP]
+> There are instructions on how to [build your own client](https://github.com/GregHib/void/wiki/client-building) and [build your own cache](https://github.com/GregHib/void/wiki/cache-building)!
+
+### Download game code
+
+> [!NOTE]
+> Jar builds, game bundles and docker images are coming soon!
+
+#### Git
+
+Clone the repository using the GitHub url.
+
+```bash
+git clone [email protected]:GregHib/void.git
+cd void
+```
+
+#### Manual download
+
+Download from GitHub and extract the `void-main.zip`
+
+![github code button menu](https://i.imgur.com/98TDsxX.png)
+
+### Extract cache
+
+Create a new folder `/cache/` inside the `/data/` directory and extract the cache files inside of it.
+The files location should look like this: `/void/data/cache/main_file_cache.dat2`
+
+### Play
+
+To quickly launch the server to log in and play; open a terminal in the `void` directory and run the following command:
+
+```bash
+./gradlew run
+```
+
+> [!TIP]
+> Ctrl + C to exit and shutdown the server when running from a command line terminal.
+
+#### Common issues
+
+To resolve the error
+
+```bash
+> Kotlin could not find the required JDK tools in the Java installation. Make sure Kotlin compilation is running on a JDK, not JRE.
+```
+
+Open the `gradle.properties` file, remove the hash from the first line and replace the directory with the location of
+your JDK installation.
+
+```properties
+org.gradle.java.home=C:/Users/Greg/.jdks/openjdk-19.0.1/
+```
+
+### Development
+
+It is recommended to use IntelliJ IDEA to develop with Void.
+The community edition can be downloaded for free from the [jetbrains website.](https://www.jetbrains.com/idea/download/)
+See [the installation guide](https://www.jetbrains.com/help/idea/installation-guide.html) for more instructions.
+
+Once inside the IDE, you can create a new project by going to `File | New | Project from version control... |`
+
+Selecting `git` version control and entering the void project URL `[email protected]:GregHib/void.git` found under the `<> Code` button on the [GitHub page](https://github.com/GregHib/void).
+
+Press clone and after a little while the project will be opened for you, the JDK indexed and gradle setup.
+
+From here you can navigate in the left panel to `/game/src/main/kotlin/world/gregs/voidps/` where you will find [Main.kt](./game/src/main/kotlin/world/gregs/voidps/Main.kt) which you should be able to right-click and run.
+
+> [!NOTE]
+> See the [Troubleshooting Guide](https://github.com/GregHib/void/wiki/Troubleshooting) for further problems.
+
+## Documentation
+
+For further guides on how to write content please refer to the [Void Wiki](https://github.com/GregHib/void/wiki/).
+
+## Bugs
+
+If you run into any problems or find any bugs please report them by creating a [New Issue on our Issues Page](https://github.com/GregHib/void/issues) describing the problem, so it can be fixed.

game/build.gradle.kts

@@ -1,5 +1,6 @@
 plugins {
     `java-library`
+    application
 }
 
 dependencies {
@@ -30,4 +31,9 @@ dependencies {
 }
 tasks.withType<Test> {
     jvmArgs("-XX:-OmitStackTraceInFastThrow")
+}
+
+application {
+    mainClass.set("world.gregs.voidps.Main")
+    tasks.run.get().workingDir = rootProject.projectDir
 }

game/src/main/kotlin/world/gregs/voidps/world/command/admin/BotCommands.kts

@@ -133,9 +133,9 @@ fun setAppearance(player: Player): Player {
     player.body.setLook(BodyPart.Feet, struct["character_style_shoes"])
     val offset = random.nextInt(0, 8)
     player.body.setColour(BodyColour.Hair, enums.get("colour_hair").randomInt())
-    player.body.setColour(BodyColour.Top, struct["character_style_top_colour_$offset"])
-    player.body.setColour(BodyColour.Legs, struct["character_style_legs_colour_$offset"])
-    player.body.setColour(BodyColour.Feet, struct["character_style_shoes_colour_$offset"])
+    player.body.setColour(BodyColour.Top, struct["character_style_colour_top_$offset"])
+    player.body.setColour(BodyColour.Legs, struct["character_style_colour_legs_$offset"])
+    player.body.setColour(BodyColour.Feet, struct["character_style_colour_shoes_$offset"])
     player.body.setColour(BodyColour.Skin, enums.get("character_skin").randomInt())
     player.appearance.emote = 1426
     return player