README
Vapor Admin Commands Plugin
Vapor plugin which adds several useful admin commands.
Features
- Adds bunch of useful admin commands
- All changes are optionally persisted back to config file in JSON format
Installation
npm install vapor-admin-commands
Usage
var adminCommands = require('vapor-admin-commands');
// Instantiate Vapor etc.
vapor.use(adminCommands);
// or
vapor.use(adminCommands, {configPath: './myConfig.json'});
Configuration
(optional) configPath
Path to your configuration file.
If set, this plugin will take Vapor's config and persist the changes (name or state) into this file in a JSON format. This option should be only enabled if the given path matches the config file used to initialize your Vapor instance.
Events
message:*
message
- A message string.
Standard message events to be used with logger.
Commands
Command | Description | Example |
---|---|---|
!set name {displayName} |
Changes bot's display name. Limit for the name is 32 characters. | !set name Banana Bot |
!set state {stateName} |
Changes bot's online state. | !set state trade |
!disconnect |
Disconnects from Steam network. | * |
!help |
Lists all available admin commands | * |
The list of commands is currently fairly short. More will be added if necessary.
Feel free to open an issue if you have an idea for a command.
License
MIT. See LICENSE
.