Skip to content

Latest commit

 

History

History
76 lines (54 loc) · 4.27 KB

README.md

File metadata and controls

76 lines (54 loc) · 4.27 KB

Spiritus Bot

spiritus

Maintenance made-with-Markdown GitHub license GitHub tag PRs Welcome

Spiritus has all the tools you will need for your Discord server, Spiritus is a multi-function Discord bot. You can invite the hosted version here

Commands

Administration

Name Description Sub-commands Usage Cd
commands Manage custom commands. list, add, rem <action> <valeur> 10secs
reactionroles Manage roles-reactions in the guild. add, rem [paramètre] (valeur) 10secs

Bot

Name Description Sub-commands Usage Cd
config Config the bot. prefix, log-channel, welcome-message, experience, admin-invites, rank-card, rank-channel [parameter] (value) 10secs
invite Send link invite for the bot. none none 10secs
ping Ping the bot. none none 3secs

Experience

Name Description Sub-commands Usage Cd
adminxp Manage exp of users. add, rem <@​user> <nb_experience> 10secs
leaderboard Ranking of users on the guild. none none 10secs
rank View your rank or rank of member. none <@​user> 10secs

Fun

Name Description Sub-commands Usage Cd
info Send informations. user, bot, server, role, channel <action> <value> 5secs

Moderation

Name Description Usage Cd
ban Ban a user. <@​user> <reason> 10secs
kick Kick a user. <@​user> <raison> 10secs
mute Mute a user. <@​user> <time> 10secs
purge Delete messages. <nb_messages> 10secs
rename Change nickname of user. <user> <new_name> 10secs
unban Unban a user. <user_id> 10secs
unmute Unmute a user. <@​user> 10secs
warn Warn a user. <user> <reason> 10secs

How to install

  1. Clone the repo
  2. Clone config.template.ts from src directory into the src directory and rename it to config.ts
  3. Install the dependencies: npm install
  4. Compile typescript : npm run build
  5. Start the bot: npm run start

Contributions/Licence

This project has an MIT license. And you are welcome to contribue. To contribute, please open a pull request on dev branch.

Need help

If you have question or need help, open issue or join support server.