{"id":15211416,"url":"https://github.com/eternalclan/clannotifyer","last_synced_at":"2026-03-08T08:31:49.140Z","repository":{"id":256475212,"uuid":"855417641","full_name":"EternalClan/ClanNotifyer","owner":"EternalClan","description":"A Discord bot for Livestream and upload notifycations.","archived":false,"fork":false,"pushed_at":"2024-09-27T12:50:41.000Z","size":277,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-11T07:15:57.637Z","etag":null,"topics":["bot","discord","discordjs","eternalclan","javascript","nodejs","notifications","sqlite3"],"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/EternalClan.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":"2024-09-10T20:44:52.000Z","updated_at":"2024-09-27T12:50:44.000Z","dependencies_parsed_at":"2024-11-17T04:02:28.217Z","dependency_job_id":null,"html_url":"https://github.com/EternalClan/ClanNotifyer","commit_stats":{"total_commits":22,"total_committers":1,"mean_commits":22.0,"dds":0.0,"last_synced_commit":"5f9ed7949bf4a392fb3d00ea132cb60b78ef2854"},"previous_names":["eternalclan/clannotifyer"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EternalClan%2FClanNotifyer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EternalClan%2FClanNotifyer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EternalClan%2FClanNotifyer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/EternalClan%2FClanNotifyer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/EternalClan","download_url":"https://codeload.github.com/EternalClan/ClanNotifyer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242988055,"owners_count":20217539,"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","discord","discordjs","eternalclan","javascript","nodejs","notifications","sqlite3"],"created_at":"2024-09-28T08:41:08.900Z","updated_at":"2026-03-08T08:31:49.096Z","avatar_url":"https://github.com/EternalClan.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ClanNotifyer\n[![Discord server](https://img.shields.io/discord/720746186788831323?color=%237289da\u0026label=discord%20server\u0026logo=discord)](https://discord.gg/cFyC9pmanj)\n[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)\n[![LICENSE](https://img.shields.io/github/license/EternalClan/ClanNotifyer?style=flat-square)](LICENSE)\n[![release](https://img.shields.io/github/v/release/EternalClan/ClanNotifyer?include_prereleases\u0026display_name=release\u0026style=flat-square)](releases)\n[![Build Status](https://github.com/EternalClan/ClanNotifyer/workflows/Node.js%20CI/badge.svg)](https://github.com/EternalClan/ClanNotifyer/actions)\n[![Maintenance](https://img.shields.io/maintenance/yes/2024?style=flat-square)](https://github.com/EternalClan/ClanNotifyer/graphs/commit-activity)\n\n🤖 **A simple, customizable Discord bot that announces Twitch streams (plus a bunch of silly extras).**\n\n## Features\n\n - 📢 Monitor and announce Twitch channels going live with customizable `@mentions`.\n - 🔴 Live stream card that is automatically updated with the stream status, current game and viewership statistics.\n\n## Installation and setup\n\n### Prerequisites\n\nThis bot is built on Node.js. If you do not yet have Node installed, download and install the latest LTS version from the official website for your platform:\n\n[Nodejs.org/downloads/](https://nodejs.org/en/download/)\n\n\u003e [!IMPORTANT]\n\u003e **Node.js, version 18 or higher is required.**\n\n### Installation\n\nTo set up ClanNotifyer, download the latest [Release](https://github.com/EternalClan/ClanNotifyer/releases) or clone it using `git`:\n\n    git clone git@github.com:TamaniWolf/ClanNotifyer.git\n    \nOnce downloaded, extract it from the zip file if needed and enter the directory to install the dependencies:\n\n    cd ClanNotifyer\n    npm install -global pnpm pm2\n    pnpm update\n\n### Configuration\n \nTo configure ClanNotifyer, rename the included `#.env` to `.env`. It should look like this in there:\n\n```.env\n// For Settings in .env use (process.env.) \nTOKEN = \u003cTOKEN\u003e\nPREFIX = cn.\nSHARDED = false\nBOTLANG = en_US\n\n// Twitch\nTWITCH_CLIENT_ID = \u003cID\u003e\nTWITCH_CLIENT_SECRET = \u003cSECRET\u003e\n```\n\n### Getting required tokens\n\n#### Discord bot application\nYour Discord bot needs to be registered as an application, and you will need a bot token  (`TOKEN` in ClanNotifyer's .env).\n\nFollow [this guide](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-\u0026-getting-a-token) to create your own Bot User/Application.\n\n\u003c!--\n#### Twitch token - Manually\n\u003e [!NOTE]\n\u003e This part is only for Educational use and is not necessary for the operation of the bot.\n\nThere are two ways to get your token from Twitch.\n1. Using https://twitchtokengenerator.com/ to create an OAuth token for the API.**\n\n2. Using.\nYou can also begin the authorization flow by completing the authorization prompt yourself:\n \n```\nhttps://id.twitch.tv/oauth2/authorize?client_id=\u003cYOUR_CLIENT_ID_HERE\u003e\u0026response_type=token\u0026redirect_uri=http://localhost\n```\n\nAlternatively, you can register your own application in the [Twitch Developers Console](https://dev.twitch.tv/console/apps).\n\nPlease note that your OAuth token is always tied to a specific Client ID.\n--\u003e\n#### Twitch Token\nWith the bot doing the Token creation itself we only need to provide it with Twitch's Client ID and Client Secret.\n\nTo get both we need to register our own application.\n1. Open [Twitch's Developers Console](https://dev.twitch.tv/console/apps) and click on `Register Your Application`.\n2. Enter the name of your application.\n3. Under `OAuth Redirect URLs` enter `https://localhost`.\n4. Select a Category and Client type, i recommend `Confidential`.\n5. Fillout the captcha and click create.\n\nNow click on Manage and copy the Client ID in to the bots .env file.\nTo get the Client Secret click on New Secret and also copy this to the .env file.\n\n### Starting ClanNotifyer\n\nOnce the application has been configured, start it using `node` from the installation directory:\n\n    node .\n\nOr with the proccess Manager `pm2`.\nFor the first time:\n\n    pm2 start main.js --name \"Name\" --max-memory-restart 250M\n\nAfter adding to pm2 you can start it with the process number or the name:\n\n    pm2 start 1\n    pm2 start Name\n  \n### Inviting ClanNotifyer\n\nSend the following link to the admin of a Discord server to let them invite the Bot:\n\n  `https://discordapp.com/oauth2/authorize?client_id=BOT_CLIENT_ID\u0026scope=bot\u0026permissions=962341628992`\n  \nSwap `BOT_CLIENT_ID` in the URL above for your Discord app's client id, which you can find in the app details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feternalclan%2Fclannotifyer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feternalclan%2Fclannotifyer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feternalclan%2Fclannotifyer/lists"}