2009Scape/Server
1
0
Fork 1
mirror of https://gitlab.com/2009scape/2009scape.git synced 2025-12-09 16:45:44 -07:00
Code Issues Projects Releases Packages Wiki Activity

Improved readme

Browse source 
Removed broken windows intellij server runner config
This commit is contained in:
DebbySaurus 2022-08-27 15:09:20 +00:00 • committed by Ryan
parent 556efda5c1
commit de8c3f695b
2 changed files with 18 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -91,28 +91,40 @@ There are many ways everyone can contribute! From the most seasoned programmers
### Prerequisites ### 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. 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/) * [Git LFS](https://git-lfs.github.com/)
* [IntelliJ IDEA Community](https://www.jetbrains.com/idea/download/) * [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 ### Project Setup
1. Open IntelliJ IDEA 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. 3. Click the "Project" tab on the left-hand side.
4. In the top left where the "Project" drop down is, click Project Files 4. In the top left where the "Project" drop down is, click Project Files
5. Expand the Server folder 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 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 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): 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 * [Linux] Run Server
10. Ensure your working directory (the root of the project) is set in the run configuration editor. 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 ### Running the project

11
Server/.run/[Windows] Run Server.run.xml
View file

@ -1,11 +0,0 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="[Windows] Run Server" type="BatchConfigurationType" factoryName="Batch">
<option name="INTERPRETER_OPTIONS" value="" />
<option name="WORKING_DIRECTORY" value="" />
<option name="PARENT_ENVS" value="true" />
<module name="" />
<option name="SCRIPT_NAME" value="./run-server.bat" />
<option name="PARAMETERS" value="" />
<method v="2" />
</configuration>
</component>