FYI: This package is an addon for ScriptServer and requires ScriptServer to be set up, please see here for more information.
While in root directory of your server run:
npm install scriptserver-command
And in your server
file:
server.use(require('scriptserver-command'));
The prefix scriptserver-command uses for commands is interchangable. What you pass in is parsed as regex, so you can do something as simple as a single character like the default ~
, or a wider variety of them with [~!.\]
.
The following is the default configuration:
const server = new ScriptServer({
command: {
prefix: '~'
}
});
This module provides the following interface for adding custom server commands to be used in the ingame chat. The provided callback will be invoked when a player types the specified command into chat prefixed with specified prefix. (Defaults to ~
).
// Registers the command ~spawn to the following function
server.command('spawn', event => {
// Person who sent command
var commandSender = event.player;
// Command used (in this case, spawn)
var command = event.command;
// Array of arguments passed after command (in this case useless)
var arguments = event.args;
// Timestamp of when the command was sent
var timestamp = event.timestamp;
var spawnLocation = { x: 0, y: 70, z: 0 };
server.send(`tp ${commandSender} ${spawnLocation.x} ${spawnLocation.y} ${spawnLocation.z}`);
});