Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 5.62 KB

README.md

File metadata and controls

73 lines (51 loc) · 5.62 KB
Raw

Important note Development of Novel.js has pretty much been halted. However, it's perfectly functional and has a lot of features. Feel free to use it for your projects! Pull requests are welcome.

Novel.js

Build Status Dependency Status devDependency Status GitHub release npm version npm npm

Novel.js is a versatile, lightweight JavaScript text game engine that works directly in the browser.

It is suitable for interactive fiction such as "choose your own adventure" games and other kinds of text-based entertainment. It also works well as a base for straightforward prose garnished with images and sounds. It requires only a novel.json file containing all the text, choices, items and so on, an html file to display the novel/game and optionally a stylesheet (skin.css), images and sounds.

Text adventures are often overlooked as something only game development beginners create, and Novel.js aims to fix this misconception. Interactive fiction combines the flexibility and possibilities that prose can offer with interactivity and reader choice – a type of entertainment I think has not yet been thoroughly explored. The popularity of visual novels demonstrates the possibilities the medium can offer!

Novel.js is written in JavaScript, HTML and SASS and has no dependencies (although Papa Parse is required for CSV support). It was born out of a need for a lightweight, easy-to-use but fully-featured text adventure system that could easily be embedded on a webpage. It is open source (MIT License) and free to use both commercially and non-commercially. A live demo is available, however it covers only a small part of all functionality!

You can use electron-noveljs-boilerplate with Novel.js to create standalone desktop applications. It requires a bit more technical knowledge than Novel.js itself.

Table of Contents

Features

  • A classic text-based adventure view; text and choices.
  • Conditional statements to hide or show text and choices based on different conditions, such as the items the player is carrying, allowing for complex logic.
  • Print values such as item counts or even text from other scenes.
  • Scrolling text! Many ways to customize it and execute logic during scrolling to allow for voice acting, mood setting, character specific styles etc.
  • An inventory system, with support for hidden items, item descriptions and multiple inventories!
  • Choices can have several different outcomes with different probabilities, loads of different customization options and can be chained to prevent repetition.
  • Play sound effects and looping music/ambient sound effects!
  • Shorthand tags for general styling of names etc. and presets to help with recurring styles.
  • Checkpoints to easily jump back and forth between scenes.
  • Saving the application state as a cookie or an encoded string that is given to the player.
  • Load text from text and CSV files and split novel.json into multiple files for easier management.
  • Translation support, both directly in novel.json and by using external CSV files.
  • Support for CSS styling, custom JavaScript and HTML tags in text.
  • ... And much more ~!

Installation

Non-techy installation

  1. Download the latest release .zip and extract it.
  2. Upload the folder to a web server. (Opening index.html locally does not work, as the browser cannot load json files locally!)
  3. Open the location in web browser. Check dev tools (usually F12) for logs.
  4. Start working on novel/novel.json!

Techy installation

  1. npm install novel-js.
  2. Create an index.html file and add <novel></novel> inside the body, or include the customizable HTML in it. Include the Novel.js (node_modules/novel-js/novel.min.js) script.
  3. Create a folder for your novel (novel is loaded by default, you may customize this with the src attribute of <novel>) and a novel.json inside it.
  4. http-server and open http://localhost:8080/ or use a web server of your choice.
  5. Start working on novel.json!

Getting Started

Novel.js comes with a simple example app that demostrates all available features. Located in the novel folder, novel.json is easily readable and editable in your favourite text editor, so you can start working on your masterpiece right away! For a complete explanation of all the different stuff you can find in that file, please see the documentation!

Documentation

See the separate documentation.

License

Novel.js is licensed under the MIT License. Copyright © Ville Talonpoika 2016