Skip to content

Latest commit

 

History

History
57 lines (34 loc) · 1.24 KB

README.md

File metadata and controls

57 lines (34 loc) · 1.24 KB
Raw

NarraLeaf-React

English | 简体中文

A React visual novel player framework

What is NarraLeaf-React?

NarraLeaf-React is a lightweight front-end visual novel player.
NL focuses on visual novel playing, so the user interface can be customized very easily.

It doesn't use any rendering libraries and can be used on any web platform (e.g. Electron)

Why NarraLeaf-React?

  • Lightweight: NarraLeaf-React is a front-end framework, and it doesn't use any rendering libraries.
  • Customizable: You can customize the UI as you like, even replace the whole components.
  • Easy to use: It is easy to use and has a simple API that is built for developers. Based on OOP principles.

Get Started

Install

npm install narraleaf-react

Documentation

Read more in 🛠React.NarraLeaf.com

Example

npx create-react-app nlr-app --template my-first-narraleaf-app

to start

npm start

License

NarraLeaf-React is licensed under the MPL-2.0 License.

We updated the license to MPL-2.0 on 2024-9-24.

Contributing

We welcome all contributions.
If you have any ideas, just open an issue or a pull request.