Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/smaug6739/spiritus

bot discord discord-bot discord-js djs-v13 leveling moderation nodejs reaction-roles sheweny sheweny-js

Last synced: 3 days ago
JSON representation

Host: GitHub
URL: https://github.com/smaug6739/spiritus
Owner: Smaug6739
License: mit
Created: 2020-05-13T15:32:21.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-07-24T19:34:15.000Z (over 1 year ago)
Last Synced: 2024-05-01T17:33:02.487Z (7 months ago)
Topics: bot, discord, discord-bot, discord-js, djs-v13, leveling, moderation, nodejs, reaction-roles, sheweny, sheweny-js
Language: TypeScript
Homepage:
Size: 18.8 MB
Stars: 24
Watchers: 4
Forks: 12
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Spiritus Bot

![spiritus](https://cdn.discordapp.com/attachments/734318123510923324/734318158642544650/spiritus_banniere.png)



[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/Smaug6739/Spiritus)

[![made-with-Markdown](https://img.shields.io/badge/Made%20with-Markdown-1f425f.svg)](http://commonmark.org)

[![GitHub license](https://img.shields.io/github/license/Naereen/StrapDown.js.svg)](https://github.com/Smaug6739/master/LICENSE)

[![GitHub tag](https://img.shields.io/github/tag/Smaug6739/Spiritus.svg)](https://github.com/Smaug6739/Spiritus/tags/)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)



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](https://discord.com/oauth2/authorize?client_id=689210215488684044&scope=bot&permissions=1946446974)

## Commands

### Administration

| Name          | Description                          | Sub-commands   | Usage                 | Cd     |

| ------------- | ------------------------------------ | -------------- | --------------------- | ------ |

| commands      | Manage custom commands.              | list, add, rem | \ \   | 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> \ | 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 | \ \ | 5secs |

### Moderation

| Name   | Description              | Usage               | Cd     |

| ------ | ------------------------ | ------------------- | ------ |

| ban    | Ban a user.              | \<@user> \ | 10secs |

| kick   | Kick a user.             | \<@user> \ | 10secs |

| mute   | Mute a user.             | \<@user> \   | 10secs |

| purge  | Delete messages.         | \      | 10secs |

| rename | Change nickname of user. | \ \ | 10secs |

| unban  | Unban a user.            | \          | 10secs |

| unmute | Unmute a user.           | \<@user>           | 10secs |

| warn   | Warn a user.             | \ \   | 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](https://discord.gg/TC7Qjfs).