philosolog / trashpin

🗑️ A Discord bot I put together to log my notes.

🤖 What's this? 🗑️📌

A Discord bot I originally made to log my pinned notes & shopping lists (for personal use). You can use this bot to handle server pins.

This project is open to suggestions and improvements; feel free to open an issue or make a pull request!

⭐ Sound neat? I'd appreciate if you starred this repo! ⭐

⚙️ Features

Trashpin responds to pinned messages and various slash commands...

If enabled, pinned messages are logged/archived properly if they were sent after the bot's most recent startup.

📄 Commands

/enable [channel]

Enables pin archiving for the specified channel.

/disable

If pin archiving is enabled, this command disables it.

/ping

Returns the bot's latency.

/help

Returns a guide on how to use the bot.

🚀 Usage

You can either invite the bot or run it locally...

🛠️ Running it locally

First, fork (or not) and download the repository to your computer!

Then, rename example.env to .env and personalize its settings.

If you prefer to test trashpin on an alternate Discord bot token (to debug, for example), you can add an alternate.env file to the debug folder. Make sure to configure it with the same keys as listed in example.env!

Next, install the module requirements:

pip install -r requirements.txt

Make sure the trashpin folder is the directory of the following commands...

Then, run main.py..

python main.py

or run the script but hide the terminal:

pythonw main.py

However you run the Python file does not matter. At the moment, I host the bot by running the script from Visual Studio Code on a Raspberry Pi I have under my piano.. lol.

Alternatively, you can run trashpin.bat if your computer allows. This will run the script without showing the terminal, but you'll still have to download the Python requirements.

As a possible use for this file, you can set the trashpin.bat file to run on startup.

😅 Need help?

Feel free to discuss questions in this repository's Q&A section or my personal Discord server for all projects philosolog!