Shioru
Assistants within your Discord server will help make your server a better place to live.
Your good server assistant will help make your server look more lively. She can do a number of things, where you can view detailed information for the commands by typing /help.
Outstanding features
- Works on Discord.js v14
- A wide variety of customizations can be made.
- It can play music from YouTube, Spotify and SoundCloud, with an automatic playback feature.
- Support for multiple languages, You can check the supported languages from the language file of this repository.
- Tier system (level and experience)
- Support customization of server notifications
- You can chat by typing
@Shiorufollowed by the message you wish to communicate. - Able to use application commands (/)
And many other interesting features...
Prerequisites
Quick setup guide
Tested on Mac, Linux and Windows Systems
Add bot to the server.
- Go to the Discord Developer Portal
- Click "New Application" and give your bot a name and accept the Discord policy rules.
- Go to the "Bot" page and enable all options in the Privileged Gateway Intents section.
- Invite your bot to the server by going to the OAuth2 > URL Generator page, selecting
botandapplications.commandsselectingAdministrator. Then copy the link and paste it on your browser's address.
Setup a bot
- Since we use sodium for encryption and decryption, we need to install the following additional components:
@REM On Windows
npm install -g windows-build-tools# On MacOS (Darwin)
brew install libtool autoconf automake# On Linux
sudo apt-get install libtool-bin- Launch a terminal and run the following commands.
git clone https://github.com/Maseshi/Shioru.git
cd Shioru
npm install- You can edit some data in config at
./source/configs/data.js.
Setup Firebase
- Go to https://firebase.google.com/ and start setting up the project.
- Add a new project and go through the steps.
- Add your first application with Website, name your app without the need to select "Also set up Firebase Hosting for this app." and register the app.
- Firebase will provide you with information about the configuration. Apply these values to the
.env.examplefile. - Go to Build > Realtime Database to create a database for storing data.
Development
- Rename the
.env.examplefile to.envand add all values. - Go to terminal and run
npm run devfor development andnpm startfor production.NOTE: When you enter development mode, some features may be disabled, such as sending statistics, updating data, etc.
Quick Troubleshooting
-
If you run into problems during component installation which on the terminal says
gyp ERR! stack Error: not found: make. This problem may be caused by the build tools not being installed properly or they may not be installed yet. The solution is to download the latest version of Node.js and tick this section within the installation process.
-
If you can't install the sodium dependency, install libsodium-wrappers instead.
npm uninstall sodium
npm install libsodium-wrappers@latest --save- If you can't play music or music playback commands are not working, install FFmpeg (recommended) or install the ffmpeg-static package. and try again
npm install ffmpeg-static@latest --saveImprove Translate
You can help us translate existing languages or languages that are not currently available on Crowdin.
Credits
Thank you to all the original creators for allowing us to use these wonderful works of yours.
Personal drawing by: 夏月 まりな (NATSUKI MARINA)/お着替え中
Found a problem
If you encounter any problems from your current job You can let us know through the tab. issue of this repository.
Google Translate
The content of this document has been translated by the Google Translate service. We apologize for any errors.