{"id":24033716,"url":"https://github.com/matejmajny/discord-rpc","last_synced_at":"2025-05-07T22:27:17.067Z","repository":{"id":123373890,"uuid":"541138422","full_name":"matejmajny/Discord-RPC","owner":"matejmajny","description":"Simple custom Discord RPC client built with JavaScript and Python.","archived":false,"fork":false,"pushed_at":"2023-07-18T21:02:28.000Z","size":54,"stargazers_count":1,"open_issues_count":0,"forks_count":8,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-31T14:57:47.562Z","etag":null,"topics":["custom","discord","discordjs","gui","javascript","js","nodejs","rich-presence","rpc"],"latest_commit_sha":null,"homepage":"https://discord.com/developers/applications","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matejmajny.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-09-25T10:46:54.000Z","updated_at":"2023-07-17T14:34:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"11552387-012b-4838-87a5-17d3a77fe8fd","html_url":"https://github.com/matejmajny/Discord-RPC","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matejmajny%2FDiscord-RPC","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matejmajny%2FDiscord-RPC/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matejmajny%2FDiscord-RPC/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matejmajny%2FDiscord-RPC/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matejmajny","download_url":"https://codeload.github.com/matejmajny/Discord-RPC/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252963840,"owners_count":21832578,"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":["custom","discord","discordjs","gui","javascript","js","nodejs","rich-presence","rpc"],"created_at":"2025-01-08T18:38:23.776Z","updated_at":"2025-05-07T22:27:17.017Z","avatar_url":"https://github.com/matejmajny.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Discord RPC\nThis project is using `discord-rpc` (NPM library) and powered by JavaScript (Node.js), it should  run on every common OS (Linux, MacOS, Windows)\n\n## ❗ Register your RPC on Discord website (mandatory for all) ❗\n - Go to https://discord.com/developers/applications\n - Click on `New Application` and name your app by that what you want **title of your RPC to be!**\n - Click on `OAuth2 --\u003e General` and copy your Client ID and store it somewhere for later\n - Click on `Rich Presence --\u003e Art Assets` and upload some images (2) what you want to use later (optional)\n\n## Run the app 🟢\n\n### 1. Install app with installer and use GUI (Windows) \n\n#### Make sure you have installed:\n- [Discord](https://discord.com)\n\n#### How to set it up?\n - Make sure that you have [registered your RPC](https://github.com/matejmajny/Discord-RPC/edit/main/README.md#register-your-rpc-on-discord-website-mandatory-for-all)\n - Download [WindowsInstaller_GUI.exe](https://github.com/matejmajny/Discord-RPC/releases/latest), it may get flagged as virus but it isn't.\n - Process is pretty straightforward from there so it doesn't need further explanation I think.\n\n\n### 2. Running raw code files GUI/CLI (Linux, MacOS, Windows)\n\n#### Make sure you have installed:\n- [Python](https.//python.org) - only if you want to use GUI\n- [NodeJS](https://nodejs.org)\n- [Discord](https://discord.com)\n- [Notepad++](https://notepad-plus-plus.org/downloads/) (Optional - you can choose different program and is not required for GUI)\n\n#### How to set it up?\n - Download [Universal_CLI.zip](https://github.com/matejmajny/Discord-RPC/releases/latest) or `git clone` this repository.\n - Make sure that you have [registered your RPC](https://github.com/matejmajny/Discord-RPC/edit/main/README.md#register-your-rpc-on-discord-website-mandatory-for-all)\n - Edit [config.js](https://github.com/matejmajny/Discord-RPC/tree/main#configjs-configuration-cli-)\n - **CLI:** Run `npm install` and `node index.js` in command line/terminal\n - **GUI:** Run `pip3 install nicegui` and `python3 gui.py` in command line/terminal\n \n\n### 3. Run on background (Linux, MacOS, Windows)\n\n#### Make sure you have installed:\n- [NodeJS](https://nodejs.org)\n- [Discord](https://discord.com)\n- [PM2](https://pm2.keymetrics.io/) (Optional - for app background use)\n- [Notepad++](https://notepad-plus-plus.org/downloads/) (Optional - you can choose different program)\n\n#### How to set it up?:\n\n- Install PM2 if you havent already `npm install pm2 -g`\n- Edit [config.js](https://github.com/matejmajny/Discord-RPC/tree/main#configjs-configuration-cli-)\n- Run `pm2 start index.js` in Command Line/Terminal\n- Run `pm2 list` and check if app is running!\n- Note: This makes app run fully on background, kill it with `pm2 stop \u003cname\u003e`\n\n\n## config.js configuration (CLI) 🔧\n- ***This doesnt need to be done when using GUI.***\n- put everything what should be in mentioned line to \"putItHere\"\n```\n{\n    \"clientID\": \"\", // client ID from discord.dev portal\n    \"largeImage\": \"\", // name of image (big) uploaded on discord.dev\n    \"largeImageText\": \"\", // comment to display after hovering mouse on large image\n    \"smallImage\": \"\", // name of image (small) uploaded on discord.dev\n    \"smallImageText\": \"\", // comment to display after hovering mouse on smal image\n    \"state\": \"\", // state what you want to display\n    \"details\": \"\", // details what you want to display\n    \"button1\": \"\", // button 1 text\n    \"buttonURL1\": \"\", // button 1 URL\n    \"button2\": \"\", // button 2 text\n    \"buttonURL2\": \"\" //button 2 URL\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatejmajny%2Fdiscord-rpc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatejmajny%2Fdiscord-rpc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatejmajny%2Fdiscord-rpc/lists"}