npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

storyboard-lang

v0.0.1

Published

A scripting language for an experimental interactive fiction engine

Downloads

2

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

lazerwalkerlazerwalker

Keywords

Readme

Storyboard-lang

CI Status

Storyboard (name liable to change) is an experimental interactive fiction engine designed to enable narrative experiences in AR and other digital/physical hybrid environments.

This is a scripting language for Storyboard. It's designed to look similar to Ink, although there are a lot of differences based on how different the underlying engine's narrative model is.

Storyboard-lang is written in Ohm. This tool converts from storyboard-lang syntax into the JSON object format that the Storyboard engine reads.

The main Storyboard engine includes this project as a dependency. Unless you're hoping to actively hack on the compiler, you probably care about the main Storyboard repo rather than this one.

Language Reference

Erm, this is coming soon! The project is rather immature, so this may wait until the language itself is a bit less in flux.

The examples folder contains a few example .story files, as well as the corresponding JSON they are expected to compile down to. There are automated tests confirming their correctness, so even though things are fairly in-flux, the examples shouldn't be outdated as long as the test suite is passing.

Setup

This project is not yet published on npm, but it will be once things stabilize a bit.

For now:

  1. Clone this repo
  2. Fetch dependencies: yarn install
  3. Build the library: npm run build

dist/bundle.js will contain a library suitable for importing into your own Node project. The dist/types folder will contain TypeScript definition files as well.

Usage

This module exports a single parseString() function, which takes in a string of Ohm code and returns a JSON Story object (essentially an AST in a JSON format that the Storyboard runtime engine can understand). It also exports a bunch of TypeScript types, which are consumed by the Storyboard engine.

For those interested in the actual code: grammar.ohm contains the grammar, and index.ts contains the Ohm semantics that transform the AST into Storyboard-compatible JSON.

The spec folder also contains pretty detailed BDD-style tests, which may serve as a useful guide to intended functionality.

License

This project is licensed under the MIT license. See the LICENSE file for more info.

Contact

  • https://github.com/lazerwalker
  • https://twitter.com/lazerwalker