seraxis / lr2oraja-endlessdream

A featureful fork of beatoraja
https://github.com/seraxis/lr2oraja-endlessdream/releases
GNU General Public License v3.0
50 stars 12 forks source link

LR2oraja \~Endless Dream\~

Endless Dream is a community fork and drop-in replacement for beatoraja that integrates quality of life patches and new features not present in the upstream version of the game.

Based on LR2oraja, which is itself a fork with LR2 judges and gauges, Endless Dream aims to fix some of the outstanding issues with the upstream project while being a central place for modifications and extensions that may never be accepted by upstream.

Key Features

Downloads

Development builds are created for every commit and published as releases

Installing from scratch

If you don't have an existing beatoraja installation download the latest beatoraja-0.8.7 JRE bundled version, or choose a version yourself from the release page.

Building from source

A JDK 8 with javafx is required to build and run. Consider using liberica JDK Clone this repository with submodules

git clone --recurse-submodules git@github.com:seraxis/lr2oraja-endlessdream.git

Run the gradle wrapper for your operating system and specify your desired platform as a gradle system property

Windows:

.\gradlew.bat core:shadowJar -Dplatform=windows

Linux:

./gradlew core:shadowJar -Dplatform=linux

This task will create a jar located in dist/ that can be used with any working installation of the game.

Testing changes

Use of an IDE, such as Intellij, is recommended for working on Endless Dream.

The gradle core:runShadow task can be used to quickly test and debug changes made to the project.

Configure the runDir system property to point to a beatoraja install or leave blank to have it run in the assets folder

Windows:

.\gradlew.bat core:runShadow -Dplatform=windows -DrunDir="C:\beatoraja0.8.7"

Contributing

Please state the impact your changes will have on drop-in compatibility with an upstream beatoraja install.

TBD