WebConsole 开源项目教程

WebConsole 开源项目教程

WebConsole Spigot plugin to manage your server remotely using a web interface 项目地址: https://gitcode.com/gh_mirrors/web/WebConsole

1. 项目介绍

WebConsole 是一个由 mesacarlos 开发的 Spigot 插件，适用于 Minecraft 1.8-1.21+ 版本。该插件允许您从任何地方查看服务器控制台并管理您的服务器。它会在后台创建一个 WebSocket 服务器，供 web 界面发送命令、接收控制台日志和管理服务器使用。

WebConsole 的主要特点包括：

• 多用户系统和查看者模式：您可以创建多个用户并将他们的角色设置为“管理员”或“查看者”。拥有“查看者”角色的用户只能读取控制台、CPU 和内存使用情况。拥有“管理员”角色的用户还可以在服务器上运行命令。
• 命令历史：使用上下箭头键浏览命令历史，就像在真实控制台中一样。
• 支持颜色显示，适用于 Windows 和 Linux 主机。
• 实时显示连接的玩家、机器 CPU 和服务器内存使用信息。
• 支持英语、西班牙语、繁体中文、简体中文、捷克语、德语、荷兰语、法语、意大利语、日语、韩语、葡萄牙语、俄语和土耳其语等多种语言。

2. 项目快速启动

步骤 1：插件安装

1. 从 Releases 下载插件。
2. 将插件上传到您的 Spigot 服务器。
3. 开启并关闭服务器以生成 config.yml 文件`。
4. 打开 config.yml 文件，您将看到以下内容：

useSSL: false
StoreType: JKS
KeyStore: plugins/WebConsole/keystore.jks
StorePassword: storepassword
KeyPassword: keypassword
host: 0.0.0.0
port: 8080
language: en
passwords:
  admin:
  user1:
    password: mySecurePassword
commandWhitelist:
  enabled: true
  commandWhitelistActsAsBlacklist: false
  whitelist:
    - whisper
    - gamemode survival
viewer: {}

配置说明：

• host：保持默认设置 0.0.0.0 即可。如果遇到问题，您可以将其更改为您的设备 IP 地址。
• port：选择一个端口来运行此插件（不能是您用于 Minecraft 的端口）。
• language：您可以修改 language 以查看控制台和命令消息的您喜欢的语言。
• passwords：默认已创建一个名为 user1 的用户，密码为 mySecurePassword。您可以添加或修改管理员或查看者用户。

步骤 2：使用 Web 界面

1. 在浏览器中输入服务器的 IP 地址和配置的端口号（例如 http://your_server_ip:8080）。
2. 输入您的用户名和密码登录。
3. 开始查看和控制台日志，或执行命令。

3. 应用案例和最佳实践

案例一：远程管理服务器

您可以使用 WebConsole 远程连接到您的服务器，并进行以下操作：

• 查看实时控制台日志。
• 运行服务器命令。
• 查看服务器状态，如 CPU 和内存使用情况。

案例二：多用户协作

通过为不同用户设置不同角色，您可以允许多个管理员和查看者共同管理服务器。例如，您可以：

• 创建一个管理员用户来处理服务器配置和命令执行。
• 创建一个查看者用户，让朋友或团队成员监控服务器状态。

4. 典型生态项目

WebConsole 作为 Spigot 插件的一部分，与其他插件和工具共同构成了一个生态系统。以下是一些与之相关的典型项目：

• Spigot：Spigot 是一个基于 Minecraft 服务器的开源项目，它提供了丰富的 API 和插件支持。
• Minecraft：Minecraft 是一个沙盒游戏，允许玩家在一个虚拟世界中建造和探索。

通过这些项目和工具的结合使用，您可以更好地管理和扩展您的 Minecraft 服务器。

WebConsole Spigot plugin to manage your server remotely using a web interface 项目地址: https://gitcode.com/gh_mirrors/web/WebConsole