-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
56987e3
commit 16377bc
Showing
4 changed files
with
528 additions
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,176 @@ | ||
| <p align="center"> | ||
| <a href="https://discord.com/api/oauth2/authorize?client_id=642935463048642570&permissions=347200&scope=applications.commands%20bot" alt = "Website link"> | ||
| <img src="https://i.imgur.com/orvVHhj.jpg" width="800"> | ||
| </a> | ||
| </p> | ||
| <p align="center"> | ||
| <a href="https://discord.com/api/oauth2/authorize?client_id=642935463048642570&permissions=347200&scope=applications.commands%20bot" alt="Build Status"> | ||
| <img src="https://img.shields.io/badge/Add-Bwuno-800080.svg?style=flat" /> | ||
| </a> | ||
| <a href="https://github.com/discordjs"> | ||
| <img alt="discord.js" src="https://img.shields.io/badge/discord.js-v13.8-red.svg?logo=npm" > | ||
| </a> | ||
| <a href="https://www.typescriptlang.org/"> | ||
| <img alt="typescript" src="https://img.shields.io/badge/typescript-v4.7.3-blue.svg?logo=typescript" > | ||
| </a> | ||
| <a href="https://github.com/Paul-Marie/Bwuno/commits/master"> | ||
| <img src="https://img.shields.io/github/last-commit/Paul-Marie/Bwuno?style=flat-square&logo=github&logoColor=white" alt="GitHub last commit"> | ||
| </a> | ||
| <a href="https://github.com/Paul-Marie/Bwuno/commits/master" alt="Code Size"> | ||
| <img src="https://shields.io/github/languages/code-size/Paul-Marie/Bwuno" /> | ||
| </a> | ||
| <br> | ||
| <a href="https://github.com/Paul-Marie/Bwuno/blob/master/.github/README.md"> | ||
| <img height="20px" src="https://img.shields.io/badge/EN-flag.svg?color=555555&style=flat&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTIwMCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB2aWV3Qm94PSIwIDAgNjAgMzAiIGhlaWdodD0iNjAwIj4NCjxkZWZzPg0KPGNsaXBQYXRoIGlkPSJ0Ij4NCjxwYXRoIGQ9Im0zMCwxNWgzMHYxNXp2MTVoLTMwemgtMzB2LTE1enYtMTVoMzB6Ii8+DQo8L2NsaXBQYXRoPg0KPC9kZWZzPg0KPHBhdGggZmlsbD0iIzAwMjQ3ZCIgZD0ibTAsMHYzMGg2MHYtMzB6Ii8+DQo8cGF0aCBzdHJva2U9IiNmZmYiIHN0cm9rZS13aWR0aD0iNiIgZD0ibTAsMGw2MCwzMG0wLTMwbC02MCwzMCIvPg0KPHBhdGggc3Ryb2tlPSIjY2YxNDJiIiBzdHJva2Utd2lkdGg9IjQiIGQ9Im0wLDBsNjAsMzBtMC0zMGwtNjAsMzAiIGNsaXAtcGF0aD0idXJsKCN0KSIvPg0KPHBhdGggc3Ryb2tlPSIjZmZmIiBzdHJva2Utd2lkdGg9IjEwIiBkPSJtMzAsMHYzMG0tMzAtMTVoNjAiLz4NCjxwYXRoIHN0cm9rZT0iI2NmMTQyYiIgc3Ryb2tlLXdpZHRoPSI2IiBkPSJtMzAsMHYzMG0tMzAtMTVoNjAiLz4NCjwvc3ZnPg0K"> | ||
| </a> | ||
| <a href="https://github.com/Paul-Marie/Bwuno/blob/master/.github/README_FR.md"> | ||
| <img height="20px" src="https://img.shields.io/badge/FR-flag.svg?color=555555&style=flat&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA5MDAgNjAwIj4NCjxwYXRoIGZpbGw9IiNlZDI5MzkiIGQ9Im0wLDBoOTAwdjYwMGgtOTAweiIvPg0KPHBhdGggZmlsbD0iI2ZmZiIgZD0ibTAsMGg2MDB2NjAwaC02MDB6Ii8+DQo8cGF0aCBmaWxsPSIjMDAyMzk1IiBkPSJtMCwwaDMwMHY2MDBoLTMwMHoiLz4NCjwvc3ZnPg0K"> | ||
| </a> | ||
| <a href="https://github.com/Paul-Marie/Bwuno/blob/master/.github/README_ES.md"> | ||
| <img height="20px" src="https://img.shields.io/badge/ES-flag.svg?color=555555&style=flat&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA3NTAgNTAwIj4NCjxwYXRoIGZpbGw9IiNjNjBiMWUiIGQ9Im0wLDBoNzUwdjUwMGgtNzUweiIvPg0KPHBhdGggZmlsbD0iI2ZmYzQwMCIgZD0ibTAsMTI1aDc1MHYyNTBoLTc1MHoiLz4NCjwvc3ZnPg0K"> | ||
| </a> | ||
| </p> | ||
|
|
||
| > Looking for a Discord bot allowing you to follow all the news of the game [Dofus-Touch](https://dofus-touch.com) on your Discord server? Bwuno makes it possible to follow all Twitter, Almanax or official Forum events while offering a quick way to access information about guilds or characters from the official site. | ||
| <div align="center"> | ||
|
|
||
| | | | | | | ||
| |--|--|--|--| | ||
| | | [Fonctionnalities](#functionalities) | [Commands](#commands) | [Examples](#example) | [Installation](#installation) | | ||
|
|
||
| </div> | ||
|
|
||
| <img src="https://i.imgur.com/KcPGyJA.png" style="text-align:center" /> | ||
|
|
||
| <h2 id="functionalities"> 📝 Fonctionnalities</h2> | ||
|
|
||
| * 🕊️ Dofus-Touch Twitter account activity tracking in a living room | ||
| * 📅 Posts the almanax of the day in a predefined room at midnight | ||
| * 💬 Notification of staff interventions on the Official Forum in a living room | ||
| * 🤵 Retrieving character or guild information | ||
| * ⏰ Predefined reminder of desired almanaxes 1 month and 2 weeks before | ||
| * 👄 Management of French, English and Spanish languages | ||
| * 🌠 Support of [Slash Command](https://support.discord.com/hc/fr/articles/1500000368501-Slash-Commands-FAQ) | ||
| * ⚙️ Customization of the Discord server (prefix, DT server, etc...) | ||
|
|
||
| <img src="https://i.imgur.com/KcPGyJA.png" /> | ||
|
|
||
| <h2 id="commands">📚 Commands</h2> | ||
|
|
||
| | Commands | Options | Description | | ||
| |-------------------|------------------------------|---------------------------------------------------------------------------------------| | ||
| | [/help]() | | Displays help menu | | ||
| | [/about]() | | Shows Bwuno's credits | | ||
| | [/type]() | `name` | Returns all dates with an Almanax of the desired type | | ||
| | [/doziak]() | `date` | Shows the doziak sign of the date | | ||
| | [/remind start]() | `date` ou `item` | Activates a reminder by DM 30d, 15d and 7d before the Almanax as well as the same day | | ||
| | [/remind stop]() | `date` ou `item` | Disables the reminder of this Almanax | | ||
| | [/show]() | | Displays all reminders to which the user has subscribed | | ||
| | [/follow start]() | `channel`, `type` | Enables following Twitter or forum posts in a room | | ||
| | [/follow stop]() | `channel`, `type` | Disables Twitter or forum post tracking in a room | | ||
| | [/whois]() | `pseudo`, `serveur`, `level` | Displays player information from the official Dofus-Touch website | | ||
| | [/guild]() | `name`, `serveur`, `level` | Displays guild information | | ||
| | [/auto start]() | `channel` | Enables adding the Almanax of the day to a lobby at midnight | | ||
| | [/auto stop]() | `channel` | Disables the display of the Almanax of the day on the Discord server | | ||
| | [/lang]() | `language` | Change the default language of Bwuno on the Discord server | | ||
| | [/almanax]() | | Show today's Almanax | | ||
| | | `date` | Displays the Almanax of the specified date | | ||
| | | `item` | Displays all Almanax where the offering is the item | | ||
| | | `plus` | Displays up to the next 25 Almanax | | ||
|
|
||
| <img src="https://i.imgur.com/KcPGyJA.png" /> | ||
|
|
||
| <h2 id="examples">🌵 Examples</h2> | ||
|
|
||
| <table> | ||
| <tr> | ||
| <td style="text-align:center"> | ||
| <code> | ||
| /whois usopp-sogeking | ||
| </code> | ||
| </td> | ||
| <td style="text-align:center"> | ||
| <code> | ||
| /guild magoa | ||
| </code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <img src="https://i.imgur.com/hOhh0Vy.png" alt="1" width="450" height="500"> | ||
| </td> | ||
| <td> | ||
| <img src="https://i.imgur.com/WCxJkYZ.png" alt="2" width="450" height="500"> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
|
|
||
| <table> | ||
| <tr> | ||
| <td style="text-align:center"> | ||
| <code> | ||
| /follow start DofusTouch_EN | ||
| </code> | ||
| </td> | ||
| <td style="text-align:center"> | ||
| <code> | ||
| /follow start Forum | ||
| </code> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <img src="https://i.imgur.com/XaJh5Gt.png" alt="1" width="450" height="400"> | ||
| </td> | ||
| <td> | ||
| <img src="https://i.imgur.com/LvE1ML7.png" alt="2" width="450" height="200"> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <img src="https://i.imgur.com/KcPGyJA.png" /> | ||
|
|
||
| ## A mere remake of Kaelly-Touch, isn'it ? | ||
|
|
||
| Well no ! *it's a full-fledged discord bot*. The source code of kaelly-touch has never been even looked at by the creators of Bwuno. | ||
| They have commands in common because this one was __planned__ but are not made the same. | ||
|
|
||
| The few rare commands that Bwuno and Kaelly-Touch have in common are more **complete** at Bwuno | ||
|
|
||
| **Example**: *(Kaelly on the left and Bwuno on the right)* | ||
|
|
||
| <img align="left" style="float: center; margin: 0 10px 0 0;" src="https://i.imgur.com/5HgLgYB.png" height="400" width="350"/> | ||
| <img align="center" style="float: left; margin: 0 10px 0 0;" src="https://i.imgur.com/y02c7ap.png" height="400" width="350"/> | ||
| <img align="left" style="float: center; margin: 0 10px 0 0;" src="https://i.imgur.com/qA5pKJi.png" height="400" width="350"/> | ||
| <img align="center" style="float: left; margin: 0 10px 0 0;" src="https://i.imgur.com/cFT5kJU.png" height="400" width="350"/> | ||
| <img align="left" style="float: center; margin: 0 10px 0 0; margin-bottom: 100px;" src="https://i.imgur.com/v06HATS.png" height="300" width="350"/> | ||
| <img align="center" style="float: left; margin: 0 10px 0 0; margin-bottom: 100px;" src="https://i.imgur.com/F9DXhL8.png" height="400" width="350"/> | ||
|
|
||
| <img src="https://i.imgur.com/KcPGyJA.png" /> | ||
|
|
||
| <h2 id="instalation">📜 Instalation</h2> | ||
|
|
||
| ⚠️ This part is reserved for developers or people wishing to launch Bwuno from their machine, | ||
| If you just want to use it on your Discord server without having to deal with hosting and everything, [click here](https://discord.com/api/oauth2/authorize?client_id=642935463048642570&permissions=347200&scope=applications.commands%20bot) | ||
|
|
||
| ```sh | ||
| git clone https://github.com/Paul-Marie/Bwuno; | ||
| cd Bwuno/ | ||
| ``` | ||
| Now open the `./resources/config.json` file and fill in the empty fields, such as the `discord.token` part where you must put your Discord bot token, then add the images associated with your future bot in the fields blank `bwuno` field. | ||
|
|
||
| Make sure you have a version of [Node.JS](https://nodejs.org/fr/download/) greater than 10, | ||
| Then launch your bot with [yarn](https://classic.yarnpkg.com/fr/docs/install/#debian-stable) or [npm](https://nodejs.org/fr/download/) (you've got the choice) | ||
| ```sh | ||
| yarn; # Used to install the necessary packages | ||
| yarn start makeDB; # Create the database locally | ||
| yarn start; # Launch the bot on your machine | ||
| ``` | ||
| I personally recommend that you use [PM2](https://pm2.keymetrics.io/docs/usage/quick-start/) or [screen](https://www.gnu.org/software/screen/screen.html) to keep your bot active all the time long. | ||
|
|
||
| <img src="https://i.imgur.com/KcPGyJA.png" /> | ||
|
|
||
|
|
||
| > Pop the ⭐ to contribute to the project 😎. |
Oops, something went wrong.