Skip to content
/ Plume Public

A Discord bot with a fancy web UI to help staff visualize the voice chat activity of their server

Notifications You must be signed in to change notification settings

Seblor/Plume

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Introduction

Plume is a Discord bot that allows you to log your server's voice chat activity, with a fancy visualizer, while preventing the spam of log messages in your Discord server.

Why ?

I made this project to solve a few issue with the current logging tools of my Discord server (Minecraft-France, 65k+ members), since all the existing solutions would spam the moderation logs channel.

This would make the moderation's job a lot harder since the Discord's search results would be cluttered with voice chat activity.

It was also a great opportunity for me to learn Svelte.

Invite the bot

Just click here!

Installation

Discord bot hosting

If you would like to host the bot yourself, follow there steps:

Start by cloning the repo :

git clone git@github.com:Seblor/Plume.git

Copy the file example.ecosystem.config.cjs to prod.ecosystem.config.cjs, and fill the DISCORD_TOKEN and LOGS_WEBHOOK values with your config. If you are hosting the website yourself, you can change the PREVIEW_PREFIX_URL value.

Then install all the dependencies

# Install the global dependencies
npm i -g typescript pm2
# Build the shared types
cd ./plume/shared_types
npm run build
# Go to the bot's directory
cd ../bot
# Install the bot's dependencies
npm i
# Link the shared types
npm link ../shared_types
# build for production
npm run build:prod

You can now run the bot:

# Start the bot
npm run run:prod

You can see the logs with the following command:

npm run logs:prod

Website hosting

The website is a rather strait-forward installation of SvelteKit with a Vercel hosting. More information here: https://kit.svelte.dev/docs/adapter-static#zero-config-support

About

A Discord bot with a fancy web UI to help staff visualize the voice chat activity of their server

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published