https://github.com/sustained/fladdermus
🦇 Riddle me this, riddle me that, who's afraid of the robot-bat?
https://github.com/sustained/fladdermus
discordjs discordjs-bot klasa typescript
Last synced: about 1 month ago
JSON representation
🦇 Riddle me this, riddle me that, who's afraid of the robot-bat?
- Host: GitHub
- URL: https://github.com/sustained/fladdermus
- Owner: sustained
- Created: 2020-01-16T21:00:45.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T05:16:45.000Z (over 3 years ago)
- Last Synced: 2025-04-05T18:52:12.502Z (about 1 year ago)
- Topics: discordjs, discordjs-bot, klasa, typescript
- Language: TypeScript
- Homepage:
- Size: 445 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Fladdermus
Fladdermus is my personal Discord bot. She's written in TypeScript, using Klasa which is built on top of discord.js.
## Introduction
The first few versions mostly related to language learning as that was my main interest at the times, so she could do things like:
- exercises relating to evaluating one's proficiency in a language
- conjugating verbs etc.
- looking up word in dictionaries, on Wiktionary etc.
- and so on
### Why "Fladdermus"?
Fladdermus is the Swedish word for bat and Swedish is my [L2](https://en.wikipedia.org/wiki/Second_language). :bat:
I don't particularly like bats (except Fladdermus) but it's just a fun word.
It roughly translates as "flapping mouse". I know, right?
### Why version 4?
I'm learning [Klasa](https://klasa.js.org/#/) to replace my old friend Commando and I decided to relearn [TypeScript](https://www.typescriptlang.org/) simultaneously, so... I needed a project.
### Where are versions 1 through 3?
Those repositories are private.
## Documentation
There are READMEs in every directory, which will give you a brief overview of what that directory contains.
The code will also be at least somewhat reasonably well-commented, so feel free to read the source.
## Installation
### Setup
```
cp .env.example .env # Copy the example dotenv file
code .env # Configure the bot in your editor of choice
```
#### Required environmental variables
- `NODE_ENV` - Either `development` or `production`
- `CLIENT_ID` - [The client ID of your Discord application](https://discordjs.guide/preparations/setting-up-a-bot-application.html)
- `OWNER_ID` - [The ID of your Discord user account](https://support.discordapp.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-)
- `TOKEN` - [The bot token for your Discord application's bot user](https://discordjs.guide/preparations/setting-up-a-bot-application.html)
### Install Dependencies
```
npm install
```
### Compilation
```
npm run build
```
### Running
```
npm run start
```