{"repo":"y-lohse/inkjs","free":true,"listed":false,"github":"https://github.com/y-lohse/inkjs","clone":"git clone https://github.com/y-lohse/inkjs.git","description":"A javascript port of inkle's ink scripting language.","language":"TypeScript","stars":648,"topics":["inkjs","story","game-development"],"license":"MIT","category":"game-templates","readme_excerpt":"This is a javascript port of inkle's ink, a scripting language for writing interactive narrative. inkjs is fully compatible with the original version, has zero dependency and works in all browsers and node.js. Please have a look at the demo! Table of content - - Table of content - Installation - Quickstart - Working with a JSON file - Using node.js - Loading inkjs - Loading a json file - Starting a story - Differences with the C# API - Getting and setting ink variables - Getting the output text when calling EvaluateFunction - Using TypeScript - Compiler - inkjs-compiler.js - online compiler - Differences with the C# Compiler - Compatibility table Installation Install using npm install inkjs . If you are not using npm you can grab the latest release directly from here. Simply include that file with a script tag and you'll be on your way! For projects targeting older browsers that have no support for ES2015 features, a (heavier but) more backward compatible version is also exposed. Grab it by either: - import ink from 'inkjs/dist/ink.js - Directly downloading the file from here Quickstart The simplest way to get started with inkjs is to use the serverless boilerplate in the templates folder. Replace the placeholder story in story.js with your own and open index.html ! Here's what happens behind the scenes: inkjs gives you access to a global object named inkjs which has a property called Story . This is the main class we interact with. We simply create a new story by calling var","default_branch":null,"files":null,"tree":[],"storefront":"/r/y-lohse","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/y-lohse/inkjs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}