# LemmeSmash

LemmeSmash is a Discord bot that lets you put placeholder tags in your messages and replaces your message, swapping the tags out for randomly generated keysmashes. Why would anyone want this? Beats me, but it's been requested so [click here to invite it!](https://discordapp.com/oauth2/authorize?client_id=578591056866836490&scope=bot&permissions=536995904) There's also a [support server](https://discord.gg/N5cBcp3) should you have any other questions, have a suggestion, or have a bug to report.

The bot uses configurable keysmash tags and generates ISO Standard keysmashes using the characters `asdfghjkl` by default, or from a set of custom characters you choose.

The bot also helps you on your adventures by letting you make a different set of tags that transforms your message into OwOspeak (or just automatically, per-server, if you want that).

The bot has five commands:

- `ks;tags`
- `ks;autoproxy`
- `ks;charset`
- `ks;show`
- `ks;help`

The bot explains all of these commands once you invite it.
`ks;help` is the first command you're likely to use, and it's *very* helpful
`ks;tags` is used to set your keysmash tags, both prefixes and suffixes are supported. The tags must be around the word `text`, i.e. `ks;tags $text` or `ks;tags [text]`.
`ks;autoproxy` just enables proxying of owospeak by default instead of having to set and use tags for it. Works per-server.

`ks;charset` is used to set your custom character set. The bot will remember this and use it each time you proxy a keysmash. Any letter, number or symbol is supported. Emoji are not supported as of yet.

`ks;show` simply shows your user info, your keysmash tags and your cuustom character set if you have one.

## Getting started!

1. Set a keysmash tag: `ks;tags #!text`
2. `[Optional]` Set a custom character set: `ks;charset asdfcvbn`
3. Post a message with your keysmash tags: `Here is a keysmash: #!`
Using a set of keysmash tags that you set, it will replace all instances of the tags with a randomly generated keysmash.
4. `[Bonus!]` You can also post a set of characters between your keysmash tags and the bot will use those to generate the keysmash instead: `Here is a one-time custom keysmash: #!sdjcbn`

----

## Running the bot yourself

The bot is written in JavaScript and uses a [MongoDB](https://www.mongodb.com/) database to store keysmash tags and custom character sets. It also takes a configuration file in JSON format that must be named `config.json`.

### With Docker

Running the bot is simple with Docker, this repository has a `docker-compose.yml` file ready to use:

1. Clone the repo: `git clone https://github.com/xBelladonna/LemmeSmash.git`
2. Create `config.json` in the same directory as `config-template.json` (see for the layout), and set bot token:
`cp config-template.json config.json`
3. Run the stack: `docker-compose up -d`

### Manually with Node.js

1. Clone the repo: `git clone https://github.com/xBelladonna/LemmeSmash.git`
2. Download and install dependencies: `npm install`
3. Create `config.json` in the same directory as `config-template.json` (see for the layout), and set bot token:
`cp config-template.json config.json`
4. Run a mongo database somewhere (i.e. localhost) and set the database URI in the config file (i.e. `mongodb://localhost`)
5. Run the bot: `npm start`

## Configuration

The bot uses a JSON file named `config.json` for configuration, the elements are explained below.

- `token` - Discord bot token from the [Discord Developer Portal](https://discordapp.com/developers/applications/)
- `db` - Database URI pointing to a mongoDB instance, formatted as `mongodb://ip:port/LemmeSmash`
- `defaultCharset` - The default set of characters the bot will use to generate keysmashes from
- `logChannel` - an optional element, the bot will post stack traces to this channel in case it encounters errors. Ensure this channel is private as Discord usernames and message contents are exposed here!
- `owner` - another optional element, takes a Discord Snowflake (user ID) as a string.
- `permissions` - this is an object containing all the permissions theh bot needs to work properly. You *can* remove some if you want but there's no guarantee the bot will work right. Uses standard discord.js flag notation, i.e. arrays as elements in on object.

----

## Dependencies

- `discord.js` >= 11.5.0
- `mongoose` >= 5.5.8

This project is under the Apache 2.0 Licence, found in `LICENCE`.


LemmeSmash

Generate keysmashes and transform your text into owospeak for you and your friends

Stemmen voor LemmeSmash

Wil je ons ondersteunen?