tablenest

Creates probability tables that expand references to other tables. Uses probable and does L-system/tracery-like expansion of references to other rules.

It can generate objects and arrays and handle references within those objects and arrays, not just strings.

Installation

npm install tablenest

Usage

The package exports two functions:

• Tablenest, which you use to construct tablenest functions that will convert grammars into table objects that will roll random results for you.

• r, which you use to mark parts of your grammar that have references that tablenest needs to resolve as it walks down your grammar tree.

  var { Tablenest, r } = require('../index');

  var tablenest = Tablenest({ random: Math.random });

  var bogTable = tablenest({ root: [[50, ractiveScene], [25, rinactiveScene]], activeScene: [ [ 40, r({ text: rplants, subtext: rnaturalEntity, intensity: rhighNumber }) ], [10, ranimalScene], [5, r{animalScene} {animalScene}], [10, 'Bubbles blurble through the mud.'] ], inactiveScene: [ [1, r{plants} {locationVerb} {location}.], [ 1, r{naturalEntity} {naturalEntityAction} {naturalEntityFieldOfInfluence}. ] ], highNumber: [[1, 1000], [1, 10000], [2, 99999], [4, 10000000]], animalScene: [[1, rA {animal} {animalAction} {animalAdverb}.]], plants: [[1, 'Vines'], [3, 'Lily pads'], [2, 'Wilted willows'], [4, 'Reeds']], locationVerb: [[1, 'sprawl'], [1, 'rest'], [2, 'lie'], [1, 'sit']], location: [ [2, 'on the murky water'], [3, 'all around'], [1, 'everywhere'], [1, 'under the mud'] ], naturalEntity: [ [1, 'The wind'], [2, 'A foul stench'], [1, 'Humidity'], [2, 'Warmth'] ], naturalEntityAction: [ [1, 'rises'], [2, 'blows'], [1, 'hangs'], [2, 'permeates'] ], naturalEntityFieldOfInfluence: [ [1, 'above the muddy surface'], [2, 'about'], [1, 'in the air'], [2, 'under the oppressive sun'] ], animal: [ [4, 'frog'], [1, 'toad'], [1, 'lizard'], [2, 'snake'], [1, 'swarm of leeches'], [1, 'cluster of flies'], [1, 'muskrat'], [1, 'alligator'], [1, 'komodo dragon'] ], animalAction: [ [2, 'stretches'], [1, 'feasts on a carcass'], [1, 'turns toward you'], [2, 'lies'], [1, 'dances'], [2, 'rises from the muck'], [2, 'sleeps'] ], animalAdverb: [ [3, 'languidly'], [1, 'frantically'], [1, 'sloppily'], [2, 'lazily'], [1, 'aggressively'], [1, 'erratically'], [1, 'quickly'], [2, 'casually'], [1, 'formally'] ] });

  console.log(bogTable.roll());

Output:

{ text: 'Lily pads', subtext: 'Warmth', intensity: 99999 }

TODO:

Another example:

var thingsTable = tablenest({
  root: [
    [1, '{triangularNumberArray}'],
    [4, [0, 'dog', '{birds}', '{arthropodObject}']]
  ],
  triangularNumberArray: [
    [1, [3, 6, 10, 15, 21, 28, 36]],
    [1, [45, 55, 66, 78]]
  ],
  birds: [
    [7, ['nuthatch', 'chickadee']],
    [2, ['crow', raven']],
    [1, ['owl', 'hawk']]
  ],
  arthropodObject: [
    [1, { name: 'crab', habitat: '{waterHabitat}' }],
    [4, { name: 'spider', habitat: 'land', spiderType: '{spiderType}' }]
  ],
  spiderType: [
    [3, 'banana'],
    [1, 'brown recluse'],
    [1, 'tarantula']
  ],
  waterHabitat: [
    [7, 'ocean'],
    [2, 'lake'],
    [1, 'river]
  ]
});

Also supports abbreviated entries. If you have a part of your table def in which there is only one entry, instead of writing

{
  root: [
    [
      1,
      r({
        image: r`literalSpinnerImages`,
        r: f((result, p) => 5 + p.roll(20)),
        duration: f((result, p) => `${0.2 + p.roll(10)}s`)
      })
    ]
  ],
  literalSpinnerImages: [
    [2, 'redFidgetSpinner'],
    [1, 'yellowFidgetSpinner']
  ]
}

you can write:

{
  root: r({
    image: r`literalSpinnerImages`,
    r: f((result, p) => 5 + p.roll(20)),
    duration: f((result, p) => `${0.2 + p.roll(10)}s`)
  }),
  literalSpinnerImages: [
    [2, 'redFidgetSpinner'],
    [1, 'yellowFidgetSpinner']
  ]
}

Tests

Run tests with make test.

License

The MIT License (MIT)

Copyright (c) 2016 Jim Kang

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.