Have ideas to improve npm?Join in the discussion! »

    taboo-data

    1.0.1 • Public • Published

    Taboo-Data

    Current version Downloads Build Status License

    A data set for Taboo games. Plain JSON files which contain the keyword and some buzzwords like in the original Taboo game.

    Data Structure

    All lists are structured by using a key > value based approach. This means that the array keys contain the keyword like Bär and the array values contain the buzzwords, like Grizzly, Honig, Pooh.

    Instead of having to parse all entries like before, you can now decode the whole file contents and directly use all entries out of the box.

    Usage

    You can use the data set by downloading it or use one of the following methods:

    Javascript

    npm install taboo-data --save
    or
    yarn add taboo-data
    

    Here's an example on how to use the package with Javascript:

    import TabooData from 'taboo-data';
     
    const categories = TabooData.categories();
    const animals = TabooData.getCategory('animals');

    Please notice that importing the whole TabooData dataset will bloat your Javascript files as all entries from all categories are loaded. To import single categories manually or asynchronously, you can call them on their own:

    import { cars } from 'taboo-data/src/data/de/cars';
     
    const data = cars;

    PHP

    composer require kovah/taboo-data
    

    Here's an example on how to use the package with Javascript:

    <?php
    use Kovah\TabooData;
     
    $categories = TabooData::getCategories();
    $cars = TabooData::getCategory('cars');

    Contributing

    Found a bug or typo? Have a feature request?

    Please open a new issue and explain what's wrong or what needs to be improved.

    Words

    To contribute words, just add them to the appropriate category and add at least 3-4 buzzwords.


    Taboo Data is a project by Kovah | Contributors

    Install

    npm i taboo-data

    DownloadsWeekly Downloads

    1

    Version

    1.0.1

    License

    GPL-3.0-or-later

    Unpacked Size

    188 kB

    Total Files

    28

    Last publish

    Collaborators

    • avatar