Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 2.19 KB

intellij_setup.md

File metadata and controls

52 lines (32 loc) · 2.19 KB

Setup Intellij IDEA

  1. Download and install Intellij IDEA Community Edition (not Ultimate)

  2. Create a File->New->Project from Version Control via:

    New Project from Version Control

  3. Enter the git url https://github.com/4rg0n/songs-of-syx-mod-example.git and "clone" the repository:

    clone

  4. Goto File->Project Structure and choose to download a JDK:

    JDK Project Structure

  5. Choose Version 1.8 and a Vendor of your choice and download it:

    JDK Download

  6. Check the README Prerequisite, for the correct game installation paths

  7. On the right hand side click on the M icon and doubleclick the maven validate command:

    Maven

  8. After that run the install command

Reading the games source code

In the project tree on the left-hand site, you will see External Libraries at the bottom. Under this you will find a "Maven" dependency called something like com.songsofsyx:songsofsyx:XX.XX.

There you can browse the game source code.

Running the game with the mod

There are three .xmlfiles in the .run/ folder:

  • Main launches the game directly
  • MainLaunchLauncher starts the game launcher
  • DEBUG starts the game with debug capabilities

You may want to edit the WORKING_DIRECTORYand anything in <classpathModifications> to your local game installation path. It's default set to: C:/Program Files (x86)/Steam/steamapps/common/Songs of Syx.

For the future: Your package name may also differ in the PATTERN option. It's default set to: your.mod.*

They should be automatically available in the IDE:

Run Commands

Run the game at first through the MainLaunchLauncher and enable the Example Mod in the launcher. Once the mod is enabled, you can skip the launcher by running the Main or DEBUG command.