mirror of
https://github.com/2006-Scape/2006Scape.git
synced 2026-07-02 16:49:03 +00:00
Josh Shippam
1c5b400f00
* Merge The File&Game Servers Into One Module * Make SettingsLoader A GameConstants ConfigLoader If A Config File Isn't Used, The Server Will Fall Back To The Defaults Set In GameConstants.java Config Files Can Be Loaded With The "-c/-config configfilelocation.json" Added A Default Prefilled ServerConfig.json * Update ConfigLoader * Bring Back Independant "Secrets" Loader For External Password Stuff * Added A Bunch More Vars To The ConfigLoader * Included A Sample "Server Config" * Also Updated README.md As Parabot Is No Longer Maintained & We No Longer Have A FileServer Module * Bundle FileServer with Server (docker) * Remove /udp and http port * Update .gitignore * Move FileServer from `org.apollo.jagcached` → `org/apollo/jagcached` * Tidy GameConstants & Add More Vars To ConfigLoader * Organised Up GameConstants A Little To Separate ConfigLoader Vars From The Rest * Added Some More Variables To Be Loaded Through The ConfigLoader * Fix A Derp Caused By Laziness * Add -c/-config arg to README.md * Enable FileServer By Default Co-authored-by: Danial <admin@redsparr0w.com>
60 lines
2.6 KiB
Markdown
60 lines
2.6 KiB
Markdown
# 2006Scape - an open source, actively developed emulation server. Pull requests welcome! 
|
|
|
|
## Discord Link: https://discord.gg/hZ6VfWG
|
|
|
|
## How to Play
|
|
|
|
### Client/Launcher Download: https://2006Scape.org/
|
|
### Rune-Server project thread: [Project thread](https://www.rune-server.ee/runescape-development/rs2-server/projects/686444-2006rebotted-remake-server-will-allow-supply-creatable-bots.html)
|
|
|
|
# Installation + Running (Developers)
|
|
|
|
1. Import Project in IntelliJ
|
|
|
|
2. Hit File > Project Settings > Set SDK to Java 8 (Download [Java 8 SDK](https://adoptopenjdk.net/?variant=openjdk8) if you don't have one already)
|
|
|
|
3. Navigate to `2006Scape Server` > `src` > `main` > `java` > `com.rs2`, right click GameEngine and hit Run [Image](https://i.imgur.com/HHooeVu.png)
|
|
|
|
[(You Can Also Run The Server With The -c/-config Argument)](https://wiki.2006scape.org/books/getting-setup/page/server-arguments)
|
|
5. Navigate to `2006Scape Client` > `src` > `main` > `java`, right click Client and hit Run [Image](https://i.imgur.com/gSmqGLn.png)
|
|
|
|
*Advanced*
|
|
|
|
To compile any module from the command line, run `mvn clean install`
|
|
|
|
## Using Parabot with your local server: (OUTDATED)
|
|
- **1:** Download the latest `localhost_2006Scape.jar` from [here](https://github.com/2006-Scape/2006Scape/releases) (or, if testing server changes, compile it yourself like [this](https://i.imgur.com/uDrF0gl.png))
|
|
- **2:** Download the latest `Provider-version.jar` file from [here](http://v3.bdn.parabot.org/api/bot/download/default-provider?nightly=false)
|
|
- **3:** Create a file called `localhost.json` in `{user}\Documents\Parabot\servers`
|
|
- **4:** Put the following in the file
|
|
```json
|
|
{
|
|
"name": "localhost",
|
|
"author": "RedSparr0w",
|
|
"version": 1.0,
|
|
"client-class": "LocalGame",
|
|
"locations":{
|
|
"provider": "pathToYourJar/Provider-1.21.5.jar",
|
|
"server": "pathToYourJar/localhost_2006Scape.jar",
|
|
"hooks": "http://bdn.parabot.org/data/hooks/carmeuses/2006rebotted_hooks.xml"
|
|
}
|
|
}
|
|
```
|
|
_(you will need to put the path to the jar files yourself)_
|
|
- 5: Run the parabot client with the following args:
|
|
```fix
|
|
java -jar Client-2.8.1.jar -login username password -loadlocal -v -clearcache
|
|
```
|
|
- **6:** ???
|
|
- **7:** PROFIT
|
|
|
|
### Server source layout
|
|
|
|
- `2006Scape Server` contains all the server code; mark `src` as the Sources directory
|
|
- `2006Scape Client` contains all the client code; likewise mark `src`
|
|
- If more than 2 arguments are passed in (can be anything), the client runs locally
|
|
|
|
## Building from command line
|
|
|
|
Run `mvn -B clean install`
|