Dev:Developing the mod

From Valkyrien Skies Wiki

You can contribute to Valkyrien Skies by making edits to the code and making pull requests to the main repository, due to the fact that the mod is open source.


Setting up your IDE

To start, open up IntelliJ IDEA. If you're using Windows, use Powershell. Also, make sure you're using a fresh clone of Valkyrien Skies.

The IntelliJ landing page
The IntelliJ landing page

Obtaining a copy of the project

  1. Go to the directory where you want to store the project.
  2. Type into your command line: git clone --recurse-submodules
  3. Type into your command line: cd Valkyrien-Skies
  4. Type into your command line: ./gradlew setupDecompWorkspace idea genIntellijRuns. You may have to wait for several minutes.
  5. Open IntelliJ IDEA and select Import Project
  6. Navigate to the directory where the project was stored - Valkyrien-Skies - and select it. Press OK.
  7. Open settings ( Ctrl + Alt + S ) and search for Annotation Processors.
  8. On the side, select the Gradle Imported tab. Check the Enable annotation processing box, and add lombok.launch.AnnotationProcessorHider$AnnotationProcessor to the list of Processor FQ Names
  9. Next, go to Build, Execution, Deployment > Build Tools > Gradle and make sure that Build and run using: IntelliJ IDEA is set.
  10. (Optional) if you are unfamiliar with git submodules you may also want to turn on git config submodule.recurse true
The Annotation Processors settings

Required Plugins

  1. Open up File > Settings > Plugins > Marketplace
  2. Install "Minecraft Development"
  3. Install "Lombok"
  4. Restart IntelliJ