CoralFans 珊瑚扇

CoralFans-doc

来源：README.md

• 点击目录栏 MainDoc 开始阅读
  • InstallDoc 安装文档
  • MainDoc 主要功能介绍
  • ConfigDoc 配置文件文档
  • ShortcutsDoc Shortcuts文档
  • CFSPDoc 假人文档
  • QA Q&A
• 欢迎参与文档站建设

这是什么

CoralFans珊瑚扇（简称CF）是一个基于Minecraft BDS with LeviLamina的、专为MCBE生电服务的MOD。CF提供了诸多可以方便生电玩家的功能（包括一些在普通生存中看上去“非法”的功能），如物品补货、自动切换图腾、自动切换工具、调整游戏运行速度、村庄机制可视化、HSA可视化、假人、HUD信息显示、漏斗计数器等功能。更多功能还在持续增加中。

你可以把CF当作LL2 Trapdoor插件的新版本移植。不过CF目前还有一些功能没有做到，如刷怪分析。

插件特色

• 尊重原版游戏特性，不会在不告知玩家的情况下进行修改
• 支持多人游戏
• 可通过配置文件进行功能配置

你可能关心的

关于贡献者

• 8848yyds 插件主要开发者
• odorajbotoj 插件前开发者
• hhhxiao Trapdoor-ll的主要开发者
• OEOTYAN 前置Mod开发，部分源码提供
• glibcxx 部分源代码提供
• JiaLe1135 文档贡献
• Tokong Server 提供服务器测试环境

CoralFans安装

来源：InstallDoc.md

0.阅读并同意免责声明

作为用户首先需要明确: 使用CoralFans带来的功能就意味着承担第三方软件带来​​的风险.为了不给开发者带来不必要的麻烦,请阅读以下的免责声明,如果您使用了CoralFans就意味着您自动同意了该声明.

免责声明

CoralFans(以下简称cf)是一个基于LeviLamina开发的我的世界基岩版辅助插件,它提供了令人惊叹的方便玩家的功能,给生电玩家创造了便利.另外,cf本身是开源免费的,内部没有任何恶意代码,原则上也不会对存档造成任何损害.

但考虑到此类软件的特殊性,开发者无法完全保证对用户的存档不造成任何破坏,万一发生意外情况,开发者不会也没有能力对用户造成的损失负责.

如果您继续使用cf插件,那么就代表您同意了该声明(或者说叫用户协议),如果您不想承担此类风险,请停止使用cf插件.

1.安装LeviLamina

CoralFans插件依赖于LeviLamina加载器,所以在使用本插件前,你需要安装LeviLamina。

• Windows安装参考LeviLamina中文安装教程

补充

• 不建议中文路径
  • 这可能会导致意料之外的行为,不建议中文路径
• 关闭cmd快速编辑
  • windows默认cmd窗口启用快速编辑模式,这大概率会导致你的BDS程序阻塞,右键窗口选择属性,将快速编辑模式关闭即可

2.下载并安装前置

1. 使用lip进行安装: lip install github.com/OEOTYAN/BedrockServerClientInterface .

3.下载并安装插件本体

• 使用lip进行安装: lip install github.com/CoralFans-Dev/CoralFans .
• 也可以手动安装
  1. 前往CoralFans的下载页面下载发布的release文件
  2. 将解压后的插件放入服务端根目录下的 plugins 文件夹

客户端版

• 自26.10起，CoralFans同时提供客户端版本，可配合客户端版LeviLamina使用
• 使用leviLauncher安装：在leviLauncher的Bedrinth界面中找到CoralFans进行安装
• 使用lip进行安装: lip install github.com/CoralFans-Dev/CoralFans#client
• 手动安装时，将客户端版压缩包解压后放入客户端 mods 文件夹

4.配置配置文件

你可能需要根据需求关闭部分功能(如 tick ，漏斗计数器等)

5.开服

本地服务器ip一栏填写 127.0.0.1 或者 localhost

云服务器ip一栏填写其公网ip(不知道的问服务商),端口按照服务器配置文件里面改，默认 19132

CoralFans

来源：MainDoc.md

coralfans

• 关于 CoralFans Mod

/coralfans version

• coralfans version 打印当前版本信息

calculate

• 统计游戏数据

/calculate pt
/calculate pt2

• calculate pt 统计区块内计划刻数据
• calculate pt2 统计区块内计划刻数据，额外统计已被移除（removed）的计划刻

cfhud

• HUD信息显示

/cfhud show <isopen: Boolean>
/cfhud <add|remove> <mspt|base|redstone|village|hopper|block|container>
/cfhud removeall

• cfhud show 配置是否显示信息
• cfhud add 增加一条显示项
• cfhud remove 删除一条显示项
• cfhud removeall 删除所有显示项
  • mspt - mspt与tps信息
  • base - 基本信息，如当前坐标、区块、群系等
  • redstone - 红石信息，等同于执行 data redstone info
  • village - 村民信息，等同于执行 village dweller
  • hopper - 漏斗计数器信息，等同于执行 counter print
  • block - 方块信息，等同于执行 data block
  • container - 容器信息，等同于执行 containerreader（指向容器的内容预览）

counter

• 漏斗计数器

/counter print [channel: int]
/counter reset [channel: int]

• 在使用 func hoppercounter true 开启漏斗计数器后，所有对准混凝土的漏斗都将变成无尽的漏斗，所有流向该漏斗的物品都会消失，但是这些数据会被插件记录下来，你可以使用 /counter 命令查看这些数据。16种混凝土每一种对应一个频道（根据特殊值）。
  • /counter print [channel: int] 打印频道channel的数据
  • /counter reset [channel: int] 清除频道channel的数据
  • 不指定频道时，插件会获取指向的漏斗或混凝土对应频道的数据
• 注意：从使用 func hoppercounter true 这一刻开始漏斗计数器就开始计时了，而不是其他时间。数据在服务器关闭时不会保存。

data

• 获取方块或实体等的信息

/data block [blockPos: x y z]
/data block nbt [path: string]
/data block <blockPos: x y z> nbt [path: string]
/data blockentity nbt [path: string]
/data blockentity <blockPos: x y z> nbt [path: string]
/data blockentity highlight [radius: int] [time: int]
/data entity
/data entity nbt [path: string]
/data redstone <signal|info|chunk|conn> [blockPos: x y z]
/data item nbt [path: string]
/data player <player: Player> uuid

• data block 获取方块信息（包括RuntimeID）
• data blockentity 获取方块实体信息
• data entity 获取实体信息
• data item 获取手持物品信息
  • nbt 用于指定获取nbt信息
  • path 是可选参数，用于访问特定的Nbt Tag。如 a.b[1].c 指向根标签下a标签下b数组的第二个元素的c标签。
• data redstone 获取红石原件信息
  • chunk 标记所在区块的所有红石原件
  • signal 打印信号相关信息
  • info 打印红石基本信息
  • conn 标记指定原件（绿色）、子原件（黄色）、父原件（红色）
• data player 获取指定玩家的UUID

func

• 拥有调整全局功能配置的能力

/func forceopen <IsOpen: Boolean>
/func forceplace <all|entity|normal>
/func droppernocost <IsOpen: Boolean>
/func safeexplode <IsOpen: Boolean>
/func autotool <IsOpen: Boolean>
/func autoweapon <IsOpen: Boolean>
/func hoppercounter <IsOpen: Boolean>
/func containerreader <IsOpen: Boolean>
/func autototem <IsOpen: Boolean>
/func autoitem <IsOpen: Boolean>
/func fastdrop <IsOpen: Boolean>
/func nopickup <IsOpen: Boolean>
/func portaldisabled <IsOpen: Boolean>

• func forceopen 强制开启容器

• func forceplace 方块强制放置

  • all 表示无视所有限制, entity 表示无视实体, normal表示正常模式

• func droppernocost 投掷器不消耗物品

• func safeexplode 爆炸不破坏地形

• func autotool 自动切换工具

• func autoweapon 自动切换武器

• func hoppercounter 漏斗计数器

• func containerreader 容器预览

• func autototem 自动补充图腾

• func autoitem 物品自动补货

• func fastdrop 快速扔出背包所有同类物品

• func nopickup 禁止拾取物品

• func portaldisabled 玩家禁用传送门

• func可以开启或者关闭部分功能的全局开关。功能分为两类，全局功能和个人功能。对于个人功能，需要使用func和self同时开启该功能才会生效；对于全局功能，只需要使用func指令开启，该功能则会令全服务器的所有玩家生效。

freecamera

• 自由视角

/freecamera

• freecamera 开启或关闭自由视角模式。再次执行即可关闭

hsa

• 拥有在游戏内可视化结构生成区域(HSA)的能力

/hsa show [IsOpen: Boolean]
/hsa structure show [IsOpen: Boolean]
/hsa list
/hsa structure list

• hsa show 开启或者关闭HSA显示。开启后插件会在游戏内有HSA的地方使用粒子画出结构的刷怪点起始位置（需要前置Mod与对应材质包），默认黑色，如若hsa点位重合，则会出现多种色彩叠加的情况。不指定参数时会在开/关之间切换
• hsa structure show 开启或者关闭结构包围盒显示，画出结构的空间范围。不指定参数时会在开/关之间切换
• hsa list 列出当前区块内所有HSA起始点坐标
• hsa structure list 列出当前区块内所有结构的包围盒范围

locate

• 定位可回溯（可复制）的自然生成地物，并进行可视化

/cflocate duplicatable <netherite|nether_spring|nether_fire|glow_stone|mushroom|nether_gold|nether_quartz|nether_magma|nether_gravel|blackstone|soul_sand|end_island|chorus_flower|end_gateway> [IsOpen: Boolean]

• cflocate duplicatable 开启或关闭指定类型的可回溯地物显示（在配置文件中未启用的类型不可用）。不指定 IsOpen 时会在开/关之间切换
  • 可回溯地物类型包括：远古残骸(netherite)、下界熔岩泉(nether_spring)、下界火焰(nether_fire)、萤石(glow_stone)、蘑菇(mushroom)、下界金矿(nether_gold)、下界石英矿(nether_quartz)、岩浆块(nether_magma)、下界沙砾(nether_gravel)、黑石(blackstone)、灵魂沙(soul_sand)、末地浮岛(end_island)、紫颂花(chorus_flower)、末地折跃门(end_gateway)

log

• 打印一些信息

/log levelseed
/log pt
/log rpt

• log levelseed 打印存档种子
• log pt 打印玩家所在区块的计划刻信息
• log rpt 打印玩家所在区块的随机计划刻信息

minerule

• 用于修改游戏规则

/minerule fuck_bedrock_no_drop <IsOpen: Boolean>
/minerule fuck_movingBlock_no_drop <IsOpen: Boolean>
/minerule restore_portal_sand_farm <IsOpen: Boolean>
/minerule remove_portal_pigzombie_cd <IsOpen: Boolean>
/minerule restore_ancillary_broken <IsOpen: Boolean>
/minerule fuck_population_cap <IsOpen: Boolean>
/minerule fuck_population_cap global <count: int>
/minerule fuck_population_cap global reset
/minerule fuck_population_cap <dimension: Dimension> <animal|monster|water_animal|villager|ambient|cat|pillager> <surface|underground> <count: float>
/minerule fuck_population_cap <dimension: Dimension> reset
/minerule fuck_piston_reset_velocity <IsOpen: Boolean>
/minerule set_max_pt_consume_per_chunk <maxpt: int>
/minerule mining_72k <IsOpen: Boolean>

• minerule fuck_bedrock_no_drop 还原旧版本基岩可掉落
• minerule fuck_movingBlock_no_drop 修复movingBlock破坏时不掉落的bug
• minerule restore_portal_sand_farm 还原旧版本折跃门刷沙机
• minerule remove_portal_pigzombie_cd 移除猪人15s传送cd
• minerule restore_ancillary_broken 还原活塞破坏双格方块（如门）时另一半方块的掉落
• minerule fuck_population_cap 解除种群上限限制
  • fuck_population_cap <IsOpen: Boolean> 开启或关闭种群上限修改
  • fuck_population_cap global <count: int> 设置全局种群上限， reset 可重置为默认值(200)
  • fuck_population_cap <dimension> <mobtype> <type> <count> 设置指定维度、指定生物类别、指定地表/地下种群上限
  • fuck_population_cap <dimension> reset 重置指定维度的种群上限
  • mobtype 生物类别：animal(动物)、monster(怪物)、water_animal(水生动物)、villager(村民)、ambient(环境生物)、cat(猫)、pillager(掠夺者)
• minerule fuck_piston_reset_velocity 修复活塞推动实体时速度被重置的bug
• minerule set_max_pt_consume_per_chunk 设置每个区块每gt最多执行的计划刻数量
• minerule mining_72k 修复极速挖掘（72k挖掘）时服务端挖掘进度被重置导致无法连续破坏方块的问题

noclip

• 创造模式无碰撞箱

/noclip

• noclip 创造模式无碰撞箱

prof

• 拥有检查服务器健康程度以及定位卡顿源头的能力

/prof [normal|entity|chunk|pt|mspt] [numberOfTick: int]

• prof normal 进行普通的profile,会列出游戏多个条目的执行时间
• prof entity 对实体更新进行profile
• prof chunk 对区块更新进profile（列出的坐标为区块坐标）
• prof pt 对计划刻进行profile
• prof mspt 对MSPT进行统计（最大/最小/阈值等）
• numberOfTick 是选填参数，指定prof需要执行的gt数，不填时默认为100gt

rotate

• 旋转方块

/rotate

• rotate 可以旋转指向的方块

self

• 拥有调整个人功能配置的能力

/self autotool <IsOpen: Boolean>
/self autotool mindamage <mindamage: int>
/self autoweapon <IsOpen: Boolean>
/self autoweapon mindamage <mindamage: int>
/self containerreader <IsOpen: Boolean>
/self autototem <IsOpen: Boolean>
/self autoitem <IsOpen: Boolean>
/self fastdrop <IsOpen: Boolean>
/self nopickup <IsOpen: Boolean>
/self portaldisabled <IsOpen: Boolean>

• self autotool 自动切换工具
  • self autotool mindamage 可以设置工具最小耐久值。低于耐久值的工具不会被自动选择
• self autoweapon 自动切换武器
  • self autoweapon mindamage 可以设置武器最小耐久值。低于耐久值的武器不会被自动选择
• self containerreader 容器预览
• self autototem 自动补充图腾
• self autoitem 物品自动补货
• self fastdrop 快速扔出背包所有同类物品
• self nopickup 禁止拾取物品
• self portaldisabled 玩家禁用传送门
• 当对应的功能没有在 func 指令中全局开启时， self 指令会一直将其配置为 false

slime

• 拥有可视化史莱姆区块的能力

/slime check
/slime show [IsOpen: Boolean]

• slime check 检测当前区块是否为史莱姆区块
• slime show 开启或关闭史莱姆区块可视化。不指定参数时会在开/关之间切换

sp

• 假人
• 在CoralFans 2.0.0版本中，我们移除了假人系统，并将其做成了独立插件CFSP
• 参见CFSPCommandDoc

tick

• 拥有改变世界运行速度的能力

/tick query [times: int]
/tick <freeze|reset>
/tick rate <rate: float>
/tick sync [enable: Boolean]
/tick step <step: int>

• tick query 查询MSPT
  • 可选参数 times 指定连续查询的gt数，不填时默认查询一次
• tick freeze 暂停tick执行
• tick reset 重置游戏速率至正常
• tick rate 设置游戏速率，原版为20tps
• tick sync 将客户端的游戏速度与服务器同步（并补偿飞行速度），使客户端动画与实际tick速率一致。不指定参数时会在开/关之间切换
• tick step 加速步进指定数量的tick，并在步进结束后暂停游戏运行

village

• 拥有显示村庄信息的能力

/village show <bounds|raid|spawn|center|poi|bind> [IsOpen: Boolean]
/village list
/village tickinglist
/village info <id: int>
/village dweller

• village show <bounds|raid|spawn|center|poi|bind> [IsOpen: Boolean] 用于开关村庄相关的可视化。不指定 IsOpen 时会在开/关之间切换：
  • bind 村民绑定信息可视化
  • bounds 村庄范围可视化
  • center 村庄中心可视化
  • poi POI的查询范围可视化
  • raid 劫掠刷新边界可视化
  • spawn 铁傀儡刷新范围可视化
• village list 列出所有正在加载的村庄
• village tickinglist 列出所有正在tick的村庄
• village info <id: int> 显示指定VID的村庄的信息
• village dweller 获取指向实体（村民）的信息

配置文件

来源：ConfigDoc.md

version

• 配置文件的版本。当前版本（26.51.x）CoralFans为 7

locateName

• 插件语言。支持 zh_CN 与 en_US

command

• 指令配置。其中每一项均包含 enabled（是否启用该指令）、permission（执行所需权限）与 command（指令名称）三个字段
• 可配置的指令包括：

permission

• 执行所需权限
• 可选值如下（从小到大排序）
  • Any - 任意玩家
  • GameDirectors - 默认的管理员权限
  • Admin
  • Host
  • Owner
  • Internal

functions

functions.hud

refreshInterval

• cfhud信息显示的刷新时间。单位：Tick，默认 20

functions.hsa

• HSA可视化相关配置
  • drawInterval 绘制间隔（Tick），默认 60
  • runtimeRemoveScale 运行时绘制的移除倍率，默认 20
  • drawRadius 绘制半径（区块），默认 6
  • hsaNorthWestColor HSA区块西北角颜色，默认 #FFFFFF
  • hsaColor HSA起始点颜色，默认 #29ADFF
  • structureColor 结构包围盒颜色，默认 #10E436

functions.locate.duplicatable

• 可回溯地物定位可视化相关配置
  • drawInterval 绘制间隔（Tick），默认 60
  • runtimeRemoveScale 运行时绘制的移除倍率，默认 20
  • cacheRemoveScale 缓存数据的移除倍率，默认 100
  • drawRadius 绘制半径（区块），默认 6
• 每一种可回溯地物类型（netherite、netherSpring、netherFire、glowStone、mushroom、netherGold、netherQuartz、netherMagma、netherGravel、netherBlackstone、netherSoulSand、endIsland、chorusFlower、endGateway）均包含以下字段：
  • enable 是否在 cflocate 指令中启用该类型
  • originPosColor / posColor / boundColor 起始点/位置/边界绘制颜色（不同类型使用的字段略有差异），默认 #10E436 / #FFFFFF
  • textColor 文本颜色，默认 #FFFFFF
  • arrowColor 箭头颜色，默认 #FFFFFF

functions.slime

• 史莱姆区块可视化相关配置
  • drawInterval 绘制间隔（Tick），默认 60
  • runtimeRemoveScale 运行时绘制的移除倍率，默认 20
  • cacheRemoveScale 缓存数据的移除倍率，默认 100
  • drawRadius 绘制半径（区块），默认 8
  • slimeChunkColor 史莱姆区块颜色，默认 #10E436

functions.village

• 村庄可视化相关配置
  • drawInterval 绘制间隔（Tick），默认 10
  • boundsColor 村庄范围颜色，默认 #FFFFFF
  • raidBoundsColor 劫掠刷新边界颜色，默认 #10E436
  • ironSpawnBoundsColor 铁傀儡刷新范围颜色，默认 #3003D9
  • centerColor 村庄中心颜色，默认 #FF0040
  • poiBoundsColor POI查询范围颜色，默认 #FFA214
  • bedBindColor 床绑定颜色，默认 #DB3FFD
  • ringBindColor 钟绑定颜色，默认 #FFEC27
  • workBindColor 工作方块绑定颜色，默认 #5AC54F

shortcut

• 自定义快捷指令
• 参见ShortcutsDoc

Shortcuts

来源：ShortcutsDoc.md

shortcut 是一项非常强大的配置功能。仙人掌扳手、仙人掌点击混凝土打印漏斗计数器信息皆依赖此功能。

• 快捷指令分为五类，分别对应配置文件中的五个数组：
  • useons 玩家对着方块使用物品
  • uses 玩家使用物品
  • destroys 玩家使用物品破坏任意方块
  • commands 自定义命令
  • keyBoards 键盘按键（仅客户端版可用）
• 通用字段
  • enable 是否开启
  • actions 要执行的指令序列。您可以在其中使用一些内建变量，他们会在执行时被替换
  • intercept 是否拦截原有事件触发
• useons 字段
  • item 玩家手持物品
  • block 玩家点击的方块
• uses 字段
  • item 玩家使用的物品
• destroys 字段
  • item 玩家破坏方块时手持的物品
• commands 字段
  • command 自定义的短命令
  • description 自定义短命令的描述
  • permission 自定义短命令的权限。可选值同config - permission
• keyBoards 字段（仅客户端版可用）
  • keyCode 按键的键值（如 F R N）
  • isDown 是按下触发（true）还是松开触发（false）
• 内建变量
  • {selfname} 执行者真名（所有类型有效）
  • {selfx} 执行者x坐标（所有类型有效）
  • {selfy} 执行者y坐标（所有类型有效）
  • {selfz} 执行者z坐标（所有类型有效）
  • {itemname} 使用的物品的名称（对 useons uses destroys 有效）
  • {itemaux} 使用的物品的特殊值（对 useons uses destroys 有效）
  • {blockname} 对准方块的名称（对 useons 有效）
  • {blockvariant} 对准方块的特殊值（对 useons 有效）
  • {blockx} 对准方块的x坐标（对 useons 有效）
  • {blocky} 对准方块的y坐标（对 useons 有效）
  • {blockz} 对准方块的z坐标（对 useons 有效）

举例

打印漏斗计数器信息

"useons": [
    {
        "enable": true,
        "item": "cactus",
        "block": "black_concrete",
        "intercept": false,
        "actions": [
            "counter print"
        ]
    }
]

• 上述配置代表：当对准黑色混凝土使用仙人掌时，执行 counter print 指令。此快捷方式不拦截原有事件被触发，且是开启的。

快捷切换创造

"commands": [
    {
        "enable": false,
        "command": "c",
        "description": "creative",
        "permission": "GameDirectors",
        "actions": [
            "gamemode creative"
        ]
    }
]

• 上述配置代表：当玩家执行 /c 命令时，等效于执行 gamemode creative 。 /c 命令的描述为 creative ，需要权限 GameDirectors 。此快捷方式是关闭的。

键盘按键触发（仅客户端版可用）

"keyBoards": [
    {
        "enable": true,
        "keyCode": "F",
        "isDown": false,
        "intercept": false,
        "actions": [
            "freecamera"
        ]
    }
]

• 上述配置代表：当玩家松开 F 键时，执行 freecamera 指令以切换自由视角。此快捷方式不拦截按键事件，且是开启的。

CoralFans SimulatedPlayer (CFSP)

来源：CFSPCommandDoc.md

Tips

CFSP假人的XUID是固定的，等于 "-" + std::to_string(std::hash<std::string>()(spname))

使用非 stop 指令执行的关服操作可能会造成数据丢失。插件不为此负责。

指令系统

/sp version
/sp c <autojoin|autorespawn|autodespawn> <isopen: bool>
/sp <addmanager|rmmanager> <player: Player>
/sp
/sp p
/sp g
/sp list p [online|offline]
/sp list g
/sp p create <name: string> [pos: Vec3] [dim: Dimension] [lockUniqueId: bool]
/sp p spawn <name: cfspOfflineSp>
/sp p respawn <name: cfspDeadSp>
/sp p delete <name: cfspSplist> [force: bool]
/sp p <despawn|stop|swap|info|invinfo> <name: cfspOnlineSp>
/sp p select <name: cfspOnlineSp> <item: Item>
/sp p <sneaking|swimming|flying|sprinting> <name: cfspOnlineSp> [enabled: bool]
/sp p <attack|build|interact|jump|drop|dropinv> <name: cfspOnlineSp> [times: int] [interval: int]
/sp p <use|destroy> <name: cfspOnlineSp> [long: int] [times: int] [interval: int]
/sp p <chat|runcmd> <name: cfspOnlineSp> <message: string>
/sp p lookat <name: cfspOnlineSp> [pos: Vec3]
/sp p lookat <name: cfspOnlineSp> <facing: north|south|west|east|up|down>
/sp p <moveto|navto> <name: cfspOnlineSp> [pos: Vec3] [speed: float]
/sp p tp <name: cfspOnlineSp> [pos: Vec3] [dim: Dimension]
/sp p perm <name: cfspSplist> <permType: cfspSpPermType> <player: player> <enable: bool>
/sp p permpublic <name: cfspSplist> <permType: cfspSpPermType> <enable: bool>
/sp g create <gname: string>
/sp g <addsp|rmsp> <gname: cfspGroup> <spname: cfspSplist>
/sp g <delete|spawn|despawn|respawn|stop|info|invinfo> <gname: cfspGroup>
/sp g deletesp <gname: cfspGroup> [force: bool]
/sp g <sneaking|swimming|flying|sprinting> <gname: cfspGroup> [enabled: bool]
/sp g <attack|build|interact|jump|drop|dropinv> <gname: cfspGroup> [times: int] [interval: int]
/sp g <use|destroy> <gname: cfspGroup> [long: int] [times: int] [interval: int]
/sp g <chat|runcmd> <gname: cfspGroup> <message: string>
/sp g lookat <gname: cfspGroup> [pos: Vec3]
/sp g lookat <gname: cfspGroup> <facing: north|south|west|east|up|down>
/sp g <moveto|navto> <gname: cfspGroup> [pos: Vec3] [speed: float]
/sp g tp <gname: cfspGroup> [pos: Vec3] [dim: Dimension]
/sp g select <gname: cfspGroup> <item: Item>
/sp g perm <gname: cfspGroup> <permType: cfspGroupPermType> <player: player> <enable: bool>
/sp g permpublic <gname: cfspGroup> <permType: cfspGroupPermType> <enable: bool>

基本指令

• sp version 用于打印插件版本信息
• sp c 用于进行假人系统配置。仅假人管理员可执行
  • sp c autojoin 关服时在线假人在开服时自动加入游戏
  • sp c autorespawn 假人死亡自动重生
  • sp c autodespawn 假人频繁死亡时自动下线
• sp list 用于列出相关信息
  • sp list p [online|offline] 列出所有/在线/离线假人信息
  • sp list g 列出所有组信息

gui指令

• sp 打开gui界面
• sp p 打开假人gui界面
• sp g 打开假人组gui界面

假人操作

基础操作

• sp p create <name: string> [pos: Vec3] [dim: Dimension] [lockUniqueId: bool] 创建假人
  • name 假人名称
  • pos 假人创建坐标,当玩家视线范围内有方块时，默认玩家看向的位置，否则默认玩家当前位置
  • dim 假人创建维度，默认玩家当前维度
  • lockUniqueId 是否锁定假人uniqueId，如果锁定则假人上下线后不会与三叉戟失去联系，如果不锁定则可以通过上下线假人反复开启试炼宝库
  • 创建假人时，假人的游戏模式将与创建者保持一致
• sp p spawn <name: cfspOfflineSp> 上线假人
• sp p despawn <name: cfspOnlineSp> 下线假人
• sp p respawn <name: cfspDeadSp> 假人重生
• sp p delete <name: cfspSplist> [force: bool] 删除假人
  • force 是否强制删除假人。当此参数为true时，可以强制删除背包不为空的假人
• sp p info <name: cfspOnlineSp> 打印假人信息

背包操作

• sp p invinfo <name: cfspOnlineSp> 假人背包信息
• sp p drop <name: cfspOnlineSp> [times: int] [interval: int] 假人丢弃手持物品
• sp p dropinv <name: cfspOnlineSp> [times: int] [interval: int] 假人丢弃物品栏内全部物品
• sp p swap <name: cfspOnlineSp> 与假人交换背包（包括装备与末影箱）
• sp p select <name: cfspOnlineSp> <item: Item> 假人在背包中搜索物品并与手持物品切换

状态操作

• sp p sneaking <name: cfspOnlineSp> [enabled: bool] 假人潜行
• sp p swimming <name: cfspOnlineSp> [enabled: bool] 假人游泳
• sp p flying <name: cfspOnlineSp> [enabled: bool] 假人飞行
• sp p sprinting <name: cfspOnlineSp> [enabled: bool] 假人疾跑

假人执行操作

• 参数含义
  • times 动作重复次数
  • interval 操作间隔
  • long 操作时长

短操作

• sp p attack <name: cfspOnlineSp> [times: int] [interval: int] 假人攻击
• sp p build <name: cfspOnlineSp> [times: int] [interval: int] 假人放置方块
• sp p interact <name: cfspOnlineSp> [times: int] [interval: int] 假人交互
• sp p jump <name: cfspOnlineSp> [times: int] [interval: int] 假人跳跃

长操作

• sp p use <name: cfspOnlineSp> [long: int] [times: int] [interval: int] 假人使用物品
• sp p destroy <name: cfspOnlineSp> [long: int] [times: int] [interval: int] 假人挖掘

看向操作

• sp p lookat <name: cfspOnlineSp> [pos: Vec3] 假人看向操作
  • pos 假人看向的坐标，当玩家视线范围内有方块时，默认玩家看向的位置，否则默认玩家当前位置
• sp p lookat <name: cfspOnlineSp> <facing: north|south|west|east|up|down> 假人看向指定方向

消息操作

• sp p chat <name: cfspOnlineSp> <message: string> 假人发送消息
• sp p runcmd <name: cfspOnlineSp> <message: string> 假人执行指令
  • message 信息内容

移动操作

• 参数含义

  • pos 目标坐标，当玩家视线范围内有方块时，默认玩家看向的位置，否则默认玩家当前位置
  • speed 假人移动速度
  • dim 目标维度，默认玩家当前位置

• sp p moveto <name: cfspOnlineSp> [pos: Vec3] [speed: float] 假人移动操作

• sp p navto <name: cfspOnlineSp> [pos: Vec3] [speed: float] 假人寻路操作

• sp p tp <name: cfspOnlineSp> [pos: Vec3] [dim: Dimension] 假人传送操作

停止操作

• sp p stop <name: cfspOnlineSp> 假人停止操作

权限管理

• 参数含义

  • permType 权限类别，可选值：all(全部权限)、Spawn、Despawn、Respawn、Delete、Stop、Drop、DropInv、Swap、Sneaking、Swimming、Flying、Sprinting、Attack、Build、Interact、Jump、Use、Destroy、Chat、RunCmd、Select、LookAt、MoveTo、NavTo、Tp、BeAddedToGroup(允许被添加到假人组)
  • player 目标玩家
  • enable 是否允许

• sp p perm <name: cfspSplist> <permType: cfspSpPermType> <player: player> <enable: bool> 把假人的某一权限授权给其他玩家

• sp p permpublic <name: cfspSplist> <permType: cfspSpPermType> <enable: bool> 设置假人公共权限

假人组操作

基础操作

• sp g create <gname: string> 创建假人组
• sp g addsp <gname: cfspGroup> <spname: cfspSplist> 向假人组中添加假人
• sp g rmsp <gname: cfspGroup> <spname: cfspSplist> 移除假人组中的假人
• sp g delete <gname: cfspGroup> 删除假人组
• sp g deletesp <gname: cfspGroup> [force: bool] 删除组内假人
  • force 是否强制删除假人。当此参数为true时，可以强制删除背包不为空的假人

批操作

• 此部分用于批量控制假人，功能等同于对组内全部假人执行对应假人指令
• sp g <spawn|despawn|respawn> <gname: cfspGroup>
• sp g info <gname: cfspGroup>
• sp g stop <gname: cfspGroup>
• sp g <drop|dropinv|invinfo> <gname: cfspGroup>（drop与dropinv支持 [times: int] [interval: int] 参数）
• sp g select <gname: cfspGroup> <item: Item>
• sp g <sneaking|swimming|flying|sprinting> <gname: cfspGroup> [enabled: bool]
• sp g <attack|build|interact|jump> <gname: cfspGroup> [times: int] [interval: int]
• sp g <use|destroy> <gname: cfspGroup> [long: int] [times: int] [interval: int]
• sp g <chat|runcmd> <gname: cfspGroup> <message: string>
• sp g lookat <gname: cfspGroup> [pos: Vec3]
• sp g lookat <gname: cfspGroup> <facing: north|south|west|east|up|down>
• sp g <moveto|navto> <gname: cfspGroup> [pos: Vec3] [speed: float]
• sp g tp <gname: cfspGroup> [pos: Vec3] [dim: Dimension]

权限管理

• 参数含义

  • permType 权限类别，可选值：all(全部权限)、AddSp、RmSp、Delete、Spawn、Despawn、Respawn、DeleteSp、Stop、Drop、DropInv、Sneaking、Swimming、Flying、Sprinting、Attack、Build、Interact、Jump、Use、Destroy、Chat、RunCmd、LookAt、MoveTo、NavTo、Tp、Select
  • player 目标玩家
  • enable 是否允许

• sp g perm <gname: cfspGroup> <permType: cfspGroupPermType> <player: player> <enable: bool> 把假人组的某一权限授权给其他玩家

• sp g permpublic <gname: cfspGroup> <permType: cfspGroupPermType> <enable: bool> 设置假人组公共权限

CFSP配置文件

来源：CFSPConfigDoc.md

Config.json

version

• Config.json配置文件的版本。当前版本（26.51.x）CFSP为 3

enabled

• 是否启用假人系统

permission

• 假人指令基础权限等级

namePrefix

• 假人名称前缀

namePostfix

• 假人名称后缀

autoRespawn

• 假人死亡自动重生

autojoin

• 关服时在线假人在开服时自动加入游戏

autoDespawn

• 假人频繁死亡时自动下线

maxOnline

• 最大假人同时在线数

maxOwn

• 单人最多拥有假人数

maxOnlinePerPlayer

• 单人最大同时在线假人数

maxGroup

• 单人最多拥有组个数

autoDespawnCount & autoDespawninterval

• 开启autoDespawn时，当autoDespawninterval gt内死亡autoDespawnCount次，假人下线

adminPermission

• 假人管理员所需权限
• 可选值如下（从小到大排序）
  • Any - 任意玩家
  • GameDirectors - 默认的管理员权限
  • Admin
  • Host
  • Owner
  • Internal

listType

• 名单类型，针对下文的list
• 可选值如下
  • disabled - 禁用此功能
  • blacklist - 名单为黑名单
  • whitelist - 名单为白名单

list

• 名单
• 字符串数组，值应为玩家UUID

superManagerList

• 管理员名单

luaPreload

• lua预加载脚本内容
• 该段内容的执行时机为加载库之后、加载内置变量与脚本文件之前
• 可以用于禁用部分库，以创造安全的执行环境

PermissionConfig.json

version

• PermissionConfig.json配置文件的版本。当前版本CFSP为 1

功能项

• 每一个功能项对应假人的一个操作（如 spCreate、spSpawn、spLookAt、groupCreate 等），均包含以下字段：

enabled

• 是否启用该指令/操作

permission

• 执行所需权限，可选值同adminpermission

CFSP DLL API DOC

来源：CFSPApiDoc.md

DLLAPI

xmake配置

1. 按顺序导入相关库
2. 在target内添加依赖
3. 引入头文件即可使用

以下是导入相关库的例子

add_requires("levilamina", "timewheel", "CFSP")

头文件

• 您需要使用 cfsp/core/simPlayer/SimPlayer.h 。其他头文件定义的函数/数据并没有通过dllexport导出。
• 所有导出的函数都由 CFSP_API 标记。您可以查阅src/cfsp/core/simPlayer/SimPlayer.h来查看您可以调用哪些函数。
• 大部分函数的定义都是比较易懂的。你可以看指令系统是如何调用的来理解这些函数的意义。
• 额外地，我们提供了一些接口以获取 SimPlayer 以及相关信息。
• SimPlayer 的部分成员函数在自身指向游戏中假人的指针为空时会抛出错误。
• 函数的返回值大多为 base::OperateResult 类型，其枚举值见src/cfsp/base/OperateResult.h。

Q&A

来源：QA.md

Linux/Android/Mac/IOS能用吗

不直接能。目前LeviLamina和CF都没有直接支持Linux/Android/Mac/IOS系统。你可能需要 wine 等工具模拟Windows环境来运行。

手机能用吗

不直接能。CF只支持windows，不过你可以开一个本地服务器来运行，然后单人/用手机加入服务器。

Realms领域服能用吗

不能。Realms没有插件加载器

我用的某（可能是公益/面板）服务器提供商，能用吗

不一定能。这取决于它是否提供BDS with LeviLamina服务器。如果没有LeviLamina此插件无法运行。建议：使用VPS自行搭建服务器。

看不懂教程怎么办

如果是教程有表达不清楚的地方，欢迎提Issue/PR。

我的可视化不显示怎么办

检查前置资源包是否加载并全局启用。

1.xx.xx版本能用吗

CF目前基于LL 26.51.x，BDS版本为1.26.51。CoralFans与LeviLamina版本号从26.51起与BDS小版本号保持一致，请以插件发布页面对应的版本为准。

客户端（非服务器）能用吗

Windows可以，其他不行。自26.10起，CF适配了客户端版LeviLamina，可作为客户端Mod安装（放置于 mods/ 目录），此时键盘快捷键等功能可用。

会适配新版吗

取决于加载器能不能更新