Skip to content

Latest commit

 

History

History
66 lines (54 loc) · 4.14 KB

README.md

File metadata and controls

66 lines (54 loc) · 4.14 KB
Raw

FelixBot

Dependencies Github Stars Github Issues

Discord Bots

Felix is here, was first supposed to be a meme but hey, its a thing now ! About Felix's source usage, note that Felix is under APACHE 2.0 license, more informations at the very bottom of this readme.

Tables of contents

Features

  • Simple but powerful permission system
  • Custom prefix
  • Some fun commands and utility commands
  • Active development (what? its not a feature? kek)
  • Aliases for commands, ofc
  • Server management features
  • Moderation features (modlog, hackban, mute, ban...)
  • Starboard
  • Custom greetings/farewell
  • auto-assignables roles
  • A lot of stuff planned

Invite link and support server

invite link

Support server

Self-hosting v3

The only required fields in the config.js file are the ownerID(well probably the admins one as well) and the token fields, features will automatically be disabled if the needed api keys are missing

There is some customizable options in the config file like the cooldowns, but market items are in the core-data.json file

First run notice

The first time you run Felix(and everytime you will run him), Felix overwrites some of Eris(the API wrapper Felix uses) files, once the overwrite is done (status is logged to the console) you'll have to stop Felix and restart him for the right files to get loaded

What happen to users data?

Im that kind of guy who likes to know what exactly happen to my data when a application or something collect it, so even if probably very few users cares about how a bot use their data, here's what we exactly store and do with it:

Yes, what do you store about me?

Basically, only your Discord user ID, that allow us to efficiently store and differenciate users, all of the other data we store "about you" are Felix-related(Your points, experience, market items you bought...)

And, is that all?

Well yes ¯\_(ツ)_/¯

Alright but when do you store users? Who are "users" and how can i stop be a "user"?

A new entry in the database is created when you first use a command, which means you won't be considered as a "user" and therefore won't be in the database as long as you don't use Felix.

You can always reset your data with the account command and join the support server to request a full deletion of your data(but you will still be stored again once you use a command)

Credits

  • Aetheryx#2222 Original author of the logger module, also helped to shorten quite a few parts of the code
  • Wolke#5985 For his awesome Rem bot on which Felix is inspired
  • FrostyRaiden#7802 Helped me locate most of the v3 bugs during the beta, and if you ever feel like thanking someone for Felix's pretty easy self-hosting, thanks him ^
  • Karen#3938 The best for the end, basically Felix wouldn't even be alive without him ^