{"id":16215734,"url":"https://github.com/3ddelano/pc-statbot","last_synced_at":"2025-03-19T10:30:23.990Z","repository":{"id":41244612,"uuid":"372546097","full_name":"3ddelano/pc-statbot","owner":"3ddelano","description":"A self hosted Discord bot to display your pc stats.","archived":false,"fork":false,"pushed_at":"2022-10-13T07:08:58.000Z","size":280,"stargazers_count":11,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-17T06:03:06.539Z","etag":null,"topics":["bot","discord","discordjs","nodejs","pc","stat","stat-bot","stats"],"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/3ddelano.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}},"created_at":"2021-05-31T15:07:06.000Z","updated_at":"2025-02-12T22:50:56.000Z","dependencies_parsed_at":"2023-01-19T23:47:13.685Z","dependency_job_id":null,"html_url":"https://github.com/3ddelano/pc-statbot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3ddelano%2Fpc-statbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3ddelano%2Fpc-statbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3ddelano%2Fpc-statbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3ddelano%2Fpc-statbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3ddelano","download_url":"https://codeload.github.com/3ddelano/pc-statbot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244407613,"owners_count":20447821,"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","nodejs","pc","stat","stat-bot","stats"],"created_at":"2024-10-10T11:16:07.092Z","updated_at":"2025-03-19T10:30:23.613Z","avatar_url":"https://github.com/3ddelano.png","language":"JavaScript","funding_links":["https://www.buymeacoffee.com/3ddelano"],"categories":[],"sub_categories":[],"readme":"# PC STAT BOT\n### A self hosted Discord bot to display your pc stats.\n\n\u003cimg alt=\"Nodejs\" src=\"https://img.shields.io/badge/-Node.js-43853d?style=flat-square\u0026logo=Node.js\u0026logoColor=white\" /\u003e\n\u003cbr\u003e\n\n\u003cimg alt=\"screenshot\" src=\"./_assets/screen.png\" /\u003e\n\n# Features\n- ### Displays stats like CPU Usage, Memory, Storage and Battery\n- ### View or share your PC stats with anyone on Discord\n- ### Easy to get started\n- ### One of a kind\n- ### Modular design\n\n\n# Installation\nDownload the repo as a zip and extract it to a folder. Open a command prompt in that folder and and then run the command `npm install` or `yarn install` (needs [Node.js](https://nodejs.org/)).\n- Rename the file `config_example.json` to `config.json`.\n- Goto [Discord Developer Page](https://discord.com/developers/applications) and make a new application.\n- Give it any name.\n- Then go to the OAuth2 tab and copy the ClientID and paste it in the `config.json` file \u003cimg alt=\"copy client id from General information tab\" src=\"./_assets/oauth_clientid.png\"\u003e\n- Copy the token value from the Bot tab and paste it in the `config.json` file \u003cimg alt=\"copy token from Bot tab\" src=\"./_assets/bot_token.png\"\u003e\n- In the same Bot tab, scroll down and make sure that the 'Message Content' priviledged intent is enabled. \u003cimg alt=\"enable message content intent from Bot tab\" src=\"./_assets/bot_messagecontent.png\"\u003e\n\n\n# Usage\nEither run `start.cmd` or open a terminal and run `node server.js`\n\u003cbr\u003e\nFor the first run, click on the invite link in the terminal and add the bot to whichever server you want, then goto any channel in that server where you want the stats and type `s.start`\n\n## Commands\n- `s.help` - Shows a help message\n- `s.ping` - Check API latency\n- `s.start` - Start the bot (run this only the first time)\n- `s.stop` - Stop the bot\n\n\n## config.json\nThis is the configuration file used by the program.\n\n| Key              | Type                       | Value                                                                                                    |\n| ---------------- | -------------------------- | -------------------------------------------------------------------------------------------------------- |\n| token            | string                     | The token of the bot from Discord Developer Page                                                         |\n| clientID         | string                     | The client ID of the bot from Discord Developer Page                                                     |\n| interval         | integer                    | The time in seconds to wait before updating the stats each time                                          |\n| title            | string                     | Will be displayed in the first row of the Bot message                                                    |\n| displayActivity  | boolean          \\| string | Whether to show a presence for the bot. If it is a string, thent the presence will be set to that value. |\n| displayTimestamp | boolean\\|string            | Which timestamp format should be displayed. One of true, false, '24h' or '12h'                           |\n| components       | object                     | An object with key as component name and value as enabled status                                         |\n\n## Available Components\n\n| Name         | Description                                  |\n| ------------ | -------------------------------------------- |\n| battery      | Shows battery percentage and charging status |\n| memoryUsage  | Shows used memory and total memory           |\n| cpuUsage     | Shows CPU usage percentage                   |\n| storageUsage | Shows used storage and total storage         |\n\n## Example config.json\n```json\n{\n    \"token\": \"token from bot section of discord developer page\",\n    \"clientID\": \"client id from oauth2 section of discord developer page\",\n    \"interval\": 30,\n    \"title\": \"pc-statbot\",\n    \"displayActivity\": \"Stats for Delano's PC. See s.help\",\n    \"displayTimestamp\": true,\n    \"components\": {\n      \"battery\": true,\n      \"cpuUsage\": true,\n      \"memoryUsage\": true,\n      \"storageUsage\": true\n    }\n  }\n```\n\n## Bugs / Suggestions\nReport any bugs / glitches, or make a suggestion using the github issues section or join the support server [Join Server](https://discord.gg/FZY9TqW).\n\n## Other bots\nCheck out my other bots\n- [Delano Tatusmi](https://delano-tatsumi.herokuapp.com)\n- [House Builder](https://house-builder.herokuapp.com)\n\n## Support\nJoin the Discord Server: [3ddelano Cafe](https://discord.gg/FZY9TqW)\n\u003cbr\u003e\nSupport the creator\n\u003cbr\u003e\n\u003ca href=\"https://www.buymeacoffee.com/3ddelano\" target=\"_blank\"\u003e\u003cimg height=\"41\" width=\"174\" src=\"https://cdn.buymeacoffee.com/buttons/v2/default-red.png\" alt=\"Buy Me A Coffee\" width=\"150\" \u003e\u003c/a\u003e\n\n## Contributors\n- [LukasL28](https://github.com/LukasL28)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3ddelano%2Fpc-statbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3ddelano%2Fpc-statbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3ddelano%2Fpc-statbot/lists"}