The visual novel project

A wacky story.

Screenshot

What is it?

Romanetool is an open-source project developed using Svelte and SvelteKit.

By writing a script using a custom syntax and providing your own assets, you can tell a story in the style of a visual novel. Afterwards, you can host this on your server (or just use it locally). Since everything is open source, you can completely change the UI or maybe add missing functionality specific to your story.

Each story is organized in a tidy folder, containing the script and all related assets. The game engine then reads this script to bring the story to life for the player.

While the project currently provides just one example scenario to help developers and writers understand the workflow, to add your own scenarios, you'll need to host your own instance of Romanetool.

How It Came To Be

Romanetool was created as a way to allow anyone to share stories that were once limited only to their imagination.

Credits

Some assets listed below are under third-party licenses (e.g., Creative Commons). The MIT license applies only to original code and content in this repository not these assets.

Sound effects

• Digital Audio Pack, Creative Commons CC0
• Intro music by Universfield

Example scenario assets

• Sherlock (Benedict Cumberbatch) – Fat Les (bellaphon) from London, UK, CC BY 2.0 https://creativecommons.org/licenses/by/2.0, via Wikimedia Commons (edited – removed background)
• Rimmer (Chris Barrie) – ...some guy, CC BY 2.0 https://creativecommons.org/licenses/by/2.0, via Wikimedia Commons (edited – removed background)
• Dr. Watson (Martin Freeman) – Harald Krichel, CC BY-SA 3.0 https://creativecommons.org/licenses/by-sa/3.0, via Wikimedia Commons, modified and distributed under the same license
• Poirot – original skin screenshot and edit by me

How to make custom scenarios

See Custom scenarios guide

Developing

first install dependencies

npm install

run:

npm run dev

build:

npm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.