{"id":16621726,"url":"https://github.com/lewdhutao/lavalink-status","last_synced_at":"2025-03-16T22:30:44.035Z","repository":{"id":43214162,"uuid":"464256107","full_name":"LewdHuTao/lavalink-status","owner":"LewdHuTao","description":"Easily monitor your lavalink status","archived":false,"fork":false,"pushed_at":"2024-09-23T04:08:54.000Z","size":4713,"stargazers_count":25,"open_issues_count":0,"forks_count":17,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-13T02:48:12.159Z","etag":null,"topics":["discord-bot","discordjs-v14","javascript","lavalink","lavalink-monitor","lavalink-status","lavalink-v3","lavalink-v4","nodejs"],"latest_commit_sha":null,"homepage":"","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/LewdHuTao.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2022-02-27T21:19:16.000Z","updated_at":"2024-10-05T17:45:45.000Z","dependencies_parsed_at":"2024-01-01T00:43:54.462Z","dependency_job_id":"b205510f-674d-4da2-9bfe-41495772e4a3","html_url":"https://github.com/LewdHuTao/lavalink-status","commit_stats":null,"previous_names":["shittybot/lavalink-status","lewdhutao/lavalink-status"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LewdHuTao%2Flavalink-status","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LewdHuTao%2Flavalink-status/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LewdHuTao%2Flavalink-status/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LewdHuTao%2Flavalink-status/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LewdHuTao","download_url":"https://codeload.github.com/LewdHuTao/lavalink-status/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221668362,"owners_count":16860631,"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":["discord-bot","discordjs-v14","javascript","lavalink","lavalink-monitor","lavalink-status","lavalink-v3","lavalink-v4","nodejs"],"created_at":"2024-10-12T02:48:13.230Z","updated_at":"2024-10-27T11:25:45.867Z","avatar_url":"https://github.com/LewdHuTao.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eLavalink Status\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\u003cstrong\u003eNote:\u003c/strong\u003e This branch supports only Lavalink v4. Lavalink v3 no longer maintained so please update your Lavalink\u003c/p\u003e\n\n## Installation Guide\n\n1. **Ensure NodeJS v18 or Later**:\n    - Make sure your NodeJS version is 18 or later.\n\n2. **Clone the Repository**:\n    - Clone the repository or download the ZIP file:\n    ```sh\n    git clone https://github.com/LewdHuTao/Lavalink-Status.git\n    ```\n\n3. **Configure the Bot**:\n    - Fill in the [config.js](https://github.com/LewdHuTao/Lavalink-Status/blob/main/src/config.js) file with your Lavalink Setting, Bot Token, and Channel ID where you want to send the status updates.\n\n4. **Install Required Packages**:\n    - Run the following command in your console:\n    ```sh\n    npm install\n    ## or\n    yarn install\n    ```\n\n5. **Start the Bot**:\n    - Use one of the following commands to start the bot:\n    ```sh\n    npm run start\n    ## or\n    node .\n    ```\n\n6. **Report Issue**:\n    - If you encounter any issues or the code doesn’t work, please [create an issue](https://github.com/LewdHuTao/Lavalink-Status/issues).\n\n## Web Monitor\n\n- Preview: https://lavalink.shittybot.xyz\n\n1. **Enable Web Monitor**:\n    - Set `webMonitor` to `true` in the [config.js](https://github.com/LewdHuTao/Lavalink-Status/blob/main/src/config.js) file.\n\n2. **Access the Web Monitor**:\n    - Open your browser and navigate to `http://localhost:3000`.\n\n3. **Custom Domain**:\n    - You can use a custom domain and set it up using services like ngrok, Cloudflare Tunnel or whatever service you like that can asign custom domain.\n\n### Web Monitor Preview\n\n![Web Monitor Preview](assets/image.png)\n\n### Badge Icon\n\nYou can embed these badge icons in any .md file to show your node status or node players.\n\n- Preview\n\n![Node Status](https://lavalink.shittybot.xyz/api/v1/badge/status/3) \n\u003cbr\u003e\n![Node Players](https://lavalink.shittybot.xyz/api/v1/badge/players/3)\n\n- Endpoints:\n\n1. Status Icon enpoint:\n\n```\nGET /api/v1/badge/status/:nodeIndex\n```\n\nReplace :nodeIndex with the index of the node you want to retrieve the status for.\n\n2. Players Icon enpoint:\n\n```\nGET /api/v1/badge/players/:nodeIndex\n```\n\nReplace :nodeIndex with the index of the node you want to retrieve the status for.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flewdhutao%2Flavalink-status","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flewdhutao%2Flavalink-status","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flewdhutao%2Flavalink-status/lists"}