Documentation for appchat04rel64.dll

The appchat04rel64.dll plugin extends the Squirrel scripting environment by adding a function and a callback for web communication. It includes WebSocket server functionality and integrates with Squirrel scripts to handle web messages.

Plugin Features

• WebSocket Server: Starts a WebSocket server on port 8080.
• Function: Adds a function to the Squirrel module.
• Callback: Registers a callback to handle incoming messages.

Function

SendWebMessage(string message)

Description: Sends a text message to the WebSocket server.

Parameters:

• message (string): The text message to be sent.

Returns: Always returns 1, indicating successful execution.

local result = SendWebMessage("Hello, WebSocket!");

WebSocket Server

Include these to your cfg

rcon_password password
wsport 8080
wsannounce 1

Installation

1. Place appchat04rel64.dll in the appropriate plugin directory for your Squirrel environment.
2. Ensure that the WebSocket server port (8080) is available and not blocked by firewall rules, else you can use a different port
3. Make sure your wsport are also forwarded in order to connect with VCMP Forum App

Notes

• Ensure that the WebSocket server port does not conflict with other services.
• The SendWebMessage function always returns 1, regardless of the actual sending result. Error handling should be done on the WebSocket server side if needed.

Admin Game Commands Documentation

This document provides an overview of the available commands for administrators to control web clients in the game. These commands allow admins to manage and interact with connected clients by their client IDs.

Commands Overview

Additional Notes

• Ensure you have the necessary admin permissions to execute these commands.
• The client-id must be valid and currently connected for the command to succeed.
• Misuse of admin commands can disrupt client connections and gameplay; use them responsibly.
• You can use rcon04rel64.dll to login by rcon and then use commands else you should have (player.IsAdmin=true) to make cmds work
• Note that the above mentioned commands are not required to be scripted in server
• The banned player ips can be find here yourvcmpserverpath/vcmp-svr.banlist and removed if required

Documentation for rcon04rel64.dll

The rcon04rel64.dll plugin lets u login as server admin by adding it to server.cfg

Server.cfg

• plugins/ rcon04rel64.dll
• server.cfg plugins rcon04rel64
• rcon_password urpassword
• Usage: /rcon login urpassword