WorldEditDisplay
一款服务器端 WorldEdit 选择区域可视化插件
关于
WorldEditDisplay 是一款 Minecraft 服务器端插件,为 WorldEdit 添加了可视化的选择区域渲染功能。它拦截 WorldEdit 的 CUI(客户端用户界面)协议数据包,并在服务器端使用显示实体(Display Entities)来渲染选择区域。这意味着玩家无需安装任何客户端模组即可看到他们的 WorldEdit 选择区域。
功能
选择类型
- 长方体(Cuboid)- 带有边缘线和网格显示的盒状选择
- 多边形(Polygon)- 带有垂直柱体的二维多边形边界
- 椭球体(Ellipsoid)- 平滑的椭圆选择
- 圆柱体(Cylinder)- 高度可调的圆形选择
- 多面体(Polyhedron)- 复杂的三维多面体结构
视觉渲染
- 使用 Minecraft 的显示实体(TextDisplay)系统
- 所有视觉元素均可自定义十六进制颜色(#RRGGBBAA)
- 可调节的线条粗细和网格密度
- 对长方体、多边形和多面体区域支持半透明面填充
- 网格叠加层便于计算尺寸
多语言支持
界面支持多种语言,并自动检测客户端语言:
玩家设置
玩家可以自定义自己的渲染偏好:
- 选择元素的首选十六进制颜色
- 启用或禁用面填充
- 在服务器限制范围内调整线条粗细
- 控制网格间距和密度
- 更改立即生效
选择共享
- 实时与其他玩家共享你的 WorldEdit 选择区域
- 通过
/wedisplay share 邀请、接受、撤销和取消观察共享
- 每个共享的选择区域都会以唯一生成的自动颜色显示
- 共享关系在服务端重启后依然保留
全览模式 (默认仅限管理员)
- 通过
/wedisplay view 切换监控所有在线玩家选择区域的状态
- 从你的视图中隐藏特定玩家、切换名称标签以及列出被监控的玩家
配置系统
config.yml 中的全局服务器默认设置
player_config/*.yml 中的单个玩家覆盖设置
- 热重载,无需重启服务器
要求
- Minecraft 1.20 ~ 1.21.x (Paper / Folia / Spigot)
- Java 21 或更高版本
- 所需插件:
安装
- 确保服务器上已安装 WorldEdit 和 PacketEvents
- 下载
WorldEditDisplay.jar
- 将其放入服务器的
plugins 文件夹中
- 重启服务器
- 如有需要,编辑
plugins/WorldEditDisplay/config.yml
- 使用
/wedisplayreload 重新加载配置
命令
管理员命令
/wedisplayreload - 重新加载插件配置
- 权限:
worldeditdisplay.reload(默认:op)
玩家命令
/wedisplay set <renderer> <setting> <value> - 配置个人渲染设置
- 示例:
/wedisplay set cuboid edge_color #FFD700FF
- 权限:
worldeditdisplay.use.settings
/wedisplay reset <renderer> [setting] - 重置为服务器默认值
- 示例:
/wedisplay reset cuboid(重置所有设置)
- 示例:
/wedisplay reset cuboid edge_color(重置特定设置)
/wedisplay show [renderer] - 显示当前设置
- 示例:
/wedisplay show(显示全部)
- 示例:
/wedisplay show cuboid(显示特定渲染器)
/wedisplay toggle - 开启或关闭渲染
- 快速启用或禁用选择区域可视化的命令
- 每位玩家独立工作
/wedisplay reloadplayer - 重新加载你的个人配置文件
/wedisplay lang <language> - 设置界面语言
- 示例:
/wedisplay lang en_us
- 支持:zh_tw, en_us
/wedisplay share invite <player> - 邀请玩家查看你的选择区域
- 权限:
worldeditdisplay.use.share.invite
/wedisplay share accept <player> - 接受待处理的共享邀请
- 权限:
worldeditdisplay.use.share.accept
/wedisplay share revoke <player> - 撤销之前授予的共享
- 权限:
worldeditdisplay.use.share.revoke
/wedisplay share unwatch <player> - 停止观察其他玩家的选择区域
- 权限:
worldeditdisplay.use.share.unwatch
/wedisplay share list [page] - 列出当前的共享关系
- 权限:
worldeditdisplay.use.share.list
全览子命令 (默认仅限管理员)
/wedisplay view - 切换全览模式(查看所有在线玩家的选择区域)
- 权限:
worldeditdisplay.use.view
/wedisplay view hide <player> - 将玩家排除在全览模式之外
- 权限:
worldeditdisplay.use.view.hide
/wedisplay view hideall - 将所有在线玩家排除在全览模式之外
- 权限:
worldeditdisplay.use.view.hide
/wedisplay view unhide <player> - 移除对玩家的排除
- 权限:
worldeditdisplay.use.view.hide
/wedisplay view label - 切换被观察选择区域的名称标签显示
- 权限:
worldeditdisplay.use.view.label
/wedisplay view list [page] - 显示全览监控状态
- 权限:
worldeditdisplay.use.view.list
配置
主配置文件为 config.yml:
language:
default: "en-us" # 默认语言
auto_detect: true # 自动检测玩家客户端语言
allow_player_change: true # 允许玩家手动更改语言
renderer:
cuboid:
edge_color: "#FFD700FF" # 边缘颜色,格式为 #RRGGBBAA
edge_thickness: 0.05 # 线条粗细
grid_spacing: 8 # 网格间距
fill_enabled: true # 启用面填充
fill_color: "#FF000040" # 面填充颜色
# ... 更多设置
player_limits:
thickness:
min: 0.01 # 最小厚度
max: 0.5 # 玩家可设置的最大厚度
# ... 更多限制
每种渲染器类型都有其自己的配置部分:
- cuboid(长方体)

- polygon(多边形)

- ellipsoid(椭球体)

- cylinder(圆柱体)

- polyhedron(多面体)

工作原理
核心组件
- 数据包监听器拦截 WorldEdit CUI 协议消息
- 渲染引擎创建显示实体以可视化选择区域
- 配置管理器处理服务器级和玩家个人设置
- 语言管理器提供多语言支持
渲染技术
该插件使用 Minecraft 的显示实体系统:
- 显示实体负责渲染视觉元素
- 比粒子效果更高效
- 兼容原版客户端(无需安装模组)
性能优化
- 仅在选择区域发生变化时更新
- 服务器管理员可以限制网格密度和分段数量
- 每位玩家的设置相互独立
权限
worldeditdisplay.use: # 使用可视化功能(默认:true)
worldeditdisplay.use.settings: # 管理个人渲染设置(默认:true)
worldeditdisplay.use.share: # 通用分享功能开关(默认:true)
worldeditdisplay.use.share.invite: # 发送分享邀请(默认:true)
worldeditdisplay.use.share.accept: # 接受分享邀请(默认:true)
worldeditdisplay.use.share.revoke: # 撤销已授予的分享(默认:true)
worldeditdisplay.use.share.unwatch: # 停止观察已共享的选择区域(默认:true)
worldeditdisplay.use.share.list: # 列出分享关系(默认:true)
worldeditdisplay.use.view: # 切换“查看所有”模式(默认:op)
worldeditdisplay.use.view.defaultenable: # 加入时自动启用“查看所有”(默认:op)
worldeditdisplay.use.view.hide: # 在“查看所有”模式中隐藏玩家(默认:op)
worldeditdisplay.use.view.list: # 列出“查看所有”监控状态(默认:true)
worldeditdisplay.use.view.label: # 切换名称标签显示(默认:true)
worldeditdisplay.use.view.label.defaultenable: # 加入时自动启用标签(默认:true)
worldeditdisplay.reload: # 重新加载配置(默认:op)
worldeditdisplay.render.auto-enable: # 加入时自动启用渲染(默认:true)
关于自动启用权限
worldeditdisplay.render.auto-enable 权限控制玩家在加入服务器时是否自动启用渲染功能:
- 拥有该权限:登录时默认启用渲染
- 没有该权限:玩家必须手动使用
/wedisplay toggle 命令来启用渲染
这允许服务器管理员控制哪些玩家组默认启用渲染功能。
使用方法
基本用法
- 使用 WorldEdit 的
//wand 命令获取选择工具
- 左键/右键点击方块以定义你的选择区域
- 选择区域会自动可视化(无需额外步骤)
- 使用
/wedisplay 命令自定义外观
自定义示例
# 将长方体边缘更改为实心钻石蓝
/wedisplay set cuboid edge_color #55FF55FF
# 使线条更粗
/wedisplay set cuboid edge_thickness 0.08
# 更改网格间距
/wedisplay set cuboid height_grid_division 2
# 启用半透明红色填充面
/wedisplay set cuboid fill_enabled true
/wedisplay set cuboid fill_color #FF000080
# 切换渲染开启/关闭
/wedisplay toggle
# 重置所有设置
/wedisplay reset cuboid
构建
要从源代码构建插件:
mvn clean package
编译后的 jar 文件将位于 target/WorldEditDisplay-version-platform.jar
项目结构
src/main/java/dev/twme/worldeditdisplay/
├── event/ # CUI 事件系统
├── display/ # 渲染引擎
│ └── renderer/ # 渲染器实现
├── config/ # 配置管理
├── lang/ # 语言系统
├── command/ # 命令处理器
├── listener/ # 数据包监听器
└── player/ # 玩家数据管理
贡献
欢迎提交 Issue 和 Pull Request。
许可证
详情请参阅 LICENSE 文件。
致谢
相关项目
WorldEditDisplay
A server-side WorldEdit selection visualization plugin
About
WorldEditDisplay is a server-side plugin for Minecraft that adds visual selection rendering for WorldEdit. It intercepts WorldEdit's CUI (Client User Interface) protocol packets and renders selections using Display Entities on the server side. This means players can see their WorldEdit selections without installing any client-side mods.
Features
Selection Types
- Cuboid - Box selections with edge lines and grid display
- Polygon - 2D polygon boundaries with vertical columns
- Ellipsoid - Smooth elliptical selections
- Cylinder - Circular selections with adjustable height
- Polyhedron - Complex 3D polyhedral structures
Visual Rendering
- Uses Minecraft's Display Entity (TextDisplay) system
- Customizable hex colors (#RRGGBBAA) for all visual elements
- Adjustable line thickness and grid density
- Translucent face filling for Cuboid, Polygon, and Polyhedron regions
- Grid overlay for easier size calculation
Multi-language Support
The interface is available in multiple languages with automatic client language detection:
- Traditional Chinese (zh_tw)
- English (en_us)
Player Settings
Players can customize their own rendering preferences:
- Choose preferred hex colors for elements
- Enable or disable face filling
- Adjust line thickness within server limits
- Control grid spacing and density
- Changes apply immediately
Selection Sharing
- Share your WorldEdit selection with other players in real-time
- Invite, accept, revoke, and unwatch shares via
/wedisplay share
- Each shared selection is displayed in a unique auto-generated color
- Share relationships persist across server restarts
View All Mode (op-only by default)
- Toggle monitoring of all online players' selections via
/wedisplay view
- Hide specific players from your view, toggle name labels, and list monitored players
Configuration System
- Server-wide defaults in
config.yml
- Per-player overrides in
player_config/*.yml
- Hot reload without server restart
Requirements
- Minecraft 1.20 ~ 1.21.x (Paper / Folia / Spigot)
- Java 21 or higher
- Required plugins:
Installation
- Make sure WorldEdit and PacketEvents are installed on your server
- Download
WorldEditDisplay.jar
- Place it in your server's
plugins folder
- Restart the server
- Edit
plugins/WorldEditDisplay/config.yml if needed
- Use
/wedisplayreload to reload the configuration
Commands
Admin Commands
/wedisplayreload - Reload plugin configuration
- Permission:
worldeditdisplay.reload (default: op)
Player Commands
/wedisplay set <renderer> <setting> <value> - Configure personal rendering settings
- Example:
/wedisplay set cuboid edge_color #FFD700FF
- Permission:
worldeditdisplay.use.settings
/wedisplay reset <renderer> [setting] - Reset to server defaults
- Example:
/wedisplay reset cuboid (reset all settings)
- Example:
/wedisplay reset cuboid edge_color (reset specific setting)
/wedisplay show [renderer] - Show current settings
- Example:
/wedisplay show (show all)
- Example:
/wedisplay show cuboid (show specific renderer)
/wedisplay toggle - Toggle rendering on/off
- Quick command to enable or disable selection visualization
- Works independently for each player
/wedisplay reloadplayer - Reload your personal configuration file
/wedisplay lang <language> - Set interface language
- Example:
/wedisplay lang en_us
- Supported: zh_tw, en_us
/wedisplay share invite <player> - Invite a player to view your selection
- Permission:
worldeditdisplay.use.share.invite
/wedisplay share accept <player> - Accept a pending share invitation
- Permission:
worldeditdisplay.use.share.accept
/wedisplay share revoke <player> - Revoke a share you previously granted
- Permission:
worldeditdisplay.use.share.revoke
/wedisplay share unwatch <player> - Stop watching another player's selection
- Permission:
worldeditdisplay.use.share.unwatch
/wedisplay share list [page] - List current share relationships
- Permission:
worldeditdisplay.use.share.list
View All Sub-commands (op-only by default)
/wedisplay view - Toggle view-all mode (see all online players' selections)
- Permission:
worldeditdisplay.use.view
/wedisplay view hide <player> - Exclude a player from your view-all mode
- Permission:
worldeditdisplay.use.view.hide
/wedisplay view hideall - Exclude all online players from view-all mode
- Permission:
worldeditdisplay.use.view.hide
/wedisplay view unhide <player> - Remove exclusion for a player
- Permission:
worldeditdisplay.use.view.hide
/wedisplay view label - Toggle name label display for watched selections
- Permission:
worldeditdisplay.use.view.label
/wedisplay view list [page] - Show view-all monitoring status
- Permission:
worldeditdisplay.use.view.list
Configuration
The main configuration file is config.yml:
language:
default: "en-us" # Default language
auto_detect: true # Auto-detect player's client language
allow_player_change: true # Allow players to change language manually
renderer:
cuboid:
edge_color: "#FFD700FF" # Color for edges in #RRGGBBAA
edge_thickness: 0.05 # Line thickness
grid_spacing: 8 # Grid spacing
fill_enabled: true # Enable face filling
fill_color: "#FF000040" # Face fill color
# ... more settings
player_limits:
thickness:
min: 0.01 # Minimum thickness
max: 0.5 # Maximum thickness players can set
# ... more limits
Each renderer type has its own configuration section:
- cuboid

- polygon

- ellipsoid

- cylinder

- polyhedron

How It Works
Core Components
- Packet listener intercepts WorldEdit CUI protocol messages
- Render engine creates Display Entities to visualize selections
- Configuration manager handles server-wide and per-player settings
- Language manager provides multi-language support
Rendering Technology
The plugin uses Minecraft's Display Entity system:
- Display entities render the visual elements
- More efficient than particle effects
- Works with vanilla clients (no mods required)
Performance
- Only updates when selections change
- Server admins can limit grid density and segment counts
- Each player's settings are independent
Permissions
worldeditdisplay.use: # Use visualization features (default: true)
worldeditdisplay.use.settings: # Manage personal rendering settings (default: true)
worldeditdisplay.use.share: # General share feature toggle (default: true)
worldeditdisplay.use.share.invite: # Send share invitations (default: true)
worldeditdisplay.use.share.accept: # Accept share invitations (default: true)
worldeditdisplay.use.share.revoke: # Revoke granted shares (default: true)
worldeditdisplay.use.share.unwatch: # Stop watching a shared selection (default: true)
worldeditdisplay.use.share.list: # List share relationships (default: true)
worldeditdisplay.use.view: # Toggle view-all mode (default: op)
worldeditdisplay.use.view.defaultenable: # Auto-enable view-all on join (default: op)
worldeditdisplay.use.view.hide: # Hide players from view-all (default: op)
worldeditdisplay.use.view.list: # List view-all monitoring status (default: true)
worldeditdisplay.use.view.label: # Toggle name label display (default: true)
worldeditdisplay.use.view.label.defaultenable: # Auto-enable labels on join (default: true)
worldeditdisplay.reload: # Reload configuration (default: op)
worldeditdisplay.render.auto-enable: # Automatically enable rendering on join (default: true)
About Auto-Enable Permission
The worldeditdisplay.render.auto-enable permission controls whether rendering is automatically enabled when a player joins the server:
- With permission: Rendering is enabled by default when logging in
- Without permission: Players must manually use
/wedisplay toggle to enable rendering
This allows server admins to control which player groups have rendering enabled by default.
Usage
Basic Usage
- Use WorldEdit's
//wand command to get the selection tool
- Left/right click blocks to define your selection
- The selection is automatically visualized (no extra steps needed)
- Use
/wedisplay commands to customize the appearance
Customization Examples
# Change cuboid edges to solid diamond blue
/wedisplay set cuboid edge_color #55FF55FF
# Make lines thicker
/wedisplay set cuboid edge_thickness 0.08
# Change grid spacing
/wedisplay set cuboid height_grid_division 2
# Enable face filling with half-transparent red
/wedisplay set cuboid fill_enabled true
/wedisplay set cuboid fill_color #FF000080
# Toggle rendering on/off
/wedisplay toggle
# Reset all settings
/wedisplay reset cuboid
Building
To build the plugin from source:
mvn clean package
The compiled jar will be in target/WorldEditDisplay-version-platform.jar
Project Structure
src/main/java/dev/twme/worldeditdisplay/
├── event/ # CUI event system
├── display/ # Render engine
│ └── renderer/ # Renderer implementations
├── config/ # Configuration management
├── lang/ # Language system
├── command/ # Command handlers
├── listener/ # Packet listeners
└── player/ # Player data management
Contributing
Issues and pull requests are welcome.
License
See LICENSE file for details.
Credits
Related Projects
评论 0
登录后参与评分
还没有评论,来抢沙发吧