riscript
v1.1.1
Published
generative language scripting
Downloads
297
Readme
RiScript: a scripting language for writers
RiScript is a minor language designed for writers working in computational media. It runs in a variety of environments, including the browser, Node, Observable, P5.js, Android and others. RiScript primitives (choices, symbols, gates, transforms, etc) can be used as part of any RiScript grammar or executed directly using evaluate(). RiScript is free/libre/open-source and integrates with RiTa.
For more documentation and examples see this interactive notebook on observable.
Installation
- For esm:
import { RiScript } from "https://esm.sh/riscript"; - For browsers:
<script src="https://unpkg.com/riscript"></script> - For node:
$ npm install riscriptlet { RiScript } = require('riscript'); - For developers
Example
import { RiScript } from "https://esm.sh/riscript";
let script = "[#name=[Jane | Bill]] was from [#place=[New York | Berlin]]."
+ " $name finds $place cold and wet in winter.";
let result = RiScript.evaluate(script);
console.log(result);Developing
To install/build the library and run tests:
$ git clone https://github.com/dhowe/riscript.git
$ cd riscript
$ npm install
$ npm run build
$ npm test
If all goes well, you should see a list of successful tests and find the library built in 'dist'
Please make contributions via fork-and-pull - thanks!
About
- Author: Daniel C. Howe
- Tutorial: https://observablehq.com/@dhowe/riscript
- Github Repo: https://github.com/dhowe/riscript
- Issues: https://github.com/dhowe/riscript/issues
- Reference: https://rednoise.org/rita/reference
- RiTa Web: https://rednoise.org/rita
Quick Start
A simple browser sketch
Create a new file on your desktop called 'test.html' with the following lines, save and drag it into a browser:
<html>
<script src="https://unpkg.com/riscript"></script>
<script>
window.onload = function () {
let script = "[#name=[Jane | Bill]] was from [#place=[New York | Berlin | Shanghai]]."
+ " $name finds $place cold and wet in winter.";
let html = RiScript.evaluate(script);
document.getElementById("content").innerHTML = html;
};
</script>
<div id="content" width=200 height=200></div>
</html>An ESM browser sketch
Create a new file on your desktop called 'test.html' with the following lines, save and drag it into a browser:
<html>
<body>
<div id="content" width=200 height=200></div>
<script type="module">
import { RiScript } from "https://esm.sh/riscript";
let script = "[#name=[Jane | Bill]] was from [#place=[New York | Berlin | Shanghai]]."
+ " $name finds $place cold and wet in winter.";
let html = RiScript.evaluate(script);
document.getElementById("content").innerHTML = html;
</script>
</body>
<html>With p5.js
Create a new file on your desktop called 'test.html' with the following lines,, save and drag it into a browser:
<html>
<script src="https://unpkg.com/p5"></script>
<script src="https://unpkg.com/riscript"></script>
<script>
function setup() {
createCanvas(600,200);
background(245);
textAlign(CENTER)
textSize(18);
let script = "[#name=[Jane | Bill]] was from [#place=[New York | Berlin | Shanghai]]."
+ " $name finds $place cold and wet in winter.";
let result = RiScript.evaluate(script);
text(result, 300, 100);
createButton("refresh").mousePressed(() => location.reload());
}
</script>
</html>With node.js and npm
To install: $ npm install riscript
let { RiScript } = require('riscript');
let script = "[#name=[Jane | Bill]] was from [#place=[New York | Berlin | Shanghai]]."
+ " $name finds $place cold and wet in winter.";
let result = RiScript.evaluate(script);
console.log(result);
Contributors
Code Contributors
This project exists only because of the people who contribute. Thank you!