diff --git a/docs/building/EclipseGuide.md b/docs/building/EclipseGuide.md index 5d20427..0d3305d 100644 --- a/docs/building/EclipseGuide.md +++ b/docs/building/EclipseGuide.md @@ -1,4 +1,4 @@ -### Eclipse Guide +# Eclipse Guide This document is a guide to configuring Eclipse IDE for developing Progressia. @@ -94,7 +94,7 @@ into 'Main Class' field. 5. In the 'Arguments' tab, put `${workspace_loc:Progressia}/run` into 'Working directory:' > 'Other' field. Replace `Progressia` with your name of the project. -Alternatively specify another location outside of the project's root directory. +Alternatively, specify another location outside of the project's root directory. 6. Click 'Apply' to save changes. Exit Run Configurations. Step 5 is required to specify that the game must run in some directory other than the project root, diff --git a/docs/building/IntelliJIDEAGuide.md b/docs/building/IntelliJIDEAGuide.md new file mode 100644 index 0000000..7ce7c4c --- /dev/null +++ b/docs/building/IntelliJIDEAGuide.md @@ -0,0 +1,44 @@ +# Intellij IDEA Guide + +This document is a guide to configuring Intellij IDEA for developing Progressia. + +## Setup + +### Downloading project + +Although the project may be downloaded manually or using git directly (as described in the +[Build Guide](BuildGuide.md)), it may be more convenient to use pre-installed Intellij IDEA Git extension. If you choose not to, skip the following subsection. + +#### Using Git Extension + +[Git extension](https://plugins.jetbrains.com/plugin/13173-git) is a git interface for Intellij IDEA. It is currently shipped with Intellij IDEA. + +1. Open Intellij IDEA welcome screen, click the 'Get from VCS' button. Alternatively, use 'File' menu > 'New' > 'Project From Version Control...'. +2. Insert `https://github.com/OLEGSHA/Progressia.git` in the 'URL' field. +3. Change the local repository path, if necessary, and click 'Clone'. + +### Creating a Run Configuration + +Run configurations are used by Intellij IDEA to specify how a project must be run. + +#### Using GUI shortcut + +1. In Project Explorer, open `ru.windcorp.progressia.client.ProgressiaClientMain`. +2. Press small green triangle button in code editor window. +3. In the drop-down menu, click 'Modify Run Configuration...'. +4. Append `\run` to the 'Working directory' field. Alternatively, specify another location outside of the project's root directory. +5. Click 'Apply' to save changes. + +#### Using 'Add Configuration' menu + +1. Click 'Add Configuration...'. +2. In 'Run/Debug Configurations', click 'Add new configuration' with the plus icon. +3. In the drop-down list, select 'Application'. +4. Enter the configuration name . +5. Select a JRE from the drop-down list. +6. Select the module whose classpath should be used to run the application: `Progressia.main`. +7. Enter `ru.windcorp.progressia.client.ProgressiaClientMain` in the 'Main Class' field. +8. Append `\run` to the 'Working directory' field. Alternatively, specify another location outside of the project's root directory. +9. Click 'Apply' to save changes. + +Step 8 is required to specify that the game must run in some directory other than the project root, which is the default in Intellij IDEA. \ No newline at end of file