This is a OSRS base heavily influenced by OS-Scape source code. I've tried to retain the classes author comments for code that is a copy of OSS code.
What's different here vs original OS-S?
Created a blank Spring-based project, with web server disabled (we don't need it, at least not yet). Then code related to networking, logging in etc was copied over from OS-S. This essentially gave us a blank base without Quasar. Once that was done, the process of reimplementing necessary fundamental core functionality (like Redis, serializer, command system, etc) was started.
What's the goal of this project?
The project aims to use as much of OS-S original code as possible. However, eliminating the Quasar library and implementing Spring framework to leverage its dependency injection. Possibly also web server to serve real time data from the server from REST APIs.
The goal is then to create an okay base to start piecing together a Dodian remake. There is currently a server for Dodian, however it's awfully bugged and is a nightmare to maintain in just about any way.
- Ideally you have an SSH key setup with your Github account.
if not, you can click here to read about how you do that. - When you have your SSH key setup, you can click the green "Code" button above the repository.
This will show you a popup dialogue with some options. I recommend SSH, so copy the SSH url. - Open your preferred IDE (I would personally recommend IntelliJ, get the community edition if you don't already have IntelliJ.).
- In IntelliJ, you need to find the option to check out/get from VCS. If you have a project open already, it should be under File -> New -> Project From Version Control...
- Once it has downloaded, just open it, and let the Gradle stuff import. If it doesn't detect the Gradle project automatically, you need to right-click
build.gradle.kts
and click Import Gradle Project - For
game-client
you will likely have to manually import the Gradle project. See step 5 for explanation if not sure. - Make sure you have a server.conf in your data folder, look at the example config for an example.
- You need to download the cache. You can use the default OSS cache. Click here to download.
- You should now be able to launch the server and client. First launch the server. You can find the Gradle tab to the right in IntelliJ. Under
dodian-osrs
(game server), you find Tasks -> application -> bootRun, double click that. Then you finddodian-osrs-client
(game client), you find Tasks -> application -> run. - Make sure to read the guidelines on how to contribute to the project before you submit your pull requests.