Skip to content

HaiderZaidiDev/Discord-Pin-Archiver-Bot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pinArchiver Banner

Discord Pin Archiver Bot

Pin Archiver is a Discord bot that was specifically made for the Discord server of the alumni ran Subreddit for the University of Waterloo; however, since then, the bot has been made open source for the public to use.

If you require assistance in any means regardng the bot, feel free to join the Pin Archiver Support Server.

Pin Archiver has the following features:

  • Archives pinned messages to an archive channel, this message is an embed which:
    • Displays the author of the message and their profile picture.
    • Displays the channel in which the message was sent in and the time at which it was sent.
    • A hyper-link to jump to the chat location of the message.
  • Allows channels to exceed the maximum pin limit (50), by deleting the oldest pinned message once the maximum has been reached.
  • Creates an archive channel named 'pin-archive' upon joining the server if one hasn't been found upon pinning a message or when the bot joins the server.
  • Pins (and archives) a message if it receives 7 (by default) '📌' reactions.
  • When pinning a message in an private channel, the user will be given the option to pin the message but not archive it.
  • Fetch the last pinned message in the current channel (+lastpin).
  • Archive any message, regardless of whether it was pinned, via the message id (e.g +archive 615697286105923639).
  • Fetch a list of the bot's commands mentioned above, along with required permissions and examples (+help).

Usage

+lastpin: Displays the last pinned message of the current channel.

+archive: Archives a message to #pin-archive regardless of whether the message is pinned.

+setreactcount: Changes the number of '📌' reactions required to pin a message.

+status: Notifies the user if the bot is online

+help: Displays all of the bots commands, including the permissions required to execute.

Note: +archive and +setreactcount requires the user to have the manage messages permission. Guild owners or users with administrator permissions will have access to this as well.

To-do

I have lots of plans for the future regarding this bot! Here are some of the features I plan on implementing:

  • Configuration system via a web interface similar to Mee6, ideally, guild administrators would be able to login to a website with their Discord account and configure the bot to their liking. This includes changing permissions for commands, the archive channel name, the reaction emoji and/or its required reacts to pin, disable warning messages and more.

Operation

Requirements:

Python 3.6x

discord.py

SQL Database, I used SQLite3, this is only if you want to use +setreactcount.

If you plan on hosting the bot yourself, clone the repository via git clone -b master https://github.com/HaiderZaidiDev/Discord-Pin-Archiver-Bot master and run the main.py file. If you still want the bot to run after you close your SSH session I suggest setting up a screen to keep the file running in a background session.

I have tested and used this on Ubuntu 16.04 LTS, however, I recommend using something like 18.04 LTS so you don't have to go through the troubles of getting Python 3.6 working on it.

Discord Bots

About

A discord bot that archives and fetches pinned messages.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages