MINECRAFT MOD

First create a folder where you will clone the repo.

Java Installation

For Windows

1. Download Openjdk17 https://jdk.java.net/17/.
2. Extract the file.
3. Create a folder in C:\Program Files\Java\
4. Move the jdk-17.0.1.jdk file into the folder
5. Set the path (for windows)
   • Select Control Panel and then System.
   • Click Advanced and then Environment Variables.
   • Select path -> edit -> New -> browse -> jdk-17.0.1.jdk -> bin
6. Set correct version of Java in your preferred IDE

For Mac (Using Homebrew and Jenv)

1. Download Openjdk17 https://jdk.java.net/17/.
2. Open Terminal
3. Go to folder where jdk17 is cd <where you have downloaded OpenJDK17>
4. Move folder to /Library/Java/JavaVirtualMachines/ sudo mv jdk-17.0.1.jdk /Library/Java/JavaVirtualMachines/
5. Close and reopen terminal
6. Install home brew /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
7. Install Jenv brew install jenv
8. Check if you have bash or zsh do echo $SHELL.

Bash

• echo 'export PATH="$HOME/.jenv/bin:$PATH"' >> ~/.bash_profile
• echo 'eval "$(jenv init -)"' >> ~/.bash_profile

Zsh

• echo 'export PATH="$HOME/.jenv/bin:$PATH"' >> ~/.zshrc
• echo 'eval "$(jenv init -)"' >> ~/.zshrc

9. Add to Jenv jenv add /System/Library/Java/JavaVirtualMachines/jdk-17.0.1.jdk/Contents/Home
10. jenv versions
11. Go to folder where you will be storing your git repos on your machine
12. jenv local 17
13. Check version of java in that directory java -version

For Mac (Manually setting the path) https://knasmueller.net/how-to-install-java-openjdk-17-on-macos-big-sur

1. Follow steps in link but for setting the path do the following depending on what your computer uses.
2. Check if you have bash or zsh do echo $SHELL.

Bash

• echo -n "\nexport JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk-17.0.1.jdk/Contents/Home" >> ~/.bash_profile

Zsh

• echo -n "\nexport JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk-17.0.1.jdk/Contents/Home" >> ~/.zshrc

Git Installation (Only for Windows)

1. Install git for windows https://git-scm.com/downloads
2. Control panel -> Systems and security -> System -> Advanced System settings -> Advanced -> environment variables -> Select path -> edit -> New -> browse -> git folder -> bin

Clone the Repository

(Alternatively you could use Git Desktop to manage your repo but the follow instructions are for commandline prompts)

1. Use commandline and go inside your git folder
2. git clone https://github.com/Featherdusk9/MinecraftMod.git
3. cd MinecraftMod
4. git checkout -b <name>-dev for example git checkout -b vib-dev This creates a new branch
5. git pull to make sure the branch is up to date
6. You can use git branch to see all the branches you have on your local machine
7. You can use git status to see any changes that have been made to files

To Push Changes

1. git status to see your changes
2. git add . to add all your changes
3. git commit -m "<your message>" to commit your changes
4. git push origin <name of your local branch> to push changes
5. Go to Git on the web and create a pull request
6. Add one reviewer to look over what changes you've made
7. Merge after reviewed
8. Notify others to pull when master has been changed

Setting up and Building

1. First before adding project to IDE go to command line
2. Go to folder where MinecraftMod is
3. If on Windows
   • gradlew gen<name of IDE>Runs for example (gradlew genEclipseRuns) (gradlew genIntellijRuns) (gradlew genVSCodeRuns)
4. If on Mac
   • ./gradlew gen<name of IDE>Runs for example (./gradlew genEclipseRuns) (./gradlew genIntellijRuns) (./gradlew genVSCodeRuns)
5. If using Eclipse do gradlew eclipse or ./gradlew eclipse

Eclipse https://www.eclipse.org/downloads/

1. When first launching Eclipse: Java 11 + Vm should be 17.0.1
2. Go to Preferences -> Java -> Installed JREs
3. Make sure it is set to a version of Java 17
4. Import Project
5. gradle -> existing project -> Browse folder
6. Find the folder of MinecraftMod
7. next -> Override workspace settings
8. Make sure Gradle Wrapper is selected
9. Select Java home -> browse -> your folder that java 17 is stored in
10. Make sure preview loads so that it means that no errors will occur

11. Finish
12. Go to run configurations
13. Click on Java Application
14. To run program select runClient

Intellij https://www.jetbrains.com/idea/download/#section=windows

1. Open and browse for MinecraftMod folder
2. If prompted select Gradle Project
3. Right Click Project and select Project Structure
4. Make sure Project SDK is some version of Java 17

5. To run the project select runClient which should be already set up in the top right corner

VSCode https://code.visualstudio.com/download

1. Get Java Extension Pack
2. Open and browse for MinecraftMod folder
3. Confirm the version of Java used in VSCode
4. Run without debugging to run program