About

Clueless is a Discord bot made to interract with pxls.space, it includes a large range of commands.

The main features are:

User stats: get graph of users' speed, leaderboards, user information and more.
Template creation: generate a template from an image, detemplatize an existing template and check its progress.
Template tracking: track your template's progress over time with visual graphs and a lot of stats. (average speed, ETA)
Pxls general stats: canvas elapsed time, percentage of virgin pixels, the average number of users online, the average cooldown ...
Pixel art tools: outlines, pixel text, crop, upscale/downscale, color breakdown, ...
Customization: All the graphs and tables made by Clueless are customizable using themes and fonts.

There are also some non-pxls related commands:

Server custom emojis management.
Random image getter. (using the reddit API)
Image manipulation. (rainbowfy, colorify)
Lyrics: get the lyrics of a song you're playing on Spotify or search for a song.

Installation

I would prefer that you do not run an instance of this bot. If you wish to use it, you can invite it to your own server or join the support server linked above.

Requirements

python3 (version 3.9.5 recommended)
poetry

1) Register your bot on discord

See the discord.py documentation on how to create an application and a bot.
Make sure both bot and application.commands scopes are selected.
Put your tokens in a .env file following the template in .env.dist

2) Install the required dependencies

$ poetry install

3) Start the bot

$ poetry run python src/main.py

Deploy on a distant host (with pm2)

Install pm2

You need to install pm2 on your local machine and on the host:

install Node.js and npm.
npm install pm2 -g
check installation with pm2 -v

Setup

Edit ecosystem.sample.js with your host information and rename it to ecosystem.config.js

On your local machine:

pm2 deploy production setup

Deploy

pm2 deploy production

If you get an error, make sure to update your .env information on the host too.

For more information, see this deploy pm2 guide.

Commands

This bot uses both prefix and slash commands. The default prefix is >.

Use >help or /help on a server with Clueless to see the list of commands

pxlsspace/Clueless

Clueless