https://github.com/jadc/redpin

A Discord app for pinning messages and comparing stats, powered by Go.
https://github.com/jadc/redpin

api async database discord discord-bot discordgo go golang routing sqlite

Last synced: about 1 month ago
JSON representation

A Discord app for pinning messages and comparing stats, powered by Go.

• Host: GitHub
• URL: https://github.com/jadc/redpin
• Owner: jadc
• License: gpl-3.0
• Created: 2024-08-02T23:23:47.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-14T02:55:48.000Z (4 months ago)
• Last Synced: 2024-08-14T04:20:24.080Z (4 months ago)
• Topics: api, async, database, discord, discord-bot, discordgo, go, golang, routing, sqlite
• Language: Go
• Homepage:
• Size: 23.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 📌 redpin

A [Discord app](https://support.discord.com/hc/en-us/articles/21334461140375-Using-Apps-on-Discord#h_01J7CJ994TKKMGYMG1ZZQ9T3S5) for saving messages and comparing stats, powered by Golang.

Unlike most pin bots, redpin is highly configurable and flexible, supporting any number of emojis to pin messages; in addition, the bot uses webhooks and modern Discord features for a much more minimal aesthetics compared to other options.

## Tour

TODO

## Motive

This repository contains the modern rewrite of **redpin** in Go. If you are looking for the original python version, see [redpin-py](https://github.com/jadc/redpin-py); I rewrote this bot to practice interfacing with APIs, routing packets, and responding to asynchronous events in the Go programming language.

## TODO

- [ ] Implement core functionality

    - [ ] Message detection

    - [ ] Automatic webhook creation and usage

    - [ ] Message pinning

    - [ ] Message pinning with replies

    - [ ] Command-based interface for per-guild configuration

        - [ ] Pin Channel

        - [ ] Reaction Count to Pin (each or sum)

        - [ ] Allow pins from NSFW channels

        - [ ] Allow self-pins

        - [ ] Ping author when their message is pinned

        - [ ] Select which emojis pin messages

- [ ] Implement nice-to-haves

    - [ ] Per-user leaderboard for how many of their messages have been pinned (toggleable)

    - [ ] Pin score: ratio between pins given and pins received (toggleable)

- [ ] Write tests

- [ ] Write CI/CD pipeline for automatic building and running tests

- [ ] Write Dockerfile for production deployment

- [x] Write Nix Shell for development environment

- [ ] Showcase bot in [Tour](#Tour)

## Contribution

Install [Nix](https://nixos.org/download) and then run `nix develop` in the root of the repo. This will switch you into a shell with all the dependencies installed.

> [!note]

> Redpin does not have many dependencies, so if you do not want to install Nix, you can read the [flake.nix](flake.nix) file and figure out what you need.