Schneckenhaus 插件
是否曾想过从内部观察潜影盒的样子?
是否曾想进入一个箱子?
是否曾想把你的房子存放在物品栏里?
这个插件能满足你的所有需求!
视频
每个蜗牛壳(可进入的方块)都可以通过图形界面进行自定义:
- 重命名你的蜗牛壳
- 管理权限(所有者、进入权限、建造权限、白名单、黑名单)
- 追踪你放置蜗牛壳的位置
- 升级其大小
- 更改其颜色(适用于潜影盒)
- 更改其木材类型(适用于箱子)
如果你还犹豫不决,该插件还具备以下功能:
- 支持完全自定义的壳类型!
- 配置模板、物品、生成位置、出口方块、菜单方块、初始方块等更多选项
- 简单地将数据导入和导出到自定义文件格式。
- 在我们的 Discord 服务器上分享和下载你的自定义壳类型。
- 嵌套蜗牛壳:在另一个壳内时,还能进入另一个蜗牛壳!(递归意味着某事物具有自我引用的特性)
- 精细粒度的权限系统
- 启用家园壳以自动为新玩家提供一个新的蜗牛壳
- 在配置文件中配置其类型、颜色、大小等
- 防止服务器上的无家可归现象,并使家园壳不可丢失
- 高度可配置的自定义合成配方
- 指定可选材料以增加蜗牛壳的大小
- 指定可选材料以启用彩虹模式
- 支持带有自定义模型数据的物品
- 使用漏斗将物品传输进壳中和壳外。你可以在壳内构建整个工厂,并将其连接到外部世界!
- 如果你的蜗牛壳在物品栏中或放置在已加载的区块中,它将保持加载状态
- 支持多个世界,例如,一个用于存储玩家合成的壳的世界,另一个用于命令创建的壳的世界
- 强大的 Tab 补全语法高亮命令
- 超强大的壳管理工具:
是否曾想过删除由某个玩家在上周制作的所有大小为 13 且启用了白名单的浅蓝色潜影盒壳?
老实说:你一直都想这么做。而这个插件让它成为可能。
- 数据高效且安全地存储在 SQLITE 数据库中
- ……以及更多内容!
文档
目录:
- 命令
- 自定义壳
- 配置
- 权限
命令系统
壳选择器
当命令要求你指定一个或多个壳时,例如 /sh tp shell <shell> 或 /sh info <shell>,
你有多种方式来实现:
here 解析为你所在位置的那个壳,这是许多命令的默认值
selection 解析为你选中的所有壳,详见选择
<id> 解析为指定 ID 的那个壳
命令
sh
tp
shell <shell> 传送至某个壳
world <world> 传送至包含蜗牛壳的世界
info <shell> 在聊天栏显示有关特定壳的大量信息
menu <shell> 打开蜗牛壳的菜单
item <shell> 给予你与给定壳关联的物品
count
total 显示此服务器上蜗牛壳的总数
world <world> 显示存储在世界中的蜗牛壳数量
delete <shell> 删除一个壳,此操作不可撤销
create <type> 类型可以是 shulker(潜影盒)、chest(箱子)、head(头颅)或 custom(自定义);根据类型的不同,你需要指定以下一个或多个选项:
owner <owner>
world <world> 蜗牛壳将存储的世界
permission
enter <enterPermissionMode>
build <buildPermissionMode>
size <size> 仅适用于潜影盒和箱子壳,若未指定则为随机大小
color <color> 仅适用于潜影盒壳,若未指定则为随机颜色
rainbow <rainbow> 仅适用于潜影盒壳,默认为 false
head-owner <headOwner> 仅适用于头颅壳,默认为创建者
template <template> 仅适用于自定义壳,创建自定义壳必需
position 指定壳将在网格中的哪个位置生成,存在一些特殊情况
id <id> 位置的 ID
grid <x> <z> 位置的坐标
here 你当前位置
home
tp 传送至你自己的家园壳
tp <player> 传送至其他人的家园壳
set <player> <home>
unset <player>
language <language> 更改插件的语言
discord 显示加入我们 Discord 服务器的链接
tag <shell>
list
add <tag>
remove <tag>
clear
选择
选择功能是一个强大的特性,它允许你使用多种标准搜索蜗牛壳。此外,
选择使得能够在所有被选中的壳上运行其他命令。
每个玩家和服务台控制台都有一个当前的选择范围,默认情况下为空。
sh
selection
clear 删除你当前的选择
list 列出当前选中的蜗牛壳的 ID
select 此命令接受一个或多个必须全部为真的条件:
id <id> 你还可以指定一个范围,例如 7.. 或 7..42
world <world> 存储该贝壳的世界
position <position> 贝壳位置 ID,也可以是范围
type <type> 贝壳的类型,如 shulker、chest、head 或 custom
creation
reason <creationType> 可以是 crafting、command 或 home
time 时间戳必须按以下格式指定:'2025-08-21 21:01:42'
after <creationTimeMin>
before <creationTimeMax>
between <creationTimeMin> and <creationTimeMax>
creator <creator> 可以是 UUID、名称或玩家选择器
name <name> 贝壳的名称
permission 权限模式可以是 whitelist、blacklist、everybody、nobody
enter <enterPermissionMode>
build <buildPermissionMode>
size <size> 箱子盒和潜影盒的大小,也可以是像 4..8 这样的范围
color <color> 潜影盒的颜色
rainbow <rainbow> 一个布尔值,指示是否为潜影盒启用了彩虹模式
wood <wood> 箱子盒的木材类型,如 oak
template <template> 自定义贝壳的模板名称
head <head> 头颅贝壳的所有者
tag <tag> 选择具有特定标签的贝壳
owner <owner>
sort by <sortCriterion> <sortOrder>
- 排序依据可以是
id、position、size 或 creation_date
- 排序顺序可以是
ascending(升序)或 descending(降序)
limit <limit> 仅将前 <limit> 个结果包含在选中项中
offset <offset>
combine <combine> 指定旧选择和新选择应如何合并
replace(默认)表示用新选择替换旧选择
append 表示将新选择追加到旧选择之后(排除重复项)
remove 保留旧选择,但排除在新选择中的贝壳
intersect 仅保留新旧选择中都存在的贝壳
自定义贝壳
创建自定义贝壳
首先,你必须为你的自定义贝壳类型构建一个模板。
当实例化自定义贝壳类型时(例如通过合成),会在蜗牛壳世界中创建一个模板副本。
模板可以在任何世界中构建,但建议在蜗牛壳世界中构建。
为此,执行 /sh tp world schneckenhaus 以传送到默认的蜗牛壳世界。
你必须在每个模板方块都具有负 X 或 Z 坐标的位置构建你的模板。
否则,插件创建的贝壳和你的模板之间可能会发生冲突。
当你完成构建后,运行 /sh custom add <name> <world> <position1> <position2> <item> <ingredient>。
name 可以由你自由指定,用于标识你的自定义贝壳类型。
之后无法重命名你的自定义贝壳类型。
world 是你构建模板的世界,例如 schneckenhaus。
position1 和 position2 是模板的角位置。
查看这些角块并使用 Tab 补全功能来简化操作。
item 是将代表自定义贝壳实例的物品/方块。
ingredient 是用于合成自定义贝壳类型的材料。
你可以在配置文件中稍后编辑和添加材料。
使用命令 /sh custom edit <name> ... 你可以设置自定义贝壳类型的其他一些属性。
你也可以在配置文件中更改这些属性。
出生点
/sh custom edit <name> set-spawn
配置玩家在蜗牛壳中的出生位置以及其面朝的方向。
初始方块
/sh custom edit <name> add-initial-block <position>
/sh custom edit <name> add-initial-block-area <position1> <position2>
如果你希望复制某个方块,但允许玩家随后破坏并替换它,请将该方块配置为初始方块。
菜单方块
/sh custom edit <name> set-menu-block <position>
点击此方块将打开蜗牛壳菜单。
出口方块
/sh custom edit <name> add-exit-block <position>
点击其中一个方块将使玩家离开贝壳。
方块限制
/sh custom edit <name> set-block-restrictions <position> [<restriction1>] [<restriction2>] [<restriction3>]
/sh custom edit <name> set-block-area-restrictions <position1> <position2> [<restriction1>] [<restriction2>] [<restriction3>]
/sh custom edit <name> clear-block-restrictions <position1>
对于蜗牛壳中的每个方块,都有一个称为“方块限制”的方块类型列表。
如果某个方块的此列表为空,则表示没有限制,
玩家可以破坏该方块并在该位置放置另一个方块。
实际上,将一个方块添加为初始方块(使用 /sh custom <name> edit add-initial-block),在底层会将该方块的方块限制列表设置为空。
如果某个方块的限制列表不为空,则该方块的类型必须包含在该列表中。
如果不满足此不变量,玩家将无法放置/破坏方块。
此外,修复系统也强制执行此规则。
如果你没有明确指定方块的限制列表,则列表的默认值取决于该方块是空气方块还是非空气方块。
如果是空气方块,限制列表默认为空列表,意味着玩家可以在该方块位置放置任何他们想要的东西。
如果是非空气方块,限制列表默认为仅包含该非空气方块类型的列表。
这意味着玩家默认不能破坏属于模板的任何方块。
默认值也可以通过运行 /sh custom edit <name> set-protect-air true 来修改。
如果 protect_air 属性设置为 true,则模板中空气块的限制列表将默认为仅包含空气的列表。因此,除非在特定位置明确允许玩家放置方块,否则他们无法在自定义外壳内放置方块。
导出自定义外壳类型
运行 /sh custom export <name>。复制 plugins/Schneckenhaus/export 目录中生成的文件。
你可以在我们的 Discord 服务器上分享你的作品。
导入自定义外壳类型
将需要导入的文件放入 plugins/Schneckenhaus/import 目录。
移动到希望放置模板的世界和位置。
建议将模板放置在默认的蜗牛壳世界中。
为此,输入 /sh tp world schneckenhaus 以传送至该世界。
现在请确保你的 x 和 z 坐标均为负数,并且你距离正 x 或正 z 坐标足够远(例如 x = z = -100)。
这一点很重要,因为如果你将模板放置在其他外壳(它们的 x 和 z 坐标始终为正)附近,模板区域与外壳区域可能会重叠。
现在运行 /sh custom import <filename> as <name>。
name 将是用于引用新导入的外壳类型的别名。
导入后,自定义外壳类型无法重命名。
导入完成后,你可以使用合成配方(参见配置文件)或 /sh create custom template <name> 来创建自定义外壳类型的实例。
配置
潜影盒 / 箱子 / 头颅外壳配置
# 此文档同样适用于箱子和头颅外壳
shulker:
# 潜影盒外壳是否可以合成
crafting: true
# 除了(有色)潜影盒之外,合成所需的材料
ingredients:
- item: 'minecraft:spyglass'
amount: 1
# model 指附加到物品上的自定义模型数据(用于创建自定义物品)
model: null
# 未使用尺寸材料时的初始尺寸
initial_size: 4
# 通过添加尺寸材料所能达到的最大尺寸
max_size: 30
# 可选添加到合成配方中以增加外壳尺寸的材料
size_ingredient: { item: 'minecraft:gold_ingot', amount: 1, model: null }
# 每添加一个尺寸材料,尺寸增加的数值
size_per_ingredient: 2
# 通过升级所能达到的最大尺寸
max_upgrade_size: 30
# 用于在蜗牛壳菜单中升级尺寸的材料
upgrade_ingredient: { item: 'minecraft:gold_ingot', amount: 1, model: null }
# 每次升级尺寸增加的数值
size_per_upgrade_ingredient: 2
# 彩虹模式下颜色变化之间的刻数间隔
# 这也受 shell_instances_sync 的限制
rainbow_delay: 60
# 可添加到合成配方中以启用彩虹模式的材料
rainbow_ingredient: { item: 'minecraft:clock', amount: 1, model: null }
自定义外壳配置
注意:虽然可以通过配置文件添加和编辑自定义外壳类型,但使用此处描述的命令进行操作要容易得多。
custom:
# 你的自定义外壳类型的名称,除非你知道自己在做什么,否则不要更改此项
portable-garden:
item: minecraft:birch_wood # 代表此外壳类型的物品/方块
crafting: true
# 合成此自定义外壳类型所需的材料
ingredients:
- {item: 'minecraft:birch_log', amount: 64, model: null}
- {item: 'minecraft:birch_sapling', amount: 1, model: null}
- {item: 'minecraft:bone_meal', amount: 16, model: null}
- {item: 'minecraft:moss_block', amount: 32, model: null}
- {item: 'minecraft:spyglass', amount: 1, model: null}
template_world: schneckenhaus # 放置此外壳类型模板的世界名称
template_position: -30 0 -30 -20 10 -20 # 模板的区域范围
protect_air: false # 玩家是否默认可以在外壳内的任何地方建造
block_restrictions: # 有关此含义的详细解释,请参阅关于创建自定义外壳的部分
-25 1 -25: ['minecraft:cauldron', 'minecraft:lava_cauldron', 'water_cauldron']
spawn_position: {x: -188.50940344422307, y: 122.9375, z: 219.30000001192093, yaw: -18.117798,
pitch: 3.7506914}
# 点击这些方块会将你传送回来
exit_blocks: [-189 124 218, -189 123 218]
# 打开蜗牛壳菜单
menu_block: -188 123 218
家外壳配置
如果启用了家外壳,当玩家加入服务器且尚未拥有属于他们的家时,他们将自动获得一个新的外壳。
玩家必须拥有权限 schneckenhaus.home_shell(默认为 false)。
如果玩家还拥有权限 schneckenhaus.never_homeless(默认为 true),
那么他们将不可能失去他们的家。
这是因为如果他们失去了家,在重新加入游戏或重生时,家会被返还给他们。
示例:
home_shell:
type: shulker,
size: 16,
color: white
enter_permission_mode: everybody # 无论外壳类型如何,均可指定此项
build_permission_mode: whitelist # 但对于以下内容不再重复说明
home_shell:
type: chest
size: 16
wood: birch
home_shell:
type: head
home_shell:
type: custom
template: your-template-name
世界配置
示例:
worlds:
# 世界名称
schneckenhaus:
fallback: true # 这是否是用于创建蜗牛壳的默认世界,只能有一个世界为此值为 true
biome: 'plains' # 虚空世界的生物群系,此值仅在创建新世界时使用,不适用于已存在的世界
time_sync_world: world # 将与另一个世界同步时间
conditions: []
schneckenhaus_homes: # 例如,一个应包含所有主壳的第二世界
fallback: false
time_sync_world: world
conditions: # 至少需要满足以下条件之一,才能在此世界中创建壳
# 示例条件:由主壳系统创建的所有壳都将在此世界中创建
type: creation
creation_type: home
Shell Conditions
Shell 条件是 YAML 对象,可用于评估正在创建或已经创建的壳。
使用这些条件,您可以仅为某些壳启用某些功能。
有多种类型的壳条件。
如果您必须指定一组条件,通常至少需要其中一个为真。
不同条件类型的示例:
type: shulker
size: {min: 5, max: 10} # 可选
colors: green, red, white # 可选
rainbow: false # 可选
type: chest
size: {min: 5, max: 10} # 可选
wood: birch # 可选
type: head
type: custom
template: your_template_name # 可选
type: creation
creator: 7370723c-1f89-4e7c-a9fe-30ba8b4f0ae3 # 可选
creation_type: crafting # 可选,也可以是 command 或 home
permission: some.permission # 可选,创建者必须具备的权限,
# 仅能针对在线玩家进行检查
type: tag
tag: some-tag-name
type: not
condition:
type: shulker
size: {min: 10}
type: and
conditions:
- type: shulker
- type: creation
creation_type: crafting
Miscellaneous Config Options
# 如果启用,当蜗牛壳位于在线玩家的背包中或放置在已加载的区块中时,其区块将保持加载状态
chunk_loading:
enabled: true
conditions: []
delay: 100
# 如果启用,可以使用漏斗向蜗牛壳内传输物品以及从中取出物品
hoppers:
enabled: true
conditions: []
# 此系统处理动画(彩虹模式)和手动颜色更改
shell_instances_sync:
enabled: true
conditions: []
delay: 20
shells: true
placed_shells: true
placed_shells_range: 32
items: true # 为背包中的物品添加动画效果
dropped_items: true # 为掉落物添加动画效果
dropped_items_range: 16 # 距离玩家的最大范围
# 如果启用,玩家无法破坏其他玩家的蜗牛壳
# 可以通过权限设置例外情况
theft_prevention:
enabled: true
conditions: []
# 将防止利用活塞/末影珍珠等机制从壳中逃脱的漏洞
escape_prevention:
enabled: true
conditions: []
delay: 20
# 即使是最严重的损坏(如 WorldEdit 造成的),也会还原到蜗牛壳
repair_system:
enabled: true
conditions: []
delay: 200
# 当玩家离开壳且没有已知的出口位置时,将被传送至此
# 设置为 null 则使用世界重生点
fallback_exit_location:
world: world
x: 0
y: 80
z: 0
yaw: 0
pitch: 0
# 请勿更改此项
data_version: 3.0.0
Permissions
schneckenhaus.craft_shell (默认: true)
schneckenhaus.place_shell (默认: true)
schneckenhaus.enter_shell (默认: true)
schneckenhaus.quickly_enter_shell (默认: false)
schneckenhaus.enter_nested_shells (默认: true)
schneckenhaus.ask_for_enter_permission (默认: true)
schneckenhaus.change_enter_permission (默认: true)
schneckenhaus.bypass_shell_enter_permission (默认: op)
schneckenhaus.change_build_permission (默认: true)
schneckenhaus.bypass_shell_build_permission (默认: op)
schneckenhaus.bypass_theft_prevention (默认: op)
schneckenhaus.home_shell (默认: false)
schneckenhaus.never_homeless (默认: true)
schneckenhaus.shell_in_ender_chest (默认: true)
schneckenhaus.open_own_snail_shell_menu (默认: true)
schneckenhaus.open_other_snail_shell_menus (默认: op)
schneckenhaus.create_snail_shell_copies (默认: op)
schneckenhaus.rename_snail_shell (默认: true)
schneckenhaus.edit_owners (默认: true)
schneckenhaus.change_snail_shell_color (默认: true)
schneckenhaus.toggle_rainbow_mode (默认: true)
schneckenhaus.upgrade_snail_shell_size (默认: true)
schneckenhaus.change_shell_wood (默认: true)
schneckenhaus.delete_shell (默认: op)
schneckenhaus.placements.view (默认: true)
schneckenhaus.placements.view_positions (默认: true)
schneckenhaus.placements.teleport (默认: op)
schneckenhaus.bypass_escape_prevention (默认: op)
schneckenhaus.command.select (默认: op)
schneckenhaus.command.list (默认: op)
schneckenhaus.command.create (默认: op)
schneckenhaus.command.info (默认: op)
schneckenhaus.command.tag (默认: op)
schneckenhaus.command.item (默认: op)
schneckenhaus.command.count (默认: op)
schneckenhaus.command.delete (默认: op)
schneckenhaus.command.tp (默认: op)
schneckenhaus.command.home.tp.own (默认: op)
schneckenhaus.command.home.tp.others (默认: op)
schneckenhaus.command.home.manage (默认: op)
schneckenhaus.command.discord (默认: op)
schneckenhaus.command.menu (默认: op)
schneckenhaus.command.language (默认: op)
schneckenhaus.command.custom (默认: op)
schneckenhaus.command.debug (默认: false)
Schneckenhaus Plugin
Ever wanted to know how a shulker box looks from the inside?
Ever wanted to enter a chest?
Ever wanted to store your house in your inventory?
This plugin has you covered!
Videos
Every snail shell (an enterable block) can be customized using a graphical interface:
- Rename your snail shell
- Manage permissions (owners, enter permissions, build permissions, whitelists, blacklists)
- Keep track of where you placed down your snail shell
- Upgrade its size
- Change its color (for shulker boxes)
- Change its wood type (for chests)
If you aren't convinced yet, the plugin also features:
- Support for completely custom shell types!
- Configure the template, item, spawn position, exit blocks, menu block, initial blocks and more
- Simple importing and exporting to a custom file format.
- Share and download your custom shell types on our Discord server.
- Nested snail shells: Enter a snail while already inside another one! (Recursion means that something is recursive)
- Finely grained permissions
- Enable home shells to automatically give every new player a new snail shell
- Configure its type, color, size, etc. in the config
- Prevent homelessness on your server and make home shells impossible to lose
- Custom, highly configurable crafting recipes
- specify optional ingredients that increase the snail shell's size
- specify an optional ingredient that enabled rainbow mode
- support for items with custom model data
- Use hoppers to transfer items into shells and out of them. You can build whole factories inside a shell and connect them to the outside world!
- Your snail shell will stay loaded if you have it in your inventory or placed in a loaded chunk
- Support for multiple worlds, for example, one world where player-crafted shells are stored in, and one for command-created ones
- Powerful tab-completed syntax-highlighted commands
- Ultra powerful shell management tools:
Ever wanted to delete all light blue shulker box shells of size 13 with whitelist enabled owned by some player crafted in the last week?
Let's be honest: You always wanted to do exactly that. And this plugin makes it possible.
- Data is stored efficiently and securely in an SQLITE database
- ... and much more!
Documentation
Table of contents:
- Commands
- Custom Shells
- Configuration
- Permissions
Command System
Shell Selectors
When a command requires you to specify one or multiple shells like /sh tp shell <shell> or /sh info <shell>,
you have multiple ways to do so:
here resolves to the shell at your location, this is the default value for many commands
selection resolves to all shells you selected, see Selections
<id> resolves to the shell with the specified id
Commands
sh
tp
shell <shell> teleport to a shell
world <world> teleport to a world that contains snail shells
info <shell> displays a lot of information about a certain shell in the chat
menu <shell> opens a snail shell's menu
item <shell> gives you an item associated with the given shell
count
total displays the total number of snail shells on this server
world <world> displays the number of snail shells which are stored inside a world
delete <shell> deletes a shell, cannot be undone
create <type> type can be shulker, chest, head or custom; depending on the type, you specify one or more of these options:
owner <owner>
world <world> world in which the snail shell will be stored
permission
enter <enterPermissionMode>
build <buildPermissionMode>
size <size> only for shulker and chest shells, will be random in unspecified
color <color> only for shulker shells, will be random if unspecified
rainbow <rainbow> only for shulker shells, false by default
head-owner <headOwner> only for head shells, will be the creator by default
template <template> only for custom shells, required to create custom shells
position specify at which position in the grid the shell will be generated, has some quirks
id <id> id of the position
grid <x> <z> coordinates of the position
here position at your current location
home
tp teleports to your own home shell
tp <player> teleport to someone else's home shell
set <player> <home>
unset <player>
language <language> changes the plugin's language
discord shows the link to join our discord server
tag <shell>
list
add <tag>
remove <tag>
clear
Selections
Selections is a powerful feature, which enables you to search for snail shells using a variety of criteria. Besides,
selections make it possible to run other commands on all shells that are selected.
Every player and the server console has a current selection, which is empty be default.
sh
selection
clear deletes your current selection
list lists the ids of currently selected snail shells
select this command takes one or more criteria that must all be true:
id <id> you also specify a range like 7.. or 7..42
world <world> the world where the shell is stored
position <position> the id of the shell's position, can also be a range
type <type> the type of the shell, like shulker, chest, head or custom
creation
reason <creationType> can be crafting, command or home
time timestamps must be specified like this: '2025-08-21 21:01:42'
after <creationTimeMin>
before <creationTimeMax>
between <creationTimeMin> and <creationTimeMax>
creator <creator> can be an uuid, name or player selector
name <name> name of the shell
permission permission modes can be whitelist, blacklist, everybody, nobody
enter <enterPermissionMode>
build <buildPermissionMode>
size <size> size of chest and shulker shells, can also be a range like 4..8
color <color> color of shulker shells
rainbow <rainbow> a boolean that indicates whether rainbow mode is enabled for a shulker shell
wood <wood> the wood type of a chest shell like oak
template <template> the template name of a custom shell
head <head> the head owner of a head shell
tag <tag> selects shells that have a certain tag
owner <owner>
sort by <sortCriterion> <sortOrder>
- the sort criterion can be
id, position, size or creation_date
- the sort order can be
ascending or descending
limit <limit> only includes the first <limit> results in the selection
offset <offset>
combine <combine> specifies how the old and new selection should be merged
replace (default) means to replace the old selection with the new one
append means to append the new to the old (excluding duplicates)
remove keep the old selection except for the shells that are in the new selection
intersect keep only shells in both the new and old selection
Custom Shells
Creating Custom Shells
You first have to build a template for your custom shell type.
When the custom shell type is instantiated, e.g. through crafting, a copy of the template is created in the snail shell world.
The template can be built in any world, but it is advisable to build it in the snail shell world.
To do that, execute /sh tp world schneckenhaus to be teleported to the default snail shell world.
You must build your template at a position where every block of the template has either a negative x or z coordinate.
Otherwise, there could be conflicts between shells created by the plugin and your template.
When you are finished building, run /sh custom add <name> <world> <position1> <position2> <item> <ingredient>.
name can be freely chosen by you and is used to identify your custom shell type.
Renaming your custom shell type afterward is not possible.
world is the world where you built the template, for example schneckenhaus.
position1 and position2 are the corner positions of your template.
Look at these corner blocks and use tab completion to make your life easier.
item is the item/block that will represent an instance of your custom shell.
ingredient is an ingredient used to craft your custom shell type.
You can later edit and add ingredients in the config file.
Using the command /sh custom edit <name> ... you can set some other properties of your custom shell type.
You could also change this is the config file.
Spawn Point
/sh custom edit <name> set-spawn
Configure where the player spawns in the snail shell and in which direction he will look.
Initial Blocks
/sh custom edit <name> add-initial-block <position>
/sh custom edit <name> add-initial-block-area <position1> <position2>
If you want a block to be copied, but you want the player to be able to break it and replace it afterward, configure the block as an initial one.
Menu Block
/sh custom edit <name> set-menu-block <position>
Clicking this block will open the snail shell menu.
Exit Blocks
/sh custom edit <name> add-exit-block <position>
Clicking one of these blocks will make the player leave the shell.
Block Restrictions
/sh custom edit <name> set-block-restrictions <position> [<restriction1>] [<restriction2>] [<restriction3>]
/sh custom edit <name> set-block-area-restrictions <position1> <position2> [<restriction1>] [<restriction2>] [<restriction3>]
/sh custom edit <name> clear-block-restrictions <position1>
For every block in your snail shell, there is a list of block types, which is called "block restrictions".
If this list is empty for a block, it means that there are no restrictions,
and that the player can break the block and place another block at this position.
Actually adding a block as an initial block (using /sh custom <name> edit add-initial-block), will under the hood
set the block restrictions list for that block to be empty.
If the restriction list of a block is not empty, that block's type must be contained in the list.
Players won't be able to place/break blocks if this invariant is not fulfilled after that.
Besides, the repair system also enforces this.
If you don't explicitly specify the restriction list for a block, the list's default value depends on whether the block is an air or non-air one.
If it is an air block, the restriction list defaults to an empty list, meaning that players can place anything they want at that block position.
If it is a non-air block, the restriction list defaults to a list only containing the block type of that non-air block.
This means that players can't break any blocks that are part of the template by default.
The default values can also be changed by using /sh custom edit <name> set-protect-air true.
If the protect_air property is set to true, the restriction list of an air block in the template will default to a list
containing only air. Therefore, players can't place blocks in the custom shell unless they are explicitly allowed to do so
at a certain location.
Exporting Custom Shell Types
Run /sh custom export <name>. Copy the file created in the plugins/Schneckenhaus/export directory.
You can share your creations on our Discord server.
Importing Custom Shell Types
Place the file to import in the plugins/Schneckenhaus/import directory.
Move to the world and position where you want the template to be placed.
It is recommended to place your template in the default snail shell world.
To do that, type /sh tp world schneckenhaus to be teleported to this world.
Now make sure that your x and z coordinate are both negative, and that you are far enough away from positive x or z coordinates (e. g. x = z = -100)
This is important because if you place the template too near to other shells (which always have positive x and z coordinates), the template's area
and the shell's area could overlap.
Now run /sh custom import <filename> as <name>
name will be the alias you use to refer to the newly imported shell type.
Custom shell types can't be renamed afterward.
After importing, you can use the crafting recipe (see config file) or /sh create custom template <name> to create instances of your custom shell type.
Configuration
Shulker / Chest / Head Shell Configuration
# This documentation applies to chest and head shells accordingly
shulker:
# whether shulker shells can be crafted
crafting: true
# ingredients needed for crafting besides a (colored) shulker block
ingredients:
- item: 'minecraft:spyglass'
amount: 1
# model refers to the custom model data attached to an item (used to create custom items)
model: null
# the size if no size ingredient is used
initial_size: 4
# the maximum size that can be achieved through adding size ingredients
max_size: 30
# can be optionally added to the crafting recipe to increase the shell's size
size_ingredient: { item: 'minecraft:gold_ingot', amount: 1, model: null }
# how much the size will increase if one size ingredient is added
size_per_ingredient: 2
# the maximum size that can be achieved through upgrades
max_upgrade_size: 30
# used to upgrade the size in the snail shell menu
upgrade_ingredient: { item: 'minecraft:gold_ingot', amount: 1, model: null }
# how much the size increases per upgrade
size_per_upgrade_ingredient: 2
# number of ticks between color changes in rainbow mode
# this is also limited by shell_instances_sync
rainbow_delay: 60
# can be added to the crafting recipe to enable rainbow mode
rainbow_ingredient: { item: 'minecraft:clock', amount: 1, model: null }
Custom Shell Configuration
NOTE: While it is possible to add and edit custom shell types through the config file, it is way easier to do so
by using the commands described here
custom:
# name of your custom shell type, don't change this unless you know what you are doing
portable-garden:
item: minecraft:birch_wood # the item / block representing this shell type
crafting: true
# ingredients needed to craft this custom shell type
ingredients:
- {item: 'minecraft:birch_log', amount: 64, model: null}
- {item: 'minecraft:birch_sapling', amount: 1, model: null}
- {item: 'minecraft:bone_meal', amount: 16, model: null}
- {item: 'minecraft:moss_block', amount: 32, model: null}
- {item: 'minecraft:spyglass', amount: 1, model: null}
template_world: schneckenhaus # name of the world where the template for this shell type is placed
template_position: -30 0 -30 -20 10 -20 # area of the template
protect_air: false # whether players can build anywhere inside the shell by default
block_restrictions: # see the section about creating custom shells for a detailed explanation of what this means
-25 1 -25: ['minecraft:cauldron', 'minecraft:lava_cauldron', 'water_cauldron']
spawn_position: {x: -188.50940344422307, y: 122.9375, z: 219.30000001192093, yaw: -18.117798,
pitch: 3.7506914}
# clicking one of these blocks teleports you back
exit_blocks: [-189 124 218, -189 123 218]
# opens the snail shell menu
menu_block: -188 123 218
Home Shell Configuration
If home shells are enabled, players will automatically receive a new shell when they join the server
and don't already have a home belonging to them.
The player must have the permission schneckenhaus.home_shell (which is false by default).
If players additionally have the permission schneckenhaus.never_homeless (which is true by default),
it is impossible for them to lose their homes.
Because if they lose it, it will be given back to them on rejoin / respawn.
Examples:
home_shell:
type: shulker,
size: 16,
color: white
enter_permission_mode: everybody # this can be specified regardless of shell type
build_permission_mode: whitelist # but is not repeated for the following
home_shell:
type: chest
size: 16
wood: birch
home_shell:
type: head
home_shell:
type: custom
template: your-template-name
World Configuration
Example:
worlds:
# name of the world
schneckenhaus:
fallback: true # whether this is the default world for snail shell creation, can only be true for one world
biome: 'plains' # biome of the void world, this value is only used when newly creating the world, not for already existing ones
time_sync_world: world # will sync the time with another world
conditions: []
schneckenhaus_homes: # for example, a second world that should contain all home shells
fallback: false
time_sync_world: world
conditions: # at least one of the following conditions must be true for a shell to be created in this world
# example condition: all shells created by the home shell system will be created in this world
type: creation
creation_type: home
Shell Conditions
Shell conditions are YAML objects that can be evaluated for shells that are being created or are already created.
Using these conditions, you can enable some features only for some shells.
There are multiple types of shell conditions.
If you have to specify a list of conditions, usually at least one has to be true.
Examples of the different condition types:
type: shulker
size: {min: 5, max: 10} # optional
colors: green, red, white # optional
rainbow: false # optional
type: chest
size: {min: 5, max: 10} # optional
wood: birch # optional
type: head
type: custom
template: your_template_name # optional
type: creation
creator: 7370723c-1f89-4e7c-a9fe-30ba8b4f0ae3 # optional
creation_type: crafting # optional, can also be command or home
permission: some.permission # optional, permission which the creator must have,
# can only be checked for online players
type: tag
tag: some-tag-name
type: not
condition:
type: shulker
size: {min: 10}
type: and
conditions:
- type: shulker
- type: creation
creation_type: crafting
Miscellaneous Config Options
# if enabled, the chunks of a snail shell stay loaded if it is in an online player's inventory or placed in a loaded chunk
chunk_loading:
enabled: true
conditions: []
delay: 100
# if enabled, hoppers can be used to transfer items into snail shells and out of them
hoppers:
enabled: true
conditions: []
# this system handles animations (rainbow mode) and manual color changes
shell_instances_sync:
enabled: true
conditions: []
delay: 20
shells: true
placed_shells: true
placed_shells_range: 32
items: true # animate items in inventory
dropped_items: true # animate dropped items
dropped_items_range: 16 # max range near a player
# if enabled, players can't break other players' snail shells
# there can be exceptions to this via permissions
theft_prevention:
enabled: true
conditions: []
# will prevent exploits like using pistons / ender pearls etc. to escape a shell
escape_prevention:
enabled: true
conditions: []
delay: 20
# will revert even the most severe kinds of damages to snail shells (WorldEdit etc.)
repair_system:
enabled: true
conditions: []
delay: 200
# players will be teleported here when leaving a shell, but no exit location is known
# set to null to use world spawn
fallback_exit_location:
world: world
x: 0
y: 80
z: 0
yaw: 0
pitch: 0
# don't change this
data_version: 3.0.0
Permissions
schneckenhaus.craft_shell (default: true)
schneckenhaus.place_shell (default: true)
schneckenhaus.enter_shell (default: true)
schneckenhaus.quickly_enter_shell (default: false)
schneckenhaus.enter_nested_shells (default: true)
schneckenhaus.ask_for_enter_permission (default: true)
schneckenhaus.change_enter_permission (default: true)
schneckenhaus.bypass_shell_enter_permission (default: op)
schneckenhaus.change_build_permission (default: true)
schneckenhaus.bypass_shell_build_permission (default: op)
schneckenhaus.bypass_theft_prevention (default: op)
schneckenhaus.home_shell (default: false)
schneckenhaus.never_homeless (default: true)
schneckenhaus.shell_in_ender_chest (default: true)
schneckenhaus.open_own_snail_shell_menu (default: true)
schneckenhaus.open_other_snail_shell_menus (default: op)
schneckenhaus.create_snail_shell_copies (default: op)
schneckenhaus.rename_snail_shell (default: true)
schneckenhaus.edit_owners (default: true)
schneckenhaus.change_snail_shell_color (default: true)
schneckenhaus.toggle_rainbow_mode (default: true)
schneckenhaus.upgrade_snail_shell_size (default: true)
schneckenhaus.change_shell_wood (default: true)
schneckenhaus.delete_shell (default: op)
schneckenhaus.placements.view (default: true)
schneckenhaus.placements.view_positions (default: true)
schneckenhaus.placements.teleport (default: op)
schneckenhaus.bypass_escape_prevention (default: op)
schneckenhaus.command.select (default: op)
schneckenhaus.command.list (default: op)
schneckenhaus.command.create (default: op)
schneckenhaus.command.info (default: op)
schneckenhaus.command.tag (default: op)
schneckenhaus.command.item (default: op)
schneckenhaus.command.count (default: op)
schneckenhaus.command.delete (default: op)
schneckenhaus.command.tp (default: op)
schneckenhaus.command.home.tp.own (default: op)
schneckenhaus.command.home.tp.others (default: op)
schneckenhaus.command.home.manage (default: op)
schneckenhaus.command.discord (default: op)
schneckenhaus.command.menu (default: op)
schneckenhaus.command.language (default: op)
schneckenhaus.command.custom (default: op)
schneckenhaus.command.debug (default: false)
评论 0
登录后参与评分
还没有评论,来抢沙发吧