diff --git a/README.md b/README.md index 6ae230395..93dbee146 100644 --- a/README.md +++ b/README.md @@ -91,28 +91,40 @@ There are many ways everyone can contribute! From the most seasoned programmers ### Prerequisites -These are mandatory. If you don't install ***all*** of these programs prior to +These are mandatory. If you don't install **all** of these programs **in order** 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 +*For Windows users* - Turn developer mode on first in Windows developer settings. + +* [Git](https://git-scm.com/) *Make sure to enable symbolic links during install* +* [JDK 11](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/) +### SSH setup + +1. [Set up a key if you don't have one (ed25519)](https://docs.gitlab.com/ee/user/ssh.html#generate-an-ssh-key-pair) +2. [Add your public key to your gitlab account](https://docs.gitlab.com/ee/user/ssh.html#add-an-ssh-key-to-your-gitlab-account) +3. [Verify you can connect to git@gitlab.com](https://docs.gitlab.com/ee/user/ssh.html#verify-that-you-can-connect) + ### Project Setup 1. Open IntelliJ IDEA -2. Clone the project using the `Get from VCS` button. +2. Clone the project using the `Get from VCS` button, make sure you use the SSH URL from the blue clone button on the fork you created during the GitLab setup step. 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" +6. Right click `pom.xml` and click "Add as Maven Project" 7. In IntelliJ, File -> Invalidate Caches -> Invalidate Caches and Restart + +*Skip step 8 if you've installed Git LFS before cloning.* 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 + * [Windows] follow step 11. * [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. +11. Configure IntelliJ to compile and run the server from [here](https://forum.2009scape.org/viewtopic.php?t=64-unknown-run-configuration-type-batchconfigurationtype-when-setting-up-server) +12. Go ahead and use the `Run Server` configuration (if available for your OS) to make sure it's working, or the maven `server [exec:java]` added with step 11 ### Running the project diff --git a/Server/.run/[Windows] Run Server.run.xml b/Server/.run/[Windows] Run Server.run.xml deleted file mode 100644 index fde052599..000000000 --- a/Server/.run/[Windows] Run Server.run.xml +++ /dev/null @@ -1,11 +0,0 @@ - - - - \ No newline at end of file