https://github.com/kovah/taboo-data

A data set for Taboo games. Plain JSON files which contain the keyword and some buzzwords like in the original Taboo game
https://github.com/kovah/taboo-data

data data-structures dataset datasets game game-resources taboo tabu

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/kovah/taboo-data
• Owner: Kovah
• License: gpl-3.0
• Created: 2018-07-30T15:03:28.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2023-10-24T12:49:42.000Z (about 1 year ago)
• Last Synced: 2024-10-07T13:36:23.386Z (3 months ago)
• Topics: data, data-structures, dataset, datasets, game, game-resources, taboo, tabu
• Language: PHP
• Homepage:
• Size: 206 KB
• Stars: 10
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
 

# Taboo-Data

 

![Current version](https://img.shields.io/github/release/kovah/taboo-data.svg?label=Latest%20Version) [![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/kovah/taboo-data/Testing/main?label=Build%20Status)](https://github.com/Kovah/Taboo-Data/actions) ![License](https://img.shields.io/github/license/Kovah/Taboo-Data.svg?label=License)

A data set for Taboo games. Plain JSON files which contain the keyword, and some buzzwords like in the original Taboo game. It was originally created for my [**Taboo browser game**](https://github.com/Kovah/Taboo).

Available languages: English, German

 

## Data Structure

All lists are structured by using a key > value based approach. This means that the array keys contain  the keyword like `Bear` and the array values contain the buzzwords, like `Grizzly, Honey, 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](https://github.com/Kovah/Taboo-Data/archive/master.zip) or use one of the following methods:

#### Javascript

```

npm install taboo-data

or

yarn add taboo-data

```

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

```javascript

import { TabooData } from 'taboo-data';

// Get all available languages, their categories and the category descriptions

const categories = TabooData.categories();

// Get the keywords for a specific category and language

const animals = await TabooData.getCategory('animals', 'de');

```

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:

```javascript

import * as 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 PHP:

```php