novelscript

KO | EN

gitlite — search

#javascript #php #python #go #nodejs #r #ruby #metrics #ios #shell #java #c-plus-plus

★ 94 Open GitHub ↗

DOM visual novel renderer based on React (Currently under reconstruction)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# NovelScript
[![npm](https://img.shields.io/npm/v/novelscript.svg)](https://www.npmjs.com/package/novelscript)
![react](https://img.shields.io/npm/dependency-version/novelscript/react)
![npm](https://img.shields.io/npm/l/novelscript.svg)
[![Build Status](https://travis-ci.org/yinyanfr/NovelScript.svg?branch=master)](https://travis-ci.org/yinyanfr/NovelScript)
![Dependencies](https://img.shields.io/david/yinyanfr/novelscript)
![size](https://img.shields.io/github/repo-size/yinyanfr/novelscript)

**This project uses functional components, which requires the latest version of React with the Hook API (v16.8+)**

## A visual novel renderer based on React
```javascript
import {
  Scenario,
  Stage
}  from "./components/Nova"

const App = () => (
    <Scenario.Provider value={scenario}>
        <Stage onFinish={finish} />
    </Scenario.Provider>
)
```

- from simple script (<a href="https://github.com/yinyanfr/nsml">nsml</a>)
```nsml
[scene] start
[bgm] bgm1
[bg] classroom
[join] yuyao normal
[join] nanzhi normal
[animate] yuyao [move] 20 0 [zoom] 1.1
[animate] nanzhi [move] 20 0 [zoom] 0.9
[yuyao] 非洲农业不发达，必须要有金坷垃

[reset] yuyao nanzhi
[animate] nanzhi [move] -20 0 [zoom] 1.1
[animate] yuyao [move] -40 0 [zoom] 0.9
[nanzhi] 日本资源太缺乏，必须要有金坷垃
```
- to visual novels

![nanzhi](http://nova.yinyan.fr/nanzhi.jpg)

[Demo Site](http://nova.yinyan.fr)
## Get Started
```bash
$ npm start
```
or
```bash
$ yarn start
```

## Documentation

<a href="https://github.com/yinyanfr/NovelScript/tree/master/doc/legacy">点此查阅文档 Documentation</a> (Legacy)

## Roadmap

This project is now on its way of reconstruction. Further information will be added with progress.

novelscript

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README