https://github.com/derdeathraven/steam-comment-bot-rest-api
The official REST-API for the steam comment bot
https://github.com/derdeathraven/steam-comment-bot-rest-api
plugin rest-api rpc typescript
Last synced: 8 months ago
JSON representation
The official REST-API for the steam comment bot
- Host: GitHub
- URL: https://github.com/derdeathraven/steam-comment-bot-rest-api
- Owner: DerDeathraven
- Created: 2023-06-04T11:19:26.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-12T14:42:20.000Z (over 1 year ago)
- Last Synced: 2025-04-06T00:45:58.047Z (12 months ago)
- Topics: plugin, rest-api, rpc, typescript
- Language: TypeScript
- Homepage:
- Size: 144 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Steam Comment Bot Rest API
[](https://wakatime.com/badge/user/baf819ad-1920-42f7-9957-867bec17c57c/project/db6c09fc-2c22-4d21-b978-9823fc32538f)
A Rest API for the [Steam Comment Bot](https://github.com/3urobeat/steam-comment-service-bot)
## Headless
This Plugin supports headless mode. This deactivates the frontend but still provides all the functionality
for that change the config file like this:
```json
{
"headless": true
}
```
## Frontend
An official frontend is currently under development. The source code can be found [here](https://github.com/DerDeathraven/steam-comment-service-bot-frontend)
version 1.0 will be shipped with this plugin when ready
## Implementation
This Plugins uses RPC to communicate with the backend
Calls look like this:
`localhost:4000/rpc/${Class}.${MethodName}?${params}`
Request can either be GET or POST for POST params are taken from the body
this allows longer strings of texts or similar to be parsed
## SDK
This plugin comes with an [SDK](./Client/SDK.ts) file that helps with the development of clients
## Doc
```typescript
class Bots {
botCount(); // returns the amount of bots present
getBots(); // returns an array of Bot objects
addBot(name: string, password: string); // starts the authentication process and returns the index for the steamguard function
removeBot(name: string); // removes the specified bot from the bot pool please note that it will be back after reboot
submitSteamGuardCode(botIndex: string, steamGuardCode: string); // enters the steamguard code
}
```
```typescript
class Settings {
getQuoteFile(); // Returns the content of the quote file
setQuoteFile(quoteFile: string); // sets the content of the quote file
getPlugins(); // returns an array of installed plugins
getBootTime(); // returns the time needed to start
}
```
```typescript
class Comment {
comment(count: string, steamID: string); // Starts a comment que
commentCount(); // Returns the number of comments since the last reboot
}
```