https://github.com/zaida04/anonymous-posting-bot
🕵️👤 A bot that safely allows semi-anonymous messages to be sent in your Discord server. Made with ❤️
https://github.com/zaida04/anonymous-posting-bot
discord-bot discord-js
Last synced: about 1 year ago
JSON representation
🕵️👤 A bot that safely allows semi-anonymous messages to be sent in your Discord server. Made with ❤️
- Host: GitHub
- URL: https://github.com/zaida04/anonymous-posting-bot
- Owner: zaida04
- License: mit
- Created: 2021-06-13T00:41:29.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-01-19T23:24:53.000Z (over 4 years ago)
- Last Synced: 2025-05-09T01:18:23.307Z (about 1 year ago)
- Topics: discord-bot, discord-js
- Language: TypeScript
- Homepage:
- Size: 638 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Allow server members to send in messages to be semi-anonymously posted in a Discord channel, while also giving server moderators the ability to moderate such content.
Report Bug
·
Request Feature
·
Send a Pull Request
# 📝 What is this?
This repository houses the code for the Fiveable Discord server network's "anonymous" message posting bot. The original intention for this bot was for it to be used during Pride Month, allowing people to ask questions without exposing their identities.
The bot allows people to **DM** it with the messages they wish to send in. It also allows moderators to set a log channel in their server where they get notifications as to who sends in which messages, with the expectation that they will stay confidential.
# 🎥 How do people use this?
**What it looks like on the channel-side:**
**What it looks like on the moderator-side:**
# 📝 Commands
| Command | Description |
|---------------------- |---------------------------------------------------------------------------------- |
| `eval` | Run some code through your bot |
| `help` | Get information on all the commands your bot has. |
| `anon` | Send in an anonymous message to a channel in a guild (DM ONLY) |
# 🚧 Getting Started
### ENV variables
Please supply the following ENV variables in a `.env` file in the root of the project.
| Key | Description | Optional |
|---------------------- |------------------------------------------------------------------- |---------- |
| DISCORD_TOKEN | The token belonging to the Discord bot | |
| PREFIX | Prefix for the bot | |
### Setup
You can setup this project manually using the steps below, or using the included docker-compose file by doing `docker compose up -d --build` or using the published Docker image `docker pull zaid450/anonymous-posting-bot` & `docker run --env-file .env zaid450/anonymous-posting-bot`. There is also an included `heroku.yml` file for deploying to Heroku, which should build with the Dockerfile provided.
```
git clone https://github.com/zaida04/anonymous-posting-bot.git
cd anonymous-posting-bot
npm install
npm run build
```
Be sure to fill in the env variables as seen [here](#env-variables).
**Please be sure to fill out a `config.yml` that abides by [this](https://github.com/zaida04/anonymous-posting-bot/blob/main/src/typings.ts#L1) schema.** Example file [here](https://github.com/zaida04/anonymous-posting-bot/blob/main/config.yml.example)
To start the bot, run this command:
```console
npm run start
```
## LICENSE
This license can also be found [here](https://github.com/zaida04/anonymous-posting-bot/blob/main/LICENSE)
```
MIT License
Copyright (c) 2021 Zaid (Nico)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```