Documentation
Quick Start

Quick Start

NarraLeaf-React is easy to understand and use. This guide will help you create your first Visual Novel with NarraLeaf-React.

Create Your First Visual Novel

Now it's time to create your first Visual Novel with NarraLeaf-React.

Create a new React app

First, create a new React app using Create React App.

Navigate to the directory where you want to create your app and run the following command:

npx nlr-skeleton@latest my-project

This will create a new React app with NarraLeaf-React template.

Run the app

To preview the app, run the app using the following command:

npm run dev

You can visit http://localhost:3000 to see your first Visual Novel.

Congratulations! You've created your first Visual Novel with NarraLeaf-React.

You can edit the src/story.ts file to create your own story!

Next Steps

Now you've learned the basic concepts of NarraLeaf-React.

Basic Tutorial

You can start learning some basic functionalities of NarraLeaf-React.

Solutions

If you are looking for some solutions to common problems, you can start learning some solutions.

API Reference

If you are advanced developer or you are looking for API reference, you can start learning constructing the story using abstract classes.

Or start displaying the story using the player component.