talkshitgetdared/README.md

The truth will hurt. An open-source cursed-core engine for Truth & Dare prompts.

# TalkShitGetDared 💀

[![npm version](https://img.shields.io/npm/v/talkshitgetdared.svg?style=flat-square)](https://www.npmjs.com/package/talkshitgetdared)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
[![Build Status](https://img.shields.io/github/actions/workflow/status/kyrexiii/TalkShitGetDared/ci.yml?branch=main&style=flat-square)](https://github.com/kyrexiii/TalkShitGetDared/actions)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue.svg?style=flat-square)](https://www.typescriptlang.org/)

A dangerously cursed, zero-dependency TypeScript package for all your Truth or Dare needs.  
Perfect for bots, APIs, party games, emotionally unstable couples, and Discord servers with too much time on their hands.

> **Warning:** Use responsibly... or don’t. I’m not legally responsible if your relationship ends (again).

---

## 📚 Documentation

For detailed documentation, API references, and advanced usage, visit:
👉 **[haruka.lol/projects/TalkShitGetDared](https://haruka.lol/projects/TalkShitGetDared)**

---

## 🔥 Features

**TalkShitGetDared** is a JSON-fueled chaos engine packed with:

- 🎭 **380+ Prompts:** Truths that hurt and dares that might get you arrested.
- 🌍 **Multi-Language Support:**
  - 🇺🇸 **English** (SFW + NSFW)
  - 🇪🇸 **Spanish** (SFW + NSFW)
  - 🇮🇳 **Hinglish** (SFW + NSFW) _(New!)_
- 🔞 **Dual Modes:** Safe for Work (SFW) and Not Safe for Work (NSFW).
- 🎯 **Advanced Filtering:** Filter by difficulty (`easy`, `medium`, `hard`, `extreme`) and category.
- 📦 **Batch Operations:** Get multiple unique prompts in a single call.
- 🚫 **Deduplication:** Optional history tracking to prevent repeating prompts.
- 🛠️ **CLI Tool:** Run truth or dare directly from your terminal.
- ⚡ **Zero Dependencies:** Lightweight and fast.

---

## 🚀 Installation

```bash
npm install talkshitgetdared
```

or if you prefer other package managers:

```bash
pnpm add talkshitgetdared
# or
yarn add talkshitgetdared
```

---

## 💻 Usage

### Library Usage

```typescript
import { 
  getTruth, 
  getDare, 
  getRandom, 
  getBatch 
} from 'talkshitgetdared';

// 🎲 Get a random truth
const truth = getTruth();
console.log(truth.prompt.text);

// 😈 Get a specific dare
const dare = getDare({ 
  mode: 'nsfw', 
  difficulty: 'hard',
  language: 'english' 
});
console.log(dare.prompt.text);

// 📦 Get a batch of 5 unique SFW prompts
const batch = getBatch({ 
  count: 5, 
  mode: 'sfw',
  ensureUnique: true 
});
console.log(batch.prompts.map(p => p.prompt.text));
```

### CLI Usage

You can use the CLI directly without installing via `npx`:

```bash
# Get a random truth
npx talkshitgetdared truth

# Get a NSFW dare
npx talkshitgetdared dare --mode nsfw

# Get a Hinglish prompt
npx talkshitgetdared random --language hinglish

# View library statistics
npx talkshitgetdared stats
```

---

## 📂 Project Structure

```
src/
├── data/           # Prompt data files (JSON/TS)
│   └── lang/       # Organized by language/mode
├── lib/            # Core logic
│   ├── core/       # Main entry point
│   ├── services/   # Business logic services
│   └── types/      # TypeScript definitions
└── cli.ts          # CLI implementation
```

---

## 🤝 Contributing

Want to contribute your cursed prompts?  
Fork it, PR it, or write them on a napkin and throw it into the ocean. If it floats back to me, I’ll probably add it.

Check out the [Contributing Guidelines](CONTRIBUTING.md) for more details.

---

## ⚠️ Emotional Disclaimer

This package will not fix your situationship, improve your friendships, or help you get your ex back.  
It *might*, however, destroy all three at once.

I will **not** be attending your therapy session.

---

## 📄 License

MIT — do literally anything. Just don’t sue me if your friends block you.

[View License](./LICENSE.txt)