{"id":29814483,"url":"https://github.com/aarush0101/rich-presence","last_synced_at":"2026-04-11T21:10:34.854Z","repository":{"id":303528895,"uuid":"898581899","full_name":"aarush0101/Rich-Presence","owner":"aarush0101","description":"Rich presence stimulated through Discord WebSocket based connection.","archived":false,"fork":false,"pushed_at":"2025-07-28T00:37:21.000Z","size":327,"stargazers_count":1,"open_issues_count":12,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-28T02:30:26.483Z","etag":null,"topics":["discord","educational","rich-presence","rpc","websocket"],"latest_commit_sha":null,"homepage":"https://discord.com/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/aarush0101.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","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,"zenodo":null}},"created_at":"2024-12-04T16:47:17.000Z","updated_at":"2025-07-16T09:58:08.000Z","dependencies_parsed_at":"2025-07-16T17:57:47.441Z","dependency_job_id":null,"html_url":"https://github.com/aarush0101/Rich-Presence","commit_stats":null,"previous_names":["aarush0101/rich-presence"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/aarush0101/Rich-Presence","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aarush0101%2FRich-Presence","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aarush0101%2FRich-Presence/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aarush0101%2FRich-Presence/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aarush0101%2FRich-Presence/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aarush0101","download_url":"https://codeload.github.com/aarush0101/Rich-Presence/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aarush0101%2FRich-Presence/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267571220,"owners_count":24109383,"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","status":"online","status_checked_at":"2025-07-28T02:00:09.689Z","response_time":68,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","educational","rich-presence","rpc","websocket"],"created_at":"2025-07-28T19:18:06.335Z","updated_at":"2025-10-28T07:32:29.579Z","avatar_url":"https://github.com/aarush0101.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e [!WARNING]\n\u003e THIS REPOSITORY IS ONLY FOR EDUCATIONAL PURPOSES AND IS NOT INTENDED FOR BREAKING DISCORD'S TERMS OF SERVICE. USE AT YOUR OWN RISK.\n\n# Rich Presence\n\n![Version](https://img.shields.io/badge/version-1.0.2-blue.svg)\n![License](https://img.shields.io/badge/license-MIT-green.svg)\n![Node](https://img.shields.io/badge/node-\u003e=22.16.0-brightgreen.svg)\n\nA rich presence integration for Discord, allowing you to display custom activity statuses for your Discord account.\n\n## Table of Contents\n\n- [Features](#features)\n- [Prerequisites](#prerequisites)\n- [Installation](#installation)\n- [Configuration](#configuration)\n- [Usage](#usage)\n- [Commands](#commands)\n- [Docker Support](#docker-support)\n- [Troubleshooting](#troubleshooting)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n\n- Set custom Discord Rich Presence status\n- Multiple account support via token-based authentication\n- Control via Discord bot commands\n- Status customization (name, details, state, images, timestamps)\n- Keep-alive server option\n- Docker support\n- Command-line interface\n\n## Prerequisites\n\n- [Node.js](https://nodejs.org/) (version 22.16.0 or higher)\n- [npm](https://www.npmjs.com/) (included with Node.js)\n- A Discord account and user token\n- A Discord bot token (for command control)\n- A server or always-on machine to host the application\n\n## Installation\n\n### Method 1: Local Installation\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/aarush0101/Rich-Presence.git\n   cd Rich-Presence\n   ```\n\n2. Install dependencies:\n\n   ```bash\n   npm install\n   ```\n\n3. Create a configuration file by copying the example:\n\n   ```bash\n   cp .env.example .env\n   ```\n\n4. Edit the `.env` file with your settings (see [Configuration](#configuration))\n\n### Method 2: Docker Installation\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/aarush0101/Rich-Presence.git\n   cd Rich-Presence\n   ```\n\n2. Create and configure your `.env` file as above\n\n3. Build and run the Docker container:\n   ```bash\n   docker build -t rich-presence .\n   docker run -d --name rich-presence --env-file .env rich-presence\n   ```\n\n## Configuration\n\nThe application is configured via the `.env` file. Copy the `.env.example` file and modify the values as needed:\n\n### Required Settings\n\n| Variable      | Description                                                          |\n| ------------- | -------------------------------------------------------------------- |\n| `START`       | Set to `true` to enable the application                              |\n| `BOT_TOKEN`   | Your Discord bot token for command control                           |\n| `USER_TOKENS` | Comma-separated list of Discord user tokens to set Rich Presence for |\n| `PREFIX`      | Command prefix for the bot (e.g., `!`)                               |\n\n### Rich Presence Settings\n\n| Variable          | Description                                                                       |\n| ----------------- | --------------------------------------------------------------------------------- |\n| `NAME`            | Activity name (e.g., \"Minecraft\")                                                 |\n| `DETAILS`         | First line of Rich Presence (e.g., \"Playing Hypixel\")                             |\n| `STATE`           | Second line of Rich Presence (e.g., \"In Progress\")                                |\n| `TYPE`            | Activity type (0: Playing, 1: Streaming, 2: Listening, 3: Watching, 5: Competing) |\n| `STATUS`          | User status (online, idle, dnd, invisible)                                        |\n| `LARGE_IMAGE_URL` | URL for the large image (use `mp:` prefix for media proxy URLs)                   |\n| `LARGE_TEXT`      | Text shown when hovering over the large image                                     |\n| `SMALL_IMAGE_URL` | URL for the small image (use `mp:` prefix for media proxy URLs)                   |\n| `SMALL_TEXT`      | Text shown when hovering over the small image                                     |\n| `TIMESTAMPS`      | Set to `true` to show elapsed time                                                |\n\n### Optional Settings\n\n| Variable       | Description                                         |\n| -------------- | --------------------------------------------------- |\n| `SERVER_ID`    | Specific server ID for the bot (optional)           |\n| `START_SERVER` | Set to `true` to enable the keep-alive HTTP server  |\n| `PORT`         | Port for the keep-alive server (default: 8080)      |\n| `HOST`         | Host for the keep-alive server (default: localhost) |\n| `NO_ACTIVITY`  | Set to `true` to disable Rich Presence activity     |\n\n## Usage\n\n### Starting the Application\n\nRun the application using npm:\n\n```bash\nnpm start\n```\n\nOr directly with Node.js:\n\n```bash\nnode index.js\n```\n\nUsing the provided shell script:\n\n```bash\n./start.sh\n```\n\n### Bot Commands\n\nOnce the bot is running, you can control it using commands in a Discord server where the bot is present:\n\n| Command                    | Description                                                           |\n| -------------------------- | --------------------------------------------------------------------- |\n| `!help`                    | Show available commands                                               |\n| `!ping`                    | Check if the bot is responsive                                        |\n| `!start`                   | Start Rich Presence for all configured tokens                         |\n| `!start \u003cindex\u003e`           | Start Rich Presence for a specific token by index                     |\n| `!stop`                    | Stop Rich Presence for all tokens                                     |\n| `!stop \u003cindex\u003e`            | Stop Rich Presence for a specific token by index                      |\n| `!restart`                 | Restart Rich Presence for all tokens                                  |\n| `!restart \u003cindex\u003e`         | Restart Rich Presence for a specific token by index                   |\n| `!status`                  | Check the status of Rich Presence connections                         |\n| `!status \u003cindex\u003e \u003cstatus\u003e` | Change the status for a specific token (online, idle, dnd, invisible) |\n\n## Docker Support\n\nThe application includes a Dockerfile for containerized deployment:\n\n```bash\n# Build the image\ndocker build -t rich-presence .\n\n# Run the container\ndocker run -d --name rich-presence --env-file .env rich-presence\n\n# View logs\ndocker logs rich-presence\n\n# Stop the container\ndocker stop rich-presence\n```\n\n## Troubleshooting\n\n### Common Issues\n\n1. **Invalid Token Error**\n   - Ensure your user tokens and bot token are valid and properly formatted\n   - Check if the tokens have the necessary permissions\n\n2. **Connection Errors**\n   - Check your internet connection\n   - Verify the Discord Gateway URL in settings.conf\n   - Ensure you're not being rate-limited by Discord\n\n3. **Bot Not Responding**\n   - Verify the bot is online\n   - Check if the bot has the necessary permissions\n   - Ensure the prefix is correctly set in the .env file\n\n4. **Activity Not Showing**\n   - Check if `NO_ACTIVITY` is set to `false`\n   - Ensure `TYPE` is not set to 4 (which is not allowed)\n   - Verify your URLs are correctly formatted\n\n### Logs\n\nThe application logs information to the console. Look for error messages that might indicate the source of problems.\n\n## Contributing\n\nContributions are welcome! Please read the [CONTRIBUTING.md](/.github/CONTRIBUTING.md) file for guidelines.\n\n1. Fork the repository\n2. Create a feature branch: `git checkout -b feature-name`\n3. Commit your changes: `git commit -am 'Add some feature'`\n4. Push to the branch: `git push origin feature-name`\n5. Submit a pull request\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faarush0101%2Frich-presence","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faarush0101%2Frich-presence","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faarush0101%2Frich-presence/lists"}