{"id":14983228,"url":"https://github.com/maseshi/shioru","last_synced_at":"2025-04-04T09:06:50.559Z","repository":{"id":38377923,"uuid":"276369075","full_name":"Maseshi/Shioru","owner":"Maseshi","description":"🧸 (Discord) Your personal assistant that will make your discord never lonely again.","archived":false,"fork":false,"pushed_at":"2025-03-31T08:35:03.000Z","size":19627,"stargazers_count":185,"open_issues_count":6,"forks_count":25,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-04T09:06:41.444Z","etag":null,"topics":["bot","command-handlers","discord","discord-bot","discord-js","discord-js-bot","discord-js-v14","firebase","games","interaction-handlers","languages","music","nodejs","slash-commands","thailand"],"latest_commit_sha":null,"homepage":"https://shiorus.web.app","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Maseshi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"maseshi","patreon":"maseshi","buy_me_a_coffee":"maseshi"}},"created_at":"2020-07-01T12:15:22.000Z","updated_at":"2025-04-03T09:34:13.000Z","dependencies_parsed_at":"2024-02-17T16:25:09.698Z","dependency_job_id":"004a6600-fe8b-4076-999f-510674fa9f58","html_url":"https://github.com/Maseshi/Shioru","commit_stats":{"total_commits":1849,"total_committers":10,"mean_commits":184.9,"dds":0.07679826933477552,"last_synced_commit":"095d063bce3b786af9d46ab5e2e9d11ff62e1c86"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Maseshi%2FShioru","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Maseshi%2FShioru/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Maseshi%2FShioru/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Maseshi%2FShioru/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Maseshi","download_url":"https://codeload.github.com/Maseshi/Shioru/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247149500,"owners_count":20891954,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","command-handlers","discord","discord-bot","discord-js","discord-js-bot","discord-js-v14","firebase","games","interaction-handlers","languages","music","nodejs","slash-commands","thailand"],"created_at":"2024-09-24T14:06:55.961Z","updated_at":"2025-04-04T09:06:50.533Z","avatar_url":"https://github.com/Maseshi.png","language":"JavaScript","funding_links":["https://github.com/sponsors/maseshi","https://patreon.com/maseshi","https://buymeacoffee.com/maseshi"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/Maseshi/Shioru/main/assets/icons/apple-touch-icon.png\" width=\"100\" alt=\"Shioru\" /\u003e\n  \u003cstrong\u003e\n    \u003ch1\u003eShioru\u003c/h1\u003e\n    \u003cp\u003ePersonal assistants in Discord that will help make your guild a better place.\u003c/p\u003e\n  \u003c/strong\u003e\n  \u003cp\u003e\n    \u003ca title=\"Discord.js v14\" href=\"https://discord.js.org/\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/discord.js-14-blue?logo=discord\u0026logoColor=white\u0026style=for-the-badge\" alt=\"Discord.js v14\" /\u003e\n    \u003c/a\u003e\n    \u003ca title=\"Last commit\" href=\"https://github.com/Maseshi/Shioru/commits/\"\u003e\n      \u003cimg src=\"https://img.shields.io/github/last-commit/Maseshi/Shioru?logo=github\u0026style=for-the-badge\" alt=\"Last commit\" /\u003e\n    \u003c/a\u003e\n    \u003ca title=\"Status\" href=\"https://shioru.statuspage.io/\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fq60yrzp0cbgg.statuspage.io%2Fapi%2Fv2%2Fstatus.json\u0026query=status.indicator\u0026logo=google-cloud\u0026logoColor=white\u0026label=status\u0026style=for-the-badge\" alt=\"Status\" /\u003e\n    \u003c/a\u003e\n    \u003cbr /\u003e\n    \u003ca title=\"Crowdin\" href=\"https://crowdin.com/project/shioru\"\u003e\n      \u003cimg src=\"https://badges.crowdin.net/shioru/localized.svg\" alt=\"Crowdin\" /\u003e\n    \u003c/a\u003e\n    \u003ca title=\"CodeFactor\" href=\"https://www.codefactor.io/repository/github/maseshi/shioru\"\u003e\n      \u003cimg src=\"https://www.codefactor.io/repository/github/maseshi/shioru/badge\" alt=\"CodeFactor\" /\u003e\n    \u003c/a\u003e\n    \u003ca title=\"Top.gg\" href=\"https://top.gg/bot/704706906505347183\"\u003e\n      \u003cimg src=\"https://top.gg/api/widget/upvotes/704706906505347183.svg\" alt=\"Top.gg\" /\u003e\n    \u003c/a\u003e\n  \u003c/p\u003e\n  \u003cp\u003e\n    \u003ca href=\"https://shiorus.web.app/invite\"\u003eAdd App\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/Maseshi/Shioru/tree/main/documents\"\u003eSwitch Languages\u003c/a\u003e\n    ·\n    \u003ca href=\"https://shioru.statuspage.io/\"\u003eStatus\u003c/a\u003e\n    ·\n    \u003ca href=\"https://crowdin.com/project/shioru\"\u003eImprove Translation\u003c/a\u003e\n    ·\n    \u003ca href=\"https://top.gg/bot/704706906505347183\"\u003eRate It\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\nYour best personal assistants will help your guild look more lively. She can do so many things that you can easily see detailed information on all commands by typing `/help`.\n\n## ✨ Outstanding features\n\n- [x] Worked on [Discord.js](https://discord.js.org/) v14\n- [x] Easy to read, easy to use and highly effective\n- [x] You can customize many things you want\n- [x] Contains all commands including 100+ available subcommands\n- [x] Can play music both from [YouTube](https://www.youtube.com/), [Spotify](https://www.spotify.com/), [SoundCloud](https://soundcloud.com/) and [900+ more Website](https://github.com/yt-dlp/yt-dlp/blob/master/supportedsites.md) along with an automatic music playback system\n- [x] Supports multiple languages. You can check the supported languages ​​from the [Language File](https://github.com/Maseshi/Shioru/blob/main/source/configs/languages.json) of this repository.\n- [x] Tier system (Level and experience)\n- [x] Support for customizing server notifications\n- [x] You can talk by typing `@Shioru` followed by the message you want to communicate\n- [x] Supports working on Shards or supports working in various guilds\n- [x] You can use application commands (`/`)\n- [x] Simulate the database system for testing.\n\nAnd many other interesting features...\n\n## 🧩 Prerequisites\n\n- [Node.js](https://nodejs.org/) v22.12.0 or higher\n- [Firebase Tools](https://firebase.google.com/docs/cli) (requires [Java](https://www.oracle.com/java/technologies/downloads/) v11.0.0 or higher)\n- [Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022) (requires [Python](https://www.python.org/downloads/) v3.12.0 or higher)\n- [FFmpeg](https://ffmpeg.org/download.html)\n- [Git](https://git-scm.com/downloads)\n\n## ⌛ Installation\n\n### 1. Clone the bot and install the components.\n\n- Launch a terminal and run the following command.\n  ```bat\n  git clone https://github.com/Maseshi/Shioru.git\n  cd Shioru\n  npm install\n  ```\n- Change the file name `.env.example` to `.env` and enter all required values.\n\n\u003e [!NOTE]\n\u003e You can edit some data in **config** at [./source/configs/data.js](./source/configs/data.js).\n\n### 2. Setup bot and invite to join.\n\n- Go to [Discord Developer Portal](https://discord.com/developers/applications)\n- Click **\"New Application\"** and name your bot and accept the Discord policy rules.\n- Go to the **\"Bot\"** page and enable all options in the **Privileged Gateway Intent** section.\n  ![](https://raw.githubusercontent.com/Maseshi/Shioru/main/assets/images/discord-developer-portal-privileged-gateway-intents.png)\n- Invite your bot to the server by going to the **OAuth2 \u003e URL Generator** page, selecting `bot` and `applications.commands`, selecting `Administrator`, then copy the link and paste it in the browser address bar. Your sir\n  ![](https://raw.githubusercontent.com/Maseshi/Shioru/main/assets/images/discord-developer-portal-scopes.png)\n\n### 3. Setup database\n\n- Go to https://firebase.google.com/ and start setting up the project.\n- Add a new project and follow the steps.\n- Add your first application with **Website** Name your app without needing to select the **\"Also set up Firebase Hosting for this app.\"** option and register the app.\n  ![](https://raw.githubusercontent.com/Maseshi/Shioru/main/assets/images/firebase-setup-web-application.png)\n- Firebase will provide you with information about its configuration. Apply these values to the file. `.env`\n- Go to **Build \u003e [Realtime Database](https://console.firebase.google.com/u/0/project/_/database/data)** to create a database for storing data.\n\n## 🔥 Get started\n\nThere are several options available. If you are using [Visual Studio Code](https://code.visualstudio.com/), you can choose your method directly via the Run and Debug tab (\u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eShift\u003c/kbd\u003e + \u003ckbd\u003eD\u003c/kbd\u003e). For other operations, see Tasks (\u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eShift\u003c/kbd\u003e + \u003ckbd\u003eB\u003c/kbd\u003e and \u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eShift\u003c/kbd\u003e + \u003ckbd\u003eP\u003c/kbd\u003e type `\u003eTasks: Run Task`)\n\n### 🪛 Development\n\n- Open a terminal and run the command `npm run dev`.\n\n### ☕ Serve\n\nTest the actual use by performing tasks similar to real use. The system will automatically calculate the split of the work fraction according to the number of guilds.\n\n- Open the terminal and add all the necessary environmental variables.\n  - For Windows, use commands `set variable=example`\n  - For Linux or MacOS, use the command `export variable=example`\n- Run the command `npm run serve`.\n\n\u003e [!NOTE]\n\u003e You will enter automatic development mode because it is a real use. All data will not be recorded.\n\n### 🍵 Production\n\nFor actual use, the prepared command or set of commands can be used normally as follows:\n\n- On Linux or MacOS\n\n  ```sh\n  sh start.sh || sudo sh start.sh\n\n  # or\n\n  npm start\n  ```\n\n- On Windows\n\n  ```bat\n  ./start.bat\n\n  @REM or\n\n  npm start\n  ```\n\n### 🐳 Running on Docker\n\nThis operation requires [Docker](https://www.docker.com/products/docker-desktop/)\n\n- Open the terminal and add all the necessary environmental variables.\n  - For Windows, use commands `set variable=example`\n  - For Linux or MacOS, use the command `export variable=example`\n- Create an image using the command `npm run docker:build` or `npm run docker:build:serve` for the serve mode and wait until the process is finished.\n- After creating the images successfully, run by using the command `npm run docker:build` or `npm run docker:build:serve` for the serve mode.\n\n[Learn more about commands Docker](https://docs.docker.com/reference/)\n\n## 🌐 Improve Translate\n\nYou can help us translate existing languages or languages that are not currently available on [Crowdin](https://crowdin.com/project/shioru).\n\n## ⚠️ Found a problem\n\nIf you encounter any problems from your current job You can let us know through the tab. [issue](https://github.com/Maseshi/Shioru/issues) of this repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaseshi%2Fshioru","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaseshi%2Fshioru","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaseshi%2Fshioru/lists"}