{"id":24147660,"url":"https://github.com/hackusatepvp/renjava","last_synced_at":"2025-09-19T15:32:34.562Z","repository":{"id":238734283,"uuid":"672192130","full_name":"HackusatePvP/RenJava","owner":"HackusatePvP","description":"Visual Novel game engine inspired by RenPy.","archived":false,"fork":false,"pushed_at":"2025-01-03T05:40:03.000Z","size":1167,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-03T06:25:16.577Z","etag":null,"topics":["game-engine-framework","javafx","visual-novel-engine"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HackusatePvP.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-29T08:20:26.000Z","updated_at":"2024-12-18T10:44:19.000Z","dependencies_parsed_at":"2024-11-20T04:17:40.841Z","dependency_job_id":"ae9b50a5-9aec-4268-b895-5349feb7783d","html_url":"https://github.com/HackusatePvP/RenJava","commit_stats":null,"previous_names":["hackusatepvp/renjava"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HackusatePvP%2FRenJava","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HackusatePvP%2FRenJava/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HackusatePvP%2FRenJava/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HackusatePvP%2FRenJava/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HackusatePvP","download_url":"https://codeload.github.com/HackusatePvP/RenJava/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233575034,"owners_count":18696540,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["game-engine-framework","javafx","visual-novel-engine"],"created_at":"2025-01-12T07:16:01.116Z","updated_at":"2025-09-19T15:32:34.548Z","avatar_url":"https://github.com/HackusatePvP.png","language":"Java","readme":"# RenJava\nVisual novel game engine based off of [RenPy](https://www.renpy.org/) built with [JavaFX](https://openjfx.io/).\n\nThis is a passion project, which means I'm learning as I go. There are a lot of mistakes and bugs which will be addressed eventually. This is not meant for production.\n\n**Community**\n- [Website]() (Not yet created), [Discord]() (Not yet created), [YouTube]()\n- [RSDK-GUI](https://github.com/HackusatePvP/rsdk-gui) All-in-one utility for creating RenJava projects.\n- [renjava-template](https://github.com/HackusatePvP/renjava-template) This is the maven template to get started.\n\n## Disclaimer\nRenJava does not claim ownership over any copyrighted material such as music, video, or assets. RenJava is only the framework not the game made by an author.\nAny copyright claims must be filed against the author. RenJava does not own or distribute any game(s). It would be similar to suing YouTube because someone else uploaded an entire move without permission.\n\nAs an author you must have expressed consent to use any copyrighted material like music. Alternatively, you could look for royalty free options.\n\n## Project Requirements\n- [Java-21](https://www.oracle.com/java/technologies/downloads/#java21) (You can typically download this within your IDE)\n- [intellij](https://www.jetbrains.com/idea/download/?section=windows) or [Eclipse](https://www.eclipse.org/downloads/)\n- [Maven](https://maven.apache.org/download.cgi) (Might come with your IDE)\n- [RSDK](https://github.com/HackusatePvP/RenJavaSDK/releases) (Download the .jar file in the latest release. This is a hard requirement.)\n\n## Application Requirements\n- The OS has to support Java 21 JDK.\n- The OS is supported.\n- 4GB RAM\n- 512MB VRAM\n- Dual Core CPU\n\n## Compile from source\nThere are different branches you can clone from; Master, Experimental. Master is the stable branch, this is the recommended branch for cloning.\n\nExperimental 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.\n- Download RenJava via clone or file.\n- Extract file and open RenJava with any IDE that supports Maven.\n- Run `mvn clean install` from the IDE or command line inside the root directory.\n\n## Getting started\nFollow this [guide](https://github.com/HackusatePvP/RenJava/wiki/Getting-Started) to get an easy start. You can use the [renjava-template](https://github.com/HackusatePvP/renjava-template) to get started or use [HeroAdventure](https://github.com/HackusatePvP/HeroAdventure). Also explore our [wiki](https://github.com/HackusatePvP/RenJava/wiki) to learn more about the framework and all of its features.\n\n## Notice\nAs 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.\nI recommend using the experimental branch over the master branch when testing and demoing the framework. Thank you for using and exploring RenJava.\n\n### Limitations\nThe framework only supports imagery. You will not be able to add sprites or other forms of 2D animation/modeling. ~~Video scenes are currently in the works, and you will soon be able to add pre-rendered animations in a form of a video file.~~ This limitation is not permanent but there are no future plans to currently add support for integrated animations.\nThe framework will never support 3D games. \n\n### Linux\nLinux has entered testing and as of now the only distro that will see support is Debian. If you are wanting to use or support other distros, the framework should still work. Similar to mac, you will need to manually download the proper java version and use the java command.\nLinux will have two installation methods `install_linux_64.sh` and `install_linux_local_64`. The `start_linux.sh` will automatically install java if it's not already installed, and launch the game.\n\nWhen running RSDK the linux tar file will no longer be downloaded, instead the .deb file will be.\nTo install the .deb file manually use the following commands. You will have to run the newest version of RSDK first to download the .deb file. You can also download it from [amazon](https://docs.aws.amazon.com/corretto/latest/corretto-21-ug/downloads-list.html)\nKeep in mind, the above scripts will automatically do this.\n```bash\nsudo apt install ./jdk/linux/amazon-corretto-21-x64-linux-jdk.deb\n```\n\n### Other/Un-supported OS\nYou can use the framework on most systems, as long as that system can render a desktop. The system will also have to support Java 21.\nYou can view all supported systems on [amazon-corretto](https://docs.aws.amazon.com/corretto/latest/corretto-21-ug/downloads-list.html) which is the JDK I use.\n\nWarning: RenJava is primarily tested on Windows/Linux (Debian). Just because the system can support the framework, does not mean the framework is optimized or functional on that system.\nIf you have issues you will have to figure it out on your own. All of this is subjected to change and more os's may get full support later.\n\n## Updating Framework\nWhen updating to a newer version of RenJava it is recommended to delete default 'settings.properties' and 'build.info'.\nThese files are located in the 'renjava' folder for your game directory. These files need to be reset before you distribute the game.\nRenJava will automatically re-create these files with newer settings and info.\n\n```\nHero-Adventure-1.0\n  addons\n  game\n  jdk\n  logs\n  renjava\n  HeroAdventure-1.0-SNAPSHOT.jar\n  start.bat\n  start.sh\n```\n\n## Developers\n- View our api changes [here]().\n- Documentation can be found [here](https://github.com/HackusatePvP/RenJava/wiki).\n- If you are struggling with anything at all join our discord, and we will help.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackusatepvp%2Frenjava","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhackusatepvp%2Frenjava","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackusatepvp%2Frenjava/lists"}