diff options
Diffstat (limited to 'README.md')
| -rwxr-xr-x | README.md | 65 |
1 files changed, 1 insertions, 64 deletions
@@ -11,74 +11,11 @@ Goals: Notes: - Level creation flow is incomplete - no way to set lastbeat - - notes editor does not write to file - no validation - Everything else in this readme is outdated # Installation -1. Install Java 17 or newer -1. Go to Deployments > Releases. -1. Download the correct archive for your OS -1. Unzip it into an empty directory -1. Run the start file (start.sh or start.bat) - -# Run in IDE -## VSCode -1. Windows: Install git for windows -1. import the repository... -- Method 1 - 1. Click the blue clone button - 1. Click "Visual Studio Code (HTTPS) -- Method 2 - 1. Click the source control button on the sidebar - 1. Click clone repository - 1. Return to GitLab and click the blue clone button - 1. Copy the "Clone with HTTPS" link - 1. Paste the link into the VSCode popup -3. Click the run and debug button on the sidebar -1. Click "create launch.json" and open the file -1. Add the key "vmArgs" and put in the [VM arguements](https://gitlab.sowgro.net/npeinc/npehero#java-vm-arguements) for your OS - -For example: -```json - "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" -1. Return to GitLab and click the blue clone button -1. Copy the "Clone with HTTPS" link -1. Paste it into the URI box -1. Other information should fill in automatically, click next -1. Ensure that the Main branch is selected and click next -1. Change the directory to your eclipse workspace -1. Check "Import all existing Eclipse projects after clone finishes" -1. Click finish -1. Right click on project > Properties -1. Select Run/Debug Settings > Driver -1. Click Edit -1. Click the Arguments tab -1. Paste in the [VM Arguements](https://gitlab.sowgro.net/npeinc/npehero#java-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` +Coming soon. # Development Links |