Giter VIP home page Giter VIP logo

riscript's Introduction

ci tests npm version license GitHub code size in bytes

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 riscript
    let { 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

 

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!

Financial Contributors

riscript's People

Contributors

dhowe avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.