From 549f0239dfc30c6e8441ac7bb0ce2d00356a7ef4 Mon Sep 17 00:00:00 2001 From: ElnuDev Date: Sun, 21 May 2023 12:35:47 -0700 Subject: [PATCH] Create README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..deac2ee --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# renrs + +*(Work in progress 🚧)* + +renrs (name subject to change) is a visual novel and dialog engine written in Rust. It is fully compatible with [Ren'Py language `.rpy` scripts](https://www.renpy.org/doc/html/language_basics.html), letting you migrate easily. The core engine is logic only, so you are free to integrate it into whatever front-end framework or game engine you like. If you are creating a simple visual novel with no complex gameplay elements, you can use renrs's official GUI to have an all-in-one engine solution. If you want to use renrs as a dialog system in a full game engine, you can use renrs's official Godot integration. + +### Modules + +- **WIP** `renrs` is the core engine and Ren'Py script interpreter. +- **PLANNED** `renrs-gui` is a graphics layer for simple visual novels. +- **PLANNED** `renrs-editor` is a route viewer and theme editor for `renrs-gui`. +- **PLANNED** `renrs-godot` is an integration for Godot for more advanced projects. +- **PLANNED** `renrs-hub` is a launcher for visual novels made in `renrs-gui`. \ No newline at end of file