https://github.com/yinyanfr/novelscript

DOM visual novel renderer based on React (Currently under reconstruction)
https://github.com/yinyanfr/novelscript

Last synced: 20 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/yinyanfr/novelscript
• Owner: yinyanfr
• License: mit
• Created: 2015-03-28T16:04:51.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T01:45:35.000Z (almost 2 years ago)
• Last Synced: 2024-10-20T15:45:43.940Z (about 1 month ago)
• Language: JavaScript
• Homepage: http://nova.yinyan.fr
• Size: 6.29 MB
• Stars: 95
• Watchers: 11
• Forks: 14
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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 = () => (

    

        

    

)

```

- from simple script (nsml)

```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

点此查阅文档 Documentation (Legacy)

## Roadmap

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