Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tatupesonen/formatbot
A bot to format code inside code blocks on Discord
https://github.com/tatupesonen/formatbot
Last synced: about 1 month ago
JSON representation
A bot to format code inside code blocks on Discord
- Host: GitHub
- URL: https://github.com/tatupesonen/formatbot
- Owner: tatupesonen
- License: gpl-3.0
- Created: 2021-07-31T18:34:48.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2024-08-25T20:14:06.000Z (4 months ago)
- Last Synced: 2024-08-25T21:52:57.786Z (4 months ago)
- Language: TypeScript
- Homepage: https://tatupesonen.github.io/formatbot
- Size: 3.17 MB
- Stars: 29
- Watchers: 2
- Forks: 7
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- starred - tatupesonen/formatbot - A bot to format code inside code blocks on Discord (TypeScript)
README
FormatBot
[](https://github.com/tatupesonen/formatbot/actions/workflows/test.yml)
Formats the code blocks of a message using Discord context menus.
# Currently supported languages
- C
- C++
- C#
- Java
- Rust
- TypeScript
- JavaScript
- Python
- JSON
- YAML
- HTML
- CSS
# Invite
If you wish to invite the bot to your server, you can do it using this [invite](https://discord.com/api/oauth2/authorize?client_id=871058245404475423&permissions=68608&scope=applications.commands%20bot)
## Required Permissions
- Read Messages
- Send Messages
- application.commands scope
## Getting Started ⚙️
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Requirements
- Docker
- Docker Compose (compatible with docker-compose version 3.8)
## For development
- Yarn
- Node.js >= 16.6.0
Get the Docker version you need [here](https://hub.docker.com/search?q=docker&type=edition&offering=community)!
### Usage
### Setup
Since this bot has a **docker-compose.yml** file and is hosted on [DockerHub](https://hub.docker.com/r/nnari/formatbot), all you need to start your own version of Formatbot locally is to `clone` this repository and set up the **.env** file.
The **.env** file is used to configure the bot token and owner id, in the following format:
```
DISCORD_TOKEN=
OWNER=
```
#### For **Linux** and **Mac** run
```console
$ cp .env.example .env
```
#### For **Windows** run
```powershell
> Copy-Item .env.example .env
```
Edit the **.env** file with your favourite editor, filling out the following properties:
- **DISCORD_TOKEN** (you can find the bot token under `https://discord.com/developers/applications/bot-id/bot` for an overview of all your bots visit https://discord.com/developers/applications)
- **OWNER** ([Where can I find my User/Server/Message ID?](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-))
Run the bot via `docker-compose`
```console
$ docker-compose up --build --detach
```
# Without Docker
Create the `.env` file like before.
Then run `yarn && yarn dev` to start a development environment.
## Authors 👤
- **Tatu Pesonen** - _Original Author_ - [@tatupesonen](https://github.com/tatupesonen)
- **Donny Roufs** - _Motivational speaker / setting up testing architecture_ - [@donnyroufs](https://github.com/donnyroufs)
- **Ben Jamming** - _Improve code blocks parsing a lot_ - [@BenJammingKirby](https://github.com/benjammingkirby)
- **Dajeki** - _Improving the bot's logo_ - [@Dajeki](https://github.com/dajeki)
See also the list of [contributors](https://github.com/tatupesonen/formatbot/graphs/contributors) who participated in this project.
## Show your support ⭐️
Give a ⭐️ if this project helped you!
## License 📝
This project is [GPLv3](LICENSE) licensed.