Developers

First Steps

Requirements

Please install:

• Java SE Development Kit 8 (http://www.oracle.com/technetwork/java/javase/downloads)
• IntelliJ IDEA Community Edition (https://www.jetbrains.com)
• Git (https://git-scm.com)
• Launch4J (to create exe) (http://launch4j.sourceforge.net)
• NSIS (to create installer) (http://nsis.sourceforge.net)

Setup

Open IntelliJ IDEA and change:

• File -> Settings: Path to git.exe
• File -> Project Structure: JDK home path
• Paths to Launch4J and NSIS in file build-jar.xml

Getting the Code

Check out the code from GitHub:

• Choose VCS -> Checkout from Version Control -> GitHub
• Project web URL is https://github.com/SarutaSan72/Yass.git
• In Project Structure -> Module -> Sources, mark these folders:
  • src = Sources
  • bin = Excluded
• In Tool Window -> Version Control -> Configure Ignored Files, add these folders to prevent committing them to the repository
  • bin
  • release

Building the project

The Yass module is contained in the src folder. Classes will be compiled to the bin folder. Then you can start the ant tasks jar/exe/installer to create the release files (in the release folder).

• Compile the classes with Build -> Make Project
• Choose View -> Tool Windows -> Ant Build
• Create exe/jar/installer

Good entry points for coding are

• YassMain.java
• YassActions.java
• YassProperties.java
• YassSheet.java
• YassTable.java

You can safely ignore YassPlayer.java, YassSong*.java and other player-related classes.