RenJava

Visual novel game engine based off of RenPy built with JavaFX.

Community

Website (Not yet created), Discord (Not yet created), YouTube
HeroAdventure This an example project that is used for testing the framework.

Notice

As of build 0.1.x, the project is just a demo. You will not be able to create a fully functional game with the current state of the framework. I recommend using the experimental branch over the master branch when testing and demoing the framework. Thank you for using and exploring RenJava.

Updating

When updating to a newer version of RenJava it is recommended to delete default 'settings.properties' and 'build.info'. These files are located in the 'renjava' folder for your game directory. These files need to be reset before you distribute the game. RenJava will automatically re-create these files with newer settings and info.

Hero-Adventure-1.0
  addons
  game
  jdk
  logs
  renjava
  HeroAdventure-1.0-SNAPSHOT.jar
  start.bat
  start.sh

Project Requirements

Java-21 (You can typically download this within your IDE)
intellij or Eclipse
Maven (Might come with your IDE)

Application Requirements

The OS has to support Java 17 JDK.
MacOS not currently supported.

Updating Application

If a game has an update please delete the previous version. Make sure to transfer your saves before doing so. This is to prevent malicious attacks that come with having an old JDK installed onto your pc. Alternative you can just delete the jdk folder in the old version. As an author you should post this warning to your community for every update.

Getting started

Follow this guide to get an easy start. Also explore our wiki to learn more about te framework and all of its features.

Developers

View our api changes here.
Documentation can be found here.
If you are struggling with anything at all join our discord, and we will help.

Compile from source

There are different branches you can clone from; Master, Development, Experimental. Master is the stable branch, this is the recommended branch for cloning.

Development A.K.A. Experimental is the branch that has the latest untested features and bug fixes. Once the development branch is tested, it is merged with Master and a new build is released.

Download RenJava via clone or file.
Extract file and open RenJava with any IDE that supports Maven.
Run mvn clean install from the IDE or command line inside the root directory.

HackusatePvP/RenJava