From ff9a7278ce33f7fc58055ebc335b9490abf506c9 Mon Sep 17 00:00:00 2001 From: bushtail Date: Tue, 12 Jul 2022 22:57:47 +0000 Subject: [PATCH] Rewrote README.md --- README.md | 191 +++++++++++++++++------------------------------------- 1 file changed, 60 insertions(+), 131 deletions(-) diff --git a/README.md b/README.md index 099d852ce..6ae230395 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@

- + Logo

An open source MMORPG emulation server

@@ -17,8 +17,6 @@ ยท Report Bug

NOTE: Bug reports and support are only accepted by/offered to players of our live hosted server. We will not provide support to those running their own copies.

-

- ## Table of Contents @@ -27,9 +25,8 @@ * [Our Core Values](#our-core-values) * [Contributing](#contributing) * [Setup for Content Developers](#content-developers-setting-up-the-project) - * [Github Setup](#github-setup) + * [GitLab Setup](#gitlab-setup) * [Prerequisites](#prerequisites) - * [Prereq Installation](#prereq-installation) * [Project Setup](#project-setup) * [Running the project](#running-the-project) * [License](#license) @@ -38,7 +35,7 @@ ## Live Server Information -Did you know that the 2009Scape Development Team hosts the main branch of this repo that you can connect to and play? Come join a growing community of people that love to grind out skills, quest, and hangout together. A download link for the launcher can be found here. Connecting to the live server is also one of the easiest ways to identify bugs/typos/missing features. Identifying these issues help developers, whether already on the project, or are even brand new to the project, fix bugs and issues in an expedited rate. +Did you know that the 2009Scape Development Team hosts the main branch of this repo that you can connect to and play? Come join a growing community of people that love to grind out skills, quest, and hangout together. A download link for the launcher can be found [here](https://2009scape.org). Connecting to the live server is also one of the easiest ways to identify bugs/typos/missing features. Identifying these issues help developers, whether already on the project, or are even brand new to the project, fix bugs and issues in an expedited rate. ## History of this Codebase @@ -48,177 +45,109 @@ This project was started out of love for the 530 revision. A small group of deve ## Our Core Values -In the current climate of RSPS in general, we believe it's important to wear our core values on our sleeves and defend them with everything we have! Below are what we hold as our core, most important values: +In the current climate of RuneScape Private Servers in general, we believe it's important to wear our core values on our sleeves and defend them with everything we have! Below are what we hold as our core, most important values: -* **We do NOT believe in profiting off RSPS.** To many of us here at the 2009scape team, what we care about most is preserving the wonderful work of the Gower brothers in the most true-to-spirit manner possible. We do NOT do this to make a profit, and in fact **we outright refuse donations.** This is a labor of love and passion for everyone involved, a love for real RS2! This is perhaps the single most central value we have. If you want to "donate" to us, do so with your time and your dedication. That is what we desire most. +* **We do NOT believe in profiting off an RSPS.** To many of us here at the 2009Scape team, what we care about most is preserving the wonderful work of the Gower brothers in the most true-to-spirit manner possible. We do NOT do this to make a profit, and in fact **we outright refuse donations.** This is a labor of love and passion for everyone involved, a love for real RS2! This is perhaps the single most central value we have. If you want to "donate" to us, do so with your time and your dedication. That is what we desire most. * **Authenticity is central to the work**. As a remake, one of the most important things to us is being true to the Gower spirit. What the Gowers brought to us in our childhood is what we are driven to preserve for the remainder of the world. -* **Open Source Is Crucial**. We believe open source remakes to be crucial to preserving what we loved in our childhood, and we believe for-profit and/or closed-source servers are destined to flounder out and fail. +* **Open Source is crucial to the project**. We believe open source remakes to be crucial to preserving what we loved in our childhood, and we believe for-profit and/or closed-source servers are destined to flounder out and fail. -* **Be Welcoming**. One of our most important goals is to provide a community of friendly and caring people that get along and love to enjoy the game with eachother. For this reason, we do tend to be very strict when it comes to toxicity. We care about quality a whole lot more than quantity! +* **Be welcoming**. One of our most important goals is to provide a community of friendly and caring people that get along and love to enjoy the game with eachother. For this reason, we do tend to be very strict when it comes to toxicity. We care about quality a whole lot more than quantity! ## Contributing -

Note: All merge requests MUST be made using the defaut MR template you can select from the dropdown when creating a new merge request. Merge requests that do not use this template will not be accepted.

-

More information on Kotlin can be found here.

+**Note: All merge requests MUST be made using the defaut MR template. Merge requests that do not use this template will not be accepted.** +**More information on Kotlin can be found [here](https://kotlinlang.org/).** There are many ways everyone can contribute! From the most seasoned programmers to those who do not have the most remote clue how code works! Below are some things that can always use some love from the community. -* **Wiki Editors**: Did you know we have a wiki? Well it's always in need of people to fill it out and stay on top of it. Editing the wiki is one of the easiest ways you can contribute to 2009scape! If you're an active player and have the will, there's so much you could be helping out with over at the wiki. Click here to go to the wiki. +* **Content Testers**: I'm putting this one up top because of its importance. We, the contributors and developers, aren't perfect. Sometimes, we make mistakes. This is where you come in - If you want a sneak peek at upcoming content, have a knack for breaking things, or just want to contribute to the project without making code changes, you can become a tester! If you are interested in becoming a tester, reach out in the testing channel of the discord. [Why become a tester?](#why-become-a-tester) -* **JSON editors**: Did you know that the vast majority of our drop tables, stats, examines, item info, npc info, etc is all stored in a very easy-to-modify format called JSON? This is something almost anyone can help with, especially with the tool made by Ceikry to make it simple and streamlined. If you want to know what can be done to help here, get in touch in the development channel in the discord! **JSON editors are always in need and always appreciated!!**. +* **Wiki Editors**: Did you know we have a wiki? Well it's always in need of people to fill it out and stay on top of it. Editing the wiki is one of the easiest ways you can contribute to 2009Scape! If you're an active player and have the will, there's so much you could be helping out with over at the wiki. [Click here to go to the wiki](https://cdn.2009scape.org/wiki/doku.php?id=start). -* **Auditors**: As a remake, authenticity is central to our core values! We could always use someone to go through the game and create large lists of simple tasks that can be done to bring us closer to the authentic 2009 game! The preferred way to do this is one-area-at-a-time. If you want to see an example of some audits we've done in the past, take a look here. +* **JSON editors**: We could always use more JSON editors! Please note that JSON editing **must** be done using the [Thanos Tool](https://gitlab.com/2009scape/rs09-thanos-tool/-/jobs/artifacts/master/raw/build/libs/thanostool.jar?job=build). -* **Content Developers**: As a remake, we have massive amounts of content that need to be implemented or corrected. If you know how to program or are willing to learn, this is where you could be extremely helpful! We need everything from quests to dialogue to minigames to skills that still need to be corrected or implemented, and this is perhaps one of the most valuable ways someone could help out the project! If you are interested in developing content, reach out in the development channel of the Discord. +* **Authenticity Auditors**: As a remake, authenticity is central to our core values! We could always use someone to go through the game and create large lists of simple tasks that can be done to bring us closer to the authentic 2009 game! The preferred way to do this is one-area-at-a-time. If you want to see an example of some audits we've done in the past, take a look [here](https://gitlab.com/2009scape/2009scape/-/issues/46). + + +* **Code Contributors**: As a remake, we have massive amounts of content that need to be implemented or corrected. If you know how to program or are willing to learn, this is where you could be extremely helpful! We need everything from quests, to dialogue, to mini-games, to skills that still need to be corrected or implemented. This is perhaps one of the most valuable ways someone could help out the project! If you are interested in developing content, reach out in the development channel of the Discord. ## Content Developers: Setting Up the Project. -### Gitlab Setup +### GitLab Setup +**Note: This allows you to commit changes to the main repo (with approval)! Also, always stay up to date with the most recent updates by pulling into your copy when 2009Scape updates!** -

Note: This allows you to commit changes to the main repo (with approval)! Also, always stay up to date with the most recent updates by pulling into your copy when 2009Scape updates!

+1. Create a GitLab account if you haven't done so already. -1. Create a gitlab account if you haven't done so already +2. Click "Fork" in the top right-hand side of our GitLab page. -3. Click "Fork" in the top right hand side of our gitlab page. - -**If at anytime you have an issue with gitlab please refer to the** Gitlab help center. - -### Git LFS Setup - -To obtain large binary files for the repo such as the cache, make sure you have git lfs installed: https://git-lfs.github.com/ - -After setting up git lfs, you may need to run `git lfs pull` in the root of the cloned repo to download essential binaries. +**If at anytime you have an issue with GitLab please refer to the [GitLab help center](https://gitlab.com/help).** ### Prerequisites -* Java SE Development Kit Version 11/OpenJDK 11 (preferred) -* Xampp -## Prereq Installation - -

Windows

-
- - -1. Install JDK version 11 - * Scroll down until you see Windows x86 and Windows x64 - * If you are running a 64bit verison of Windows (standard), select Windows x64 - * Accept the terms and conditions, after reading them of course, and login to oracle - * Download and install like any normal application - -2. Install Xampp - * Click on "Xampp for Windows" - * Download - * Install as Administrator -
- -

MacOS

-
- - -1. Install JDK version 11 - * Scroll down until you see macOS x64 - * select macOS x64 - * Accept the terms and conditions, after reading them of course, and login to oracle - * Download and install like any normal mac application - -2. Install Xampp - * Click on "Xampp for OS X" - * Download - * Install as Administrator -
- -

Linux

-
- - -1. Install JDK version 11 through Oracle or through command line - * Debian, Ubuntu, etc. - ```sh - sudo apt install openjdk-11-jdk - ``` - * Fedora, Oracle Linux, Red Hat Enterprise Linux, etc. - ```sh - su -c "yum install java-11-openjdk" - ``` - -2. Install Xampp OR Set up DB server of your choice. - * Click install "XAMPP for Linux" - * Install like any normal Linux program -
+These are mandatory. If you don't install ***all*** of these programs prior to +the project's setup, things won't work. At all. +* [Eclipse Temurin JDK 11 (preferred)](https://adoptium.net) or the Java SE Development Kit Version 11 +* [Git LFS](https://git-lfs.github.com/) +* [IntelliJ IDEA Community](https://www.jetbrains.com/idea/download/) ### Project Setup -- Open Xampp (Skip if you roll your own database and know what you're doing.) - * On Windows make sure you run Xampp as administrator - * On the left-hand side make sure you tick the two "Service" boxes for Apache and MySQL - * For both Apache and MySQL click "Start" under Actions - * After doing that navigate to the PHP My Admin LOCAL SITE - * Once opened, on the left-hand side click the three "disks" that say "New" - * In the "Database name" bar type: global - * Press the "Create" button - * A three disk "global" should appear on the left hand side - * Click it and on the top bar select "Import" - * Under **FILE TO IMPORT** click "Browse...." - * Navigate to your 2009Scape project folder - * Go to Server/db_exports/ and import global.sql - * It may take a moment to import, when It is done importing Xampp is all set up! - +1. Open IntelliJ IDEA +2. Clone the project using the `Get from VCS` button. +3. Click the "Project" tab on the left-hand side. +4. In the top left where the "Project" drop down is, click Project Files +5. Expand the Server folder +6. Right click `pom.xml` and click "Add Maven Project" +7. In IntelliJ, File -> Invalidate Caches -> Invalidate Caches and Restart +8. After setting up Git LFS, you may need to run `git lfs pull` in the root of the cloned repo to download essential binaries +9. You should now have ready-made run configurations in the top right (you can ignore MS, it's obsolete): + * [Windows] Run Server + * [Linux] Run Server +10. Ensure your working directory (the root of the project) is set in the run configuration editor. +11. Go ahead and use the `Run Server` configuration for your OS to make sure everything worked. + ### Running the project + ***Note: If you choose not to use the provided run scripts, you *must* run `mvn clean` before it will build correctly.*** #### Linux / OSX -1. Make sure your database of choice is running (see above) -2. Start the game server with the included run script. E.G ./run g + +Start the game server with the included run script. Use `./run -h` for more info. #### Windows -1. Make sure your database is running (see above) -2. Start the Management Server with run-ms.bat -3. Start the game server with run-server.bat -### IDE Integration: IntelliJ IDEA (Recommended) -1. Click the "Project" tab on the left hand side. -2. In the top left where the "Project" drop down is, click Project Files -3. Expand the Management-Server folder -4. Right click pom.xml and click "Add Maven Project" -5. Expand the Server folder -6. Right click pom.xml and click "Add Maven Project" -7. In IntelliJ, File -> Invalidate Caches -> Invalidate Caches and Restart -8. You should now have ready-made run configurations in the top right: [Windows] Run MS, [Windows] Run Server, [Linux] Run MS, [Linux] Run Server -9. Go ahead and use the Run Server configuration for your OS to make sure everything worked. - -### IDE Integration: Eclipse -Note: This section could use improvement. If you have a better way to integrate the project with eclipse, feel free to open an MR! -1. Make sure you have the [Eclipse Maven Plugin](https://stackoverflow.com/a/25993960/1971003) installed. -2. In Eclipse, click File -> Import -3. Type Maven in the search box -4. Under "Select an Import Source," select "Existing Maven Project." -5. Next -6. Click browse, and select the Management-Server folder. -7. Repeat steps 2-6 for the Server folder. - -### IDE Integration: Netbeans -Note: This section could use improvement. If you have a better way to integrate the project with netbeans, feel free to open an MR! - -1. Select File -> Open Project -2. Select the Management-Server folder to open the MS project. -3. Select the Server folder to open the Server project. +Start the game server with `run-server.bat` ### License -We use the AGPL 3.0 license, which can be found here. Please read and understand the license. Failure to follow the guidelines outlined in the license will result in legal action. If you know or hear of anyone breaking this license, please send a report, with proof, to Red Bracket#8151, ceikry#2724, or woahscam#8535 on discord or email woahscam@hotmail.com. **We WILL NOT change the license to fit your needs.** +We use the AGPL 3.0 license, which can be found [here](https://www.gnu.org/licenses/agpl-3.0.en.html). Please be sure to read and understand the license. Failure to follow the guidelines outlined in the license will result in legal action. If you know or hear of anyone breaking this license, please send a report, with proof, to Red Bracket#8151, ceikry#2724, or woahscam#8535 on discord or email woahscam@hotmail.com. **We WILL NOT change the license to fit your needs.** ### Contact -

Reminder: There is no official support for setting up your own server. Do not ping/dm developers about setting up your server. Community support is available in the discord server.

+**Reminder: There is no official support for setting up your own server. Do not ping/dm developers, or ask in support channels about setting up your server. Support for the live server and 2009Scape single-player is available in the Discord.** [license-shield]: https://img.shields.io/badge/license-AGPL--3.0-informational [license-url]: https://www.gnu.org/licenses/agpl-3.0.en.html + +### Why become a tester? + +Before content hits Live, it has to be tested. We can, but do not want to do this alone, and would love the help! But don't worry, there is something in it for you. Credits! Keep in mind that credits will only be awarded to people who thoroughly test the content and provide detailed reports on them. Like votes or HoF you must claim them in the #claim-to-fame channel on discord or matrix. + +* If you test smaller things like bug fixes there is a 2 credit reward. +* If you test full quests or minigames you will be rewarded 5 credits. +* If you find a bug in the content you are testing that hasn't already been found you will earn an extra credit. + +These credits can be spent in the 2009Scape Reward Shop. It's important to be clear that credits are gained by contributions to the project. We cannot and will not accept donations (of any kind), especially not in exchange for in-game credits or perks. + +Testers are not the only people who can gain credits - other ways of earning credits can be found on [the 2009Scape website](https://2009scape.org/site/game_guide/credits.html). + +Please be patient! The Credit system is not fully complete yet, so it will take a long time for credits to be awarded.