Skip to content
A flexible Visual Novel engine/runtime that allows for cross platform visual novel development.
C++ Shell CMake PowerShell GLSL C Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
scripts Using a machine-setup shell script for ubuntu machines Oct 13, 2019
src Merge branch 'master' into feature/audio_v3 Oct 10, 2019
.editorconfig Adding a basic .editorconfig file. Aug 29, 2019
.gitattributes
.gitignore
CMakeLists.txt Updating NovelRTLib to export symbols on Windows Oct 21, 2019
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md Oct 3, 2019
Doxyfile.in
LICENCE.md
README.md Adding build status badges to the readme Oct 13, 2019
build.cmd Adding some build scripts to help automate the inner loop Oct 4, 2019
build.sh Adding some build scripts to help automate the inner loop Oct 4, 2019
generate.cmd Adding some build scripts to help automate the inner loop Oct 4, 2019
generate.sh Adding some build scripts to help automate the inner loop Oct 4, 2019
install.cmd Adding some build scripts to help automate the inner loop Oct 4, 2019
install.sh
novel-chan.png Added error handling for file not found. Removed totally-not-yuri-fro… Aug 29, 2019
novel-chan_doxy.png CMakeLists modifications Oct 6, 2019

README.md

NovelRT

NovelRT is a cross-platform, flexible Visual Novel and 2D game engine. It is aimed at designers and developers alike, however many of the designer tools and features we have on our roadmap have yet to be implemented.

Job Debug Status Release Status
Windows x64 Build Status Build Status
Ubuntu x64 Build Status Build Status

Discord

Current Features

Currently, NovelRT supports the following in its base form:

  • Graphics LLAPI
  • Audio LLAPI

Future & Immediate Improvements

Current features in development include:

  • C++ HLAPI
  • Lua 5.3 LLAPI
  • CoreCLR hosting
  • Ink narrative scripting language support

For information on Ink, check it out from here.

Getting Started with NovelRT

Currently there are no binary distributions of the engine as of yet, and we are still in our early alpha for almost everything. If you wish to attempt to build a basic visual novel with the existing C++ API, you must first git clone this repository and set up vcpkg, which you can find out more about here.

Our dependency list currently includes:

  • sdl2
  • sdl2-mixer
  • sdl2-image
  • Lua 5.3
  • glad
  • glm
  • freetype

The minimum CMake version required for this project is 3.13.

Example

Examples will be placed here when we have created some. In the meantime, we advise asking us directly on our discord (invite URL above and below).

Contributing

First off, if you want to contribute, thanks! Tickets that are not being resolved by the development team will be plainly marked as such via Help Wanted or something similar to that should it change. We also would greatly appreciate being reached out to via our discord to discuss what you could work on.

NovelRT and everyone contributing (this includes issues, pull requests, the wiki, Discord in all forms, etc.) must abide by our code of conduct, which can be found here. Instances of abuse, harrassment or otherwise unacceptable behaviour must either be reported to a NovelRT Discord via direct message or by contacting us via email at admin@novelrt.dev.

Licence

Copyright © Matt Jones and Contributors. Licensed under the MIT License (MIT). See LICENCE in the repository root for more information.

Questions?

You can reach us directly via our discord, or you can post your question as an issue on the appropriate repository (but honestly asking us directly might be easier).

You can’t perform that action at this time.