Websend is a spigot/paper plugin for minecraft servers. Websend enables PHP developers to access minecraft commands from a web-based script. It allows in-game commands to execute PHP scripts and in return also execute actions in-game through PHP scripts.

• Put the plugin in the plugin folder.
• Restart the server to allow the configuration file to be generated.
• Stop the server.
• Edit the configuration file.
• Start the server
• run a command as player or console, such as /ws test

Note that a server restart is required to apply the changes to the configuration files.

This allows you to execute PHP scripts by typing in-game commands. Websend creates a HTTP POST request to a URL you give and parses the response given by PHP.

• Open the “minecraft.php” file included in the Websend download.
• Set the password variable to the password specified in the Websend configuration file.
• Upload this file to your website.
• Open the Websend plugin configuration file.
• Set the "URL=" option to the url of your php file.
• Start your Bukkit server.
• Try command “/ws argument1 argument2”. Just /ws will return an "Empty argument" error

Use the command /ws argument0 argument1 or /websend argument0 argument1 to start a request from Spigot to PHP. You can add any number of arguments. These will be passed to your PHP script.

When Websend sends its request it includes information in the POST data. Most of the data is contained in a JSON string under $_POST['jsonData'], unless GZIP_REQUESTS is enabled, in which case it is available in gzip form under $_FILES['jsonData']. Whether the JSON data is compressed or not is specified under the $_POST['isCompressed'] variable. The $_POST['authKey'] variable contains the hashed password and the $_POST['args'][] has the arguments.

You can respond to the request by simply printing commands with print() or echo. Websend will then parse and execute these commands in the order that they were printed.

ATTENTION: Since Websend 5.x, replies need to be sent in JSON Format and be terminated with CHR(10) which is a linefeed There is no more colon (;) needed to terminate. Newer NBT codes in Minecraft use a colon and break the old method of terminating a line with a colon. \n or \r instead of CHR(10) do not work. Ideally, this is done with a small PHP Function such as:

<?php
// array key capitalization is relevant.
function websend_command($action, $command = '', $targetPlayer = null) {
    $websend_array = array(
        // this is the action you want to do (see list below)
        'action' => $action,
        // use this in case you have a target player other than the user who ran the command in-game
        'targetPlayer' => $targetPlayer,
        // this is the command/text to be executed/displayed
        'command' => $command,
    );

    // json-encode the array and append the terminating CHR(10) to conclude
    $json = json_encode($websend_array) . CHR(10);

    // finally send this to websend.
    print($json);
}
?>

Please see the included minecraft.php for an example how this works.

You can execute this function several times to do several things in sequence. Please note that minecraft will do commands with the same action in sequence, but there is a risk that commands such as ExecuteConsoleCommand take longer than PrintToConsole. So if you execeute a PrintToConsole after a ConsoleCommand, the PrintToConsole might still happen first.

A text send to the player or console can contain a line break with \n. This line break will be executed on the console and on the user screen.

The action needs to be one of the following types, capitalization is not relevant:

• PrintToConsole: Prints whatever the command is set to the console. In-game players won't see this. The targetPlayer argument is ignored and should be null.
• PrintToPlayer: Prints whatever the command is set to as a message to a player currently playing on your server. If you provide targetPlayer, this will be the target, otherwise it will be who
• Broadcast: Broadcasts whatever the command is set to to all players currently playing on the server.
• ExecutePlayerCommand: Executes whatever the command is set as a player currently playing on your server. By using "targetPlayer", you can specify the player to set as command source, otherwise the command will be ran as the player that started the websend request. This allows you to 'force' a user to execute a command.
• ExecuteConsoleCommand: Executes hatever the command is set to as if it was entered directly on the server console.
• toggleDebug: Switches debug on or off. If you call this action with empty command (''), it will just toggle the status. Alternatively set a status with the command 'on' or 'off'. targetPlayer needs to be null. ATTENTION: If you have basic issues to get websend running, you need to set debug on in the plugin config, not here as this switch will only become active after a successful connection with websend is established.
• executeScript: Runs a script. The script (specified by command) that has to be in the Websend scripts directory and has to be compiled and loaded before this is run.
• setResponseURL: Changes the responseURL as set in the websend config file to whatever is set in command. targetPlayer needs to be null.

You can initiate a command to the server via a PHP script as well. For this, you need the Websend.php file from the plugin directory. It contains a class that connects to the minecraft server and manages the communication. Further, you need a PHP script that loads the class and executes a command. There is an example ExternalTimeSet.php in the plugin directory. The default port is 4445. Please make sure that your minecraft server is able to listen to that port.

The base process is as follows:

    <?php
    // you include the Websend class
    require_once 'Websend.php';
    // You connect to the IP/DNS of your minecraft server
    $ws = new Websend("172.0.0.1");
    // You set the password as configured in the plugin config
    $ws->password = "websendpassword";

   // you attempt to connect
   if($ws->connect()) {
        // execute an action on the server
        $check = $ws->doCommandAsConsole("time set 6000");
        // the check is returning true or false
        if (!$check) {
            echo "Failure to set time";
        } else {
            echo "Time set.";
        }
   } else {
        echo "Failed to connect.";
   }
   $ws->disconnect();

There are several commands that can be executed on the minecraft server, similar to the Spigot->PHP direction:

• $ws->doCommandAsConsole($cmd);: Executes a command on the console
• $ws->doCommandAsPlayer($cmd, $player);: Executes a command as if done by a player
• $ws->writeOutputToConsole($cmd);: Writes text to the console
• $ws->writeOutputToPlayer($cmd, $player);: Writes text to a player
• $ws->broadcast($cmd);: Broadcasts text to all players
• $ws->doScript($cmd);: Executes a script.