diff --git a/Building & Running With IntelliJ.md b/Building & Running With IntelliJ.md index f250f71..eb835ee 100644 --- a/Building & Running With IntelliJ.md +++ b/Building & Running With IntelliJ.md @@ -2,12 +2,53 @@ - [Oracle JDK17](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) - [Latest IntelliJ](https://www.jetbrains.com/idea/download/) -```During / after importing meteor-client, ensure that the project SDK is using Oracle JDK17``` +**During / after importing meteor-client, ensure that the project SDK is using Oracle JDK17** -Import meteor-client as a Gradle project +# Setup Guide -The following default configurations are included in the project for use in IntelliJ immediately after importing the project: +## 1. Clone meteor-client as a Gradle project through version control +1. ### Open Intellij +2. ### Click the icon labeled `Get from VCS` + + ![VCS](images/getFromVcs.png) + + ## * If Git is already installed skip to step 1.4 + +3. ### Install `Git` if you have not installed it yet there should be a prompt to install it + + ![GIT](images/gitInstall.png) + +4. ### Fill in the `URL:` with the meteor client Url as specified in this picture below and set your `Directory:` + + ![URL](images/urlVcs.png) + +5. ### Click `Clone` and now wait for the indexing to finish + + ![CLONE](images/clone.png) ![INDEXING](images/indexing.png) + +## 2. Build/Run Meteor Client Project +### The following default configurations are included in the project immediately after cloning the project and the indexing has finished ![runConfigurations](images/runConfigurations.png) -Simply select your desired operation and press the play button to the right of the selected configuration! \ No newline at end of file +### To launch the client double click ![RUN](images/run.png) + +### **If all went well the client should now be launched** + +### If things didn't go so well and you are having some compilation errors here are a few things to check: + +* ### Make sure the project SDK version is set to 17 in the project structure + + ![Project Structure](images/projectStructure.png) + ![Java Version](images/jv.png) + + ### * You should have Java 17 installed if it doesn't appear in the list you can download it here + + ![Install Java](images/installJava.png) + +* ### Check that the gradle Java version is using the project SDK + + ![Gradle Java Version](images/settings.png) + ![Gradle Settings](images/gradleJava.png) + +# If you are still having problems after carefully going through these steps ask for help in the Discord. diff --git a/images/clone.png b/images/clone.png new file mode 100644 index 0000000..04248a1 Binary files /dev/null and b/images/clone.png differ diff --git a/images/getFromVcs.png b/images/getFromVcs.png new file mode 100644 index 0000000..c925c81 Binary files /dev/null and b/images/getFromVcs.png differ diff --git a/images/gitInstall.png b/images/gitInstall.png new file mode 100644 index 0000000..5ba8394 Binary files /dev/null and b/images/gitInstall.png differ diff --git a/images/gradleJava.png b/images/gradleJava.png new file mode 100644 index 0000000..5f66ac5 Binary files /dev/null and b/images/gradleJava.png differ diff --git a/images/indexing.png b/images/indexing.png new file mode 100644 index 0000000..bdc0b1a Binary files /dev/null and b/images/indexing.png differ diff --git a/images/installJava.png b/images/installJava.png new file mode 100644 index 0000000..92f0e23 Binary files /dev/null and b/images/installJava.png differ diff --git a/images/projectStructure.png b/images/projectStructure.png new file mode 100644 index 0000000..94340a4 Binary files /dev/null and b/images/projectStructure.png differ diff --git a/images/run.png b/images/run.png new file mode 100644 index 0000000..2aa093a Binary files /dev/null and b/images/run.png differ diff --git a/images/selectJava.png b/images/selectJava.png new file mode 100644 index 0000000..3727595 Binary files /dev/null and b/images/selectJava.png differ diff --git a/images/settings.png b/images/settings.png new file mode 100644 index 0000000..7bc0d44 Binary files /dev/null and b/images/settings.png differ diff --git a/images/urlVcs.png b/images/urlVcs.png new file mode 100644 index 0000000..a244320 Binary files /dev/null and b/images/urlVcs.png differ