Installation

1. Install Java 17 or newer
2. Go to Deployments > Releases.
3. Download the correct archive for your OS
4. Unzip it into an empty directory
5. Run the start file (start.sh or start.bat)

Run in IDE

VSCode

1. Windows: Install git for windows
2. import the repository...

• Method 1
  1. Click the blue clone button
  2. Click "Visual Studio Code (HTTPS)
• Method 2
  1. Click the source control button on the sidebar
  2. Click clone repository
  3. Return to GitLab and click the blue clone button
  4. Copy the "Clone with HTTPS" link
  5. Paste the link into the VSCode popup

3. Click the run and debug button on the sidebar
4. Click "create launch.json" and open the file
5. Add the key "vmArgs" and put in the VM arguements for your OS

For example:

    "configurations": [
        {
            "type": "java",
            "name": "Driver",
            "request": "launch",
            "mainClass": "gui.Driver",
            "projectName": "GuitarHero",
            "vmArgs": "--module-path lib/linux --add-modules javafx.controls,javafx.fxml,javafx.media -Dprism.forceGPU=true"
        },

Do not forget the comma after the second to last item.

Eclipse

1. Click the search icon in the upper right corner
2. Search "git repositories" and select it
3. Click "Clone a git repository"
4. Return to GitLab and click the blue clone button
5. Copy the "Clone with HTTPS" link
6. Paste it into the URI box
7. Other information should fill in automatically, click next
8. Ensure that the Main branch is selected and click next
9. Change the directory to your eclipse workspace
10. Check "Import all existing Eclipse projects after clone finishes"
11. Click finish
12. Right click on project > Properties
13. Select Run/Debug Settings > Driver
14. Click Edit
15. Click the Arguments tab
16. Paste in the VM Arguements for your OS

Java VM Arguments

These are automatically run by the start files when installing from an archive.

Windows

--module-path lib/windows/lib --add-modules javafx.controls,javafx.fxml,javafx.media

Linux

--module-path lib/linux --add-modules javafx.controls,javafx.fxml,javafx.media -Dprism.forceGPU=true

Development Links

Figma link

JavaFX docs (with search)

javafx guides (really helpful website): edencoding.com