{"id":27415464,"url":"https://github.com/derdeathraven/steam-comment-bot-rest-api","last_synced_at":"2025-07-24T12:19:43.254Z","repository":{"id":177230614,"uuid":"649281860","full_name":"DerDeathraven/steam-comment-bot-rest-api","owner":"DerDeathraven","description":"The official REST-API for the steam comment bot","archived":false,"fork":false,"pushed_at":"2024-08-12T14:42:20.000Z","size":147,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-06T00:45:58.047Z","etag":null,"topics":["plugin","rest-api","rpc","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DerDeathraven.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2023-06-04T11:19:26.000Z","updated_at":"2025-01-05T15:47:22.000Z","dependencies_parsed_at":"2024-03-03T15:25:33.171Z","dependency_job_id":"6e7530a3-eaa7-440d-a004-db6408e6d951","html_url":"https://github.com/DerDeathraven/steam-comment-bot-rest-api","commit_stats":null,"previous_names":["derdeathraven/steam-comment-bot-rest-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DerDeathraven%2Fsteam-comment-bot-rest-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DerDeathraven%2Fsteam-comment-bot-rest-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DerDeathraven%2Fsteam-comment-bot-rest-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DerDeathraven%2Fsteam-comment-bot-rest-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DerDeathraven","download_url":"https://codeload.github.com/DerDeathraven/steam-comment-bot-rest-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248853358,"owners_count":21172121,"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":["plugin","rest-api","rpc","typescript"],"created_at":"2025-04-14T09:27:08.712Z","updated_at":"2025-04-14T09:27:09.526Z","avatar_url":"https://github.com/DerDeathraven.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Steam Comment Bot Rest API\n[![wakatime](https://wakatime.com/badge/user/baf819ad-1920-42f7-9957-867bec17c57c/project/db6c09fc-2c22-4d21-b978-9823fc32538f.svg)](https://wakatime.com/badge/user/baf819ad-1920-42f7-9957-867bec17c57c/project/db6c09fc-2c22-4d21-b978-9823fc32538f)\n\nA Rest API for the [Steam Comment Bot](https://github.com/3urobeat/steam-comment-service-bot)\n\n## Headless\n\nThis Plugin supports headless mode. This deactivates the frontend but still provides all the functionality\nfor that change the config file like this:\n\n```json\n{\n  \"headless\": true\n}\n```\n\n## Frontend\n\nAn official frontend is currently under development. The source code can be found [here](https://github.com/DerDeathraven/steam-comment-service-bot-frontend)\n\nversion 1.0 will be shipped with this plugin when ready\n\n## Implementation\n\nThis Plugins uses RPC to communicate with the backend\nCalls look like this:\n`localhost:4000/rpc/${Class}.${MethodName}?${params}`\n\nRequest can either be GET or POST for POST params are taken from the body \u003cbr /\u003e\nthis allows longer strings of texts or similar to be parsed\n\n## SDK\n\nThis plugin comes with an [SDK](./Client/SDK.ts) file that helps with the development of clients\n\n## Doc\n\n```typescript\nclass Bots {\n  botCount(); // returns the amount of bots present\n  getBots(); // returns an array of Bot objects\n  addBot(name: string, password: string); // starts the authentication process and returns the index for the steamguard function\n  removeBot(name: string); // removes the specified bot from the bot pool please note that it will be back after reboot\n  submitSteamGuardCode(botIndex: string, steamGuardCode: string); // enters the steamguard code\n}\n```\n\n```typescript\nclass Settings {\n  getQuoteFile(); // Returns the content of the quote file\n  setQuoteFile(quoteFile: string); // sets the content of the quote file\n  getPlugins(); // returns an array of installed plugins\n  getBootTime(); // returns the time needed to start\n}\n```\n\n```typescript\nclass Comment {\n  comment(count: string, steamID: string); // Starts a comment que\n  commentCount(); // Returns the number of comments since the last reboot\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fderdeathraven%2Fsteam-comment-bot-rest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fderdeathraven%2Fsteam-comment-bot-rest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fderdeathraven%2Fsteam-comment-bot-rest-api/lists"}