https://github.com/solarlabyrinth/firebot-text-addons
Assorted text parsing scripts for things like pronouns, profanity, and tts word replacement.
https://github.com/solarlabyrinth/firebot-text-addons
Last synced: 8 months ago
JSON representation
Assorted text parsing scripts for things like pronouns, profanity, and tts word replacement.
- Host: GitHub
- URL: https://github.com/solarlabyrinth/firebot-text-addons
- Owner: SolarLabyrinth
- License: mit
- Created: 2024-12-30T23:23:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-03T05:38:04.000Z (over 1 year ago)
- Last Synced: 2025-05-20T06:11:20.318Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 212 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Firebot Text Addons
My utility functions for string manipulation in firebot.
## Installation
Copy the provided .js file from the releases tab into your firebot custom scripts folder. Then enable it in the settings.
## Provided Functions
- hasNonAscii[text] -> boolean
- hasConfusable[text] -> boolean
- cleanConfusables[text] -> text
- toConfusables[text] -> text
- hasProfanity[text] -> boolean
- replaceWords[text, metadata-key] -> text
- Replaces standalone usernames and @mentions in the provided text with the value contained in the user's metadata entry for the provided metadata-key.
- Also replaces any words present in the global script config. Info below.
- pronoun[they, username] -> text
## Pronouns
```
$pronoun[they, $username]
```
Uses the provided "they/them/their/theirs/themself" pronoun in the first argument to pick the user's specific pronoun for the grammatical case represented by that first argument.
Uses a user's primary pronoun from https://pr.alejo.io/. Should support all pronouns able to be set on that site. Defaults to the provided first argument if no pronoun is set.
|Macro|He Output|She Output|They/Default Output|
|-|-|-|-|
|$pronoun[they, $username]|he|she|they|
|$pronoun[them, $username]|him|her|them|
|$pronoun[their, $username]|his|her|their|
|$pronoun[theirs, $username]|his|hers|theirs|
|$pronoun[themself, $username]|himself|herself|themself|
|$pronoun[They, $username]|He|She|They|
|$pronoun[THEY, $username]|HE|SHE|THEY|
## Config
### Replacement Text (CSV)
A CSV file of words and their replacements. 2 columns per row. Column 1 is the word to replace. Column 2 is the word to replace it with.
#### Example:
To replace "hi" with "yo" and "large" with "small" enter this:
```
hi,yo
large,small
```
### Allowed Words
Profanity is detected via the npm obscenity package. It may flag more words then you want. This allows you to enter a comma separated list of words to allow in the profanity checker.
```
arse,turd
```