WebConsole

WebConsole is a Fabric modification designed for Minecraft version 1.18 and above. This tool enables remote server management and console viewing through a web interface. In the background, the module runs a WebSocket server that facilitates interaction with the web client for sending commands, receiving console logs, and server administration.

Data security and privacy are maintained at a high level: all information is stored locally in your browser, and the connection is established directly with the Minecraft server, bypassing intermediate web servers.

Key Features

• Multi-user system with permission management: Create multiple accounts with "Administrator" or "Viewer" roles. Users with the "Viewer" role can only view the console, CPU load, and RAM usage, while administrators have the right to execute commands on the server. Configuration of command whitelists and blacklists is also available.
• Command history: Navigate through the history of entered commands using the "up" and "down" keys, similar to the standard console.
• Color support: Correct display of color codes on both Windows and Linux.
• Real-time monitoring: Track the number of connected players, CPU resource usage, and server RAM consumption.
• Multithreading: Simultaneous maintenance of active connections with multiple servers for continuous log collection.
• Multilingual interface: Support for English, Spanish, Chinese, Czech, German, Dutch, French, Italian, Japanese, Korean, Portuguese, Russian, and Turkish languages.
• Free usage: The modification is distributed without any payments.

Mod Installation

1. Download the mod file from the official releases page.
2. Start the server to automatically create the webconsole.json5 configuration file.
3. Ensure that the ports for the client and socket are forwarded through the router.

Configuration Settings

• host: It is recommended to leave the value as 0.0.0.0. If problems occur, you can specify the device's local IP address. For servers with a dedicated IP, specify the public address.
• useIntegratedWebServer: Determines whether the built-in web server for the client will be activated.
• clientPort: Port for the built-in web server (requires forwarding when activated).
• socketPort: Port for the WebSocket server (mandatory for forwarding).
• language: Interface language selection. Available options: en, es, zh, cs, de, nl, fr, it, ja, ko, pt, ru, tr. Important: In Windows, there may be issues with character display when using non-English languages.
• users: Configuration of users with different access levels. By default, an example "admin" account is created.

The remaining parameters are responsible for SSL configuration. SSL activation is not mandatory but is required when hosting the client on HTTPS servers.

Using the Web Interface

By default, the mod launches a built-in web server for the client along with the WebSocket server:

• WebSocket server is available at host:socketPort
• Web server uses the clientPort
• The built-in web server can be disabled via the useIntegratedWebServer parameter

The web interface can be downloaded from official release pages, including a version with support for multiple servers.

Checking Connected Clients

Starting from version 1.3, the /WebConsole command is available to view the number of connected clients and their IP addresses. Executing the command requires the webconsole.webconsole permission.

Technical Information

A detailed description of the communication protocol between the client and server is available in the corresponding documentation.

Support and Feedback

Bug reports, improvement suggestions, and configuration questions are accepted through the issue system on GitHub.