Build Guide - Build Guide 建造指南

Build Guide

一个仅限客户端使用的模组，可将圆形、球体等形状投影到世界中。它在单人和多人模式下都能工作，即使服务器没有安装该模组也没问题。

简短使用指南

显示

用法

按下“Open Build Guide”键（默认：B）会打开 Build Guide GUI，初始显示的是 Shape 子界面。切换左上角的“Enable”复选框可决定是否渲染形状。在该复选框稍下方，你可以找到两个按钮，用于在可用形状之间切换；可用形状见本使用指南底部的“Shapes”部分。“Set origin”按钮会将你脚下的小方块（默认红色）的位置设为原点。这个方块就是形状的基准点（例如一条线的起点或一个圆的中心）。你也可以使用“Set origin”按钮下方的文本框和按钮来修改原点。GUI 中间或右侧会列出当前所选形状的属性，例如半径或朝向。有些属性也允许负值，例如可将形状翻转到负轴方向。

“Visualization”按钮会带你进入一个子界面，在那里可以通过滑块修改形状的大方块（默认白色）和较小的原点方块（默认红色）的颜色。这个子界面还包含一个“Depth test”开关；关闭深度测试后，你将可以透过方块看到该形状。

按下“Shape list”可让你同时使用多个形状。在这个子界面中，按“Add”按钮会添加上方显示的那个形状实例。待添加的形状同样可以循环切换，以更改要添加的形状类型。列表中的每个形状都有各自的原点，初次添加时默认位于你脚下。点击屏幕中央列表中的某个形状即可选中它，黑色条表示当前选中。被选中的形状就是可在 Shape GUI 中编辑的那个。切换“Visible”复选框可以暂时隐藏所选形状，并且在总方块数统计中忽略它。按下“Delete”会删除所选形状。“Global origin”按钮和文本框会像主界面中的普通原点按钮一样移动所选形状的原点，但未选中形状的原点也会执行相同的相对位移，从而保持它们之间的相对位置不变。

所有形状及其设置都会绑定到世界名称（单人）或服务器 IP（多人）以及维度。若启用 persistenceEnabled 配置项，这些形状可在客户端重启后保留；否则客户端关闭时它们会丢失。

Shapes

Catenary：两点之间的一条悬链线（也叫链线或绳线），其弧长（绳长）为这两点间距离再加上一个给定的额外距离。

Circle：可围绕任意三条轴之一生成的圆形，并可堆叠形成墙体或管状结构。

Cone：可朝任意三条轴之一延伸的圆锥，具有给定的半径和高度。

Cuboid：一个可切换墙面的空心长方体。

Ellipse：可围绕任意三条轴之一生成的椭圆，并可堆叠形成墙体或管状结构。

Ellipsoid：一个椭球体，也可以转换成沿某个轴方向的六种半球罩之一。

Grid：一个方块网格，可为三条轴分别设置步长和步数。

Line：沿某条轴的六个方向之一延伸的一条线。

Parabola：一条抛物线，具有给定的半宽和高度，朝向指定方向，并按给定角度旋转。

Paraboloid：朝任意三条轴之一延伸的抛物面，具有两个给定的半宽和一个给定的高度。

Polygon：三角形、正方形、五边形、六边形等。可围绕任意三条轴之一旋转，并可堆叠形成墙体或管状结构。

Polygonal pyramid：底面为多边形的金字塔。可围绕任意三条轴之一旋转。注意，给定的高度不一定是最终高度。

Sphere：一个球体，也可以转换成沿某个轴方向的六种半球罩之一。

Torus：一个类似甜甜圈的形状，可配置半径和厚度，并可围绕任意三条轴之一生成。

完整使用指南

显示

The Build Guide GUI

Build Guide GUI 可通过快捷键访问。默认情况下，该快捷键为 B，但和其他快捷键一样，可以在 Minecraft 设置中更改（需在 GUI 关闭时进行：Minecraft 1.17 及以下为 Escape -> Options -> Controls；Minecraft 1.18 及以上为 Escape -> Options -> Controls -> Key Binds）。在这个子界面中，你一次只能操作一个形状。GUI 分为四个子界面，可通过顶部的四个按钮进入：“Shape”、“Visualization”、“Shape list”和“Configuration”。左上角有一个全局“Enable”复选框，用于切换形状渲染。此外，还有一个默认未绑定的快捷键“Toggled enabled”，可作为“Enable”复选框的替代方式。顶部会显示当前所选形状以及所有形状总计的方块数量。第一行是精确方块数，第二行则显示为若干组再加余数的形式。右上角的“X”按钮可关闭 GUI，与按下 Escape 的效果相同。

The Shape sub-GUI

Shape 子界面分为三个部分：“Shape”、“Origin”和“Shape properties”。

Shape

“Shape”部分用于决定显示哪种形状。初始情况下，它会是该模组所识别的第一个形状，通常应为圆。按当前形状名称左右两侧的箭头按钮，可以在可用形状之间切换。

Origin

到目前为止，你应该能看到一个正在渲染的随机形状（前提是你勾选了“Enable”复选框）。你很可能会想要移动这个形状，而这个子界面的这一部分就是干这个的。假设你还没有改动 Visualization GUI，那么你应该会看到两类被渲染的方块：大量白色方块用于勾勒形状，以及一个小红方块，被称为该形状的“origin（原点）”。这个原点是形状的基准，通常类似于圆心或线段起点。初始原点会是你第一次打开 GUI 时所在的位置。“Origin”部分中的按钮都会改变原点的位置，而勾勒形状的方块也会随之移动。第一个按钮“Set origin”会直接把原点移动到你脚下。其余三行则允许你更精细地控制位置的三个分量（X、Y 和 Z）。“-”与“+”按钮分别会减少或增加对应分量。你也可以在黑色文本框中输入精确数值。点击“Set”按钮后，程序会尝试将该分量设置为文本框中的值。如果该值不是有效的整数，则该分量不会更新，且文本会变红。输入有效数字后，它会再次变回白色。另外，还有一个默认未绑定的快捷键，其作用与“Set origin”按钮相同，名称也一样。

Shape properties

最后，“Shape properties”包含该形状的参数，例如长度、半径、朝向等。每种形状的参数及其说明可在本使用指南后面的“Shapes”部分中找到。在不同形状之间切换时，它们各自的参数会被保留。

The Visualization sub-GUI

按下“Visualization”按钮可打开 Visualization 子界面。这个子界面主要包含两组各四个滑块和两个按钮。左侧一组用于控制勾勒形状的方块颜色，右侧一组用于控制小型原点方块的颜色。每组的四个滑块分别控制对应方块类型的一项颜色分量：Red、Green、Blue 和 Alpha。其中 Alpha 表示透明度。将滑块调整到所需位置后，按下“Set”即可应用颜色。按下“Default”会将颜色恢复为默认值：形状勾勒方块为白色，原点方块为红色。底部的“Depth test”复选框决定渲染时是否启用深度测试，这个技术术语的意思是：“只有当它与相机之间没有其他东西遮挡时才绘制它”。换句话说，取消勾选“Depth test”后，你就能透过世界看到勾勒形状的方块和原点方块。不过这不能被用作透视或其他作弊方式，因为该模组不会以任何方式与世界交互。

The Shape List sub-GUI

按下“Shape list”按钮会进入 Shape List 子界面。与 Shape 子界面类似，Shape List 子界面也分为四个部分：“Add new shape”、“Selected shape”、“Global origin”和“Shapes”。

Add new shape

在这一部分中，你可以再次在不同形状之间切换。切换到目标形状后，按下其下方的“Add”按钮，即可将该形状添加到“Shapes”部分下方的列表中。新添加形状的原点会位于你脚下。你可以自由切换并添加其他形状，而不会影响之前添加的形状。

Selected shape

取消勾选“Visible”复选框会隐藏当前选中的形状，此时它会在形状列表中显示为被划掉的样式。按下“Delete”按钮会将该形状从列表中删除。

Global origin

这一部分与 Shape 子界面中的普通“Origin”部分工作方式类似。使用这里的按钮和文本框会设置当前选中形状的原点。不过，所有其他形状的原点也会随之改变，以保持各个形状之间的相对位置不变。和普通原点操作一样，“Set global origin”按钮也有一个同名的快捷键替代方式，默认未绑定。

Shapes

“Shapes”部分下方的列表会列出当前处于活动状态的形状。点击列表中的某个形状即可选中它，选中状态会以其周围的黑色边框表示。如果添加的形状太多而无法在屏幕上全部显示，列表右侧会出现滚动条。你可以拖动滚动条，或使用鼠标滚轮滚动列表。在 Visualization GUI 中设置颜色时，也只会影响当前选中的形状。不过，目前“Depth test”复选框仍然是一个全局设置，也就是说它会影响所有形状，而不仅仅是所选形状。未来这一行为很可能会调整，使其与其余可视化相关功能更一致。如果你已从列表中删除了所有形状，那么大多数子界面中的许多按钮都会被禁用，因为此时已没有任何可供操作的形状。重新添加一个形状后，它们会再次启用。

The Configuration sub-GUI

按下“Configuration”按钮会打开 Configuration 子界面。这个子界面为配置文件提供了一个直接且即时生效的操作界面（参见模组描述末尾的 Configuration 部分）。更改配置值后无需重启即可生效。

Shapes

大多数形状默认只能是奇数尺寸，因为原点位于一个方块的中心（例如这样一来，圆只能是 3x3、5x5、7x7 等）。这类形状通常都有一个“Even mode”复选框，用于在相关方向上将原点平移半个方块（沿用前面的例子，圆现在就只能是 4x4、6x6、8x8 等）。另外，有些参数也允许负值，例如可将形状翻转到负轴方向。

Catenary

悬链线，也称链线或绳线，即绳子悬挂在两点之间所形成的形状。悬链线基于两个点：原点，以及相对于原点、由参数“Delta X”、“Delta Y”和“Delta Z”描述的另一个点。这个第二个点也可以通过“Set endpoint”按钮设置，该按钮会将这个位置设为你脚下。悬链线的弧长（绳长）定义为这两点间距离再加上“Additional distance”中给定的值，该值必须为 1 或更大。

Circle

一个简单的圆。“Direction”属性决定该圆围绕哪条轴。例如当设为 X 时，圆会延伸到 Y 和 Z 方向。“Radius”用于设置圆的半径，可以是任意正整数。增加“Depth”会在“Direction”指定的方向上生成圆柱形管状结构。

Cone

圆锥。“Direction”属性决定圆锥朝向哪条轴。“Radius”用于设置圆锥的半径，可以是任意正整数。“Height”设置圆锥的高度，并且可以为负值。

Cuboid

长方体是一种空心的类立方体形状，其三条边长分别由参数“X”、“Y”和“Z”给出，这些值都必须为正整数。“Walls”参数显示当前启用的墙面，例如出现 X 表示朝向负 X 和正 X 方向的两个墙面已启用，Y 和 Z 同理。- 表示没有启用任何墙面，此时长方体仅显示线框。你可以选择让原点位于长方体的角落或中心。

Ellipse

椭圆与圆非常相似。唯一的区别是它不使用一个半径，而是使用两个半轴。这些半轴与半径的作用方式类似，但如果把半径理解为同时在两个方向上起作用，那么这些半轴则只在参数名称所表示的那个方向上起作用。

Ellipsoid

椭球体相对于球体，就像椭圆相对于圆。它与球体唯一的区别在于，它现在有三个半轴而不是一个半径。和球体一样，它也有 dome（穹顶）模式。

Grid

一个方块网格。每个方向上的方块数量和方块间步长都可以分别调整。

Line

一条简单的线。该线基于两个点：原点，以及相对于原点、由参数“Delta X”、“Delta Y”和“Delta Z”描述的另一个点。这个第二个点也可以通过“Set endpoint”按钮设置，该按钮会将该位置设为你脚下。

Parabola

抛物线。其形状由“Half-width”和“Height”参数描述，使得点 (Half-width,Height) 位于该抛物线上。“Direction”和“Rotation”允许抛物线朝向某个方向，并按给定角度旋转。“Depth”会沿“Direction”方向增加层数，并且可以为负值。

Paraboloid

抛物面。它的工作方式与抛物线类似，但现在拥有两个半宽，分别对应参数名称所指示的方向。此时旋转仅由“Direction”参数决定。

Polygon

多边形是一种具有给定边数的正多边形。边数由“Sides”参数给出；3 表示三角形，4 表示正方形，5 表示五边形，依此类推。“Sides”必须是大于等于 3 的整数。“Radius”是对半径一种较宽泛的理解，表示原点与其中一条边之间的距离。“Radius”必须是正整数。“Direction”的作用与圆中的相同，即决定多边形围绕哪条轴。“Rotation”是一个 90° 的整数倍，表示多边形的旋转角度。最后，“Depth”的工作方式也和圆一样。

Polygonal pyramid

底面为多边形的金字塔。其工作方式与普通多边形完全相同，但它使用“Height”作为金字塔高度，而不是“Depth”。

Sphere

一个球体，其半径由“Radius”给出，必须为正整数。“Dome”用于设置球体的穹顶模式：- 表示禁用，其他任意选项则只显示球体在所描述方向上的一个半球。

Torus

也称甜甜圈。和圆一样，“Direction”参数决定它围绕哪条轴。如果把环面想象成围绕一个圆环的管子，那么“Outer radius”是圆环的半径，而“Inner radius”是管子的半径。两者都必须为正整数，且“Outer radius”必须始终大于或等于“Inner radius”。如果“Outer radius”被设置得小于“Inner radius”，或“Inner radius”被设置得大于“Outer radius”，另一个参数会自动被设为相同的值。

在不同世界、服务器和维度之间移动

规划形状通常是在一个非常具体的环境中进行的；你在单人世界中设计的形状，放到你最喜欢的服务器或另一个世界里可能毫无意义；而你在主世界中规划好的建筑，到了末地可能会漂浮在距离你 500 格远的虚空中，完全派不上用场。因此，该模组的最新版本会针对每一种唯一的“世界/服务器 IP + 维度”组合保存不同的状态。撰写本文时，还没有办法将这些状态转移到其他世界/服务器/维度，但未来版本将会加入对此行为的开关，以及移动/复制状态的功能。默认情况下，客户端重启后，形状和状态都会丢失。启用配置项 persistenceEnabled 后，模组将能够把形状和状态保存到文件中，并在客户端重启时恢复它们。由于技术限制，状态恢复会在你打开 GUI 时开始进行。

要求

像 1.21/1.21.1 这样的版本标注表示它们基于 1.21 构建，但通常也应能在 1.21.1 上运行。

Forge 1.20/1.20.1：Minecraft Forge 46.0.14 或更高版本。\

Forge 1.20.2/1.20.3：Minecraft Forge 48.1.0 或更高版本。\

Forge 1.20.4/1.20.5：Minecraft Forge 49.2.2 或更高版本。\

Forge 1.20.6：Minecraft Forge 50.2.2 或更高版本。\

Forge 1.21/1.21.1：Minecraft Forge 51.0.33 或更高版本。\

Forge 1.21.3：Minecraft Forge 53.1.4 或更高版本。\

Forge 1.21.4：Minecraft Forge 54.1.8 或更高版本。\

Forge 1.21.5：Minecraft Forge 55.1.2 或更高版本。\

Forge 1.21.8：Minecraft Forge 58.1.7 或更高版本。\

Forge 1.21.10：Minecraft Forge 60.0.20 或更高版本。\

Forge 1.21.11：Minecraft Forge 61.0.5 或更高版本。

Fabric 1.20/1.20.1：Fabric Loader 0.17.3 或更高版本，且 Fabric API 0.83.0 或更高版本。\

Fabric 1.20.2/1.20.3：Fabric Loader 0.17.3 或更高版本，且 Fabric API 0.91.6 或更高版本。\

Fabric 1.20.4/1.20.5：Fabric Loader 0.17.3 或更高版本，且 Fabric API 0.97.1 或更高版本。\

Fabric 1.20.6：Fabric Loader 0.17.3 或更高版本，且 Fabric API 0.100.8 或更高版本。\

Fabric 1.21/1.21.1：Fabric Loader 0.17.3 或更高版本，且 Fabric API 0.102.0 或更高版本。\

Fabric 1.21.3：Fabric Loader 0.17.3 或更高版本，且 Fabric API 0.114.1 或更高版本。\

Fabric 1.21.4：Fabric Loader 0.17.3 或更高版本，且 Fabric API 0.119.4 或更高版本。\

Fabric 1.21.5：Fabric Loader 0.17.3 或更高版本，且 Fabric API 0.128.2 或更高版本。\

Fabric 1.21.8：Fabric Loader 0.17.3 或更高版本，且 Fabric API 0.136.0 或更高版本。\

Fabric 1.21.10：Fabric Loader 0.17.3 或更高版本，且 Fabric API 0.138.3 或更高版本。\

Fabric 1.21.11：Fabric Loader 0.18.4 或更高版本，且 Fabric API 0.140.2 或更高版本。

NeoForge 1.21/1.21.1：NeoForge 21.0.167 或更高版本。\

NeoForge 1.21.3：NeoForge 21.3.93 或更高版本。\

NeoForge 1.21.4：NeoForge 21.4.155 或更高版本。\

NeoForge 1.21.5：NeoForge 21.5.95 或更高版本。\

NeoForge 1.21.8：NeoForge 21.8.47 或更高版本。\

NeoForge 1.21.10：NeoForge 21.10.52-beta 或更高版本。\

NeoForge 1.21.11：NeoForge 21.11.23-beta 或更高版本。

兼容性

不保证通过 Optifine 与着色器兼容。已知 Optifine 中的着色器会因一个似乎出在 Optifine 本身的问题而破坏这些投影效果。Optifine 的非着色器功能看起来则可以正常工作。

从 Minecraft 1.21.5 开始，该模组应当明确兼容 Iris，即使启用了着色器也是如此。

该模组被设计为仅在客户端运行。不建议在服务器上安装此模组，但作者已尝试避免服务器立即崩溃，并且客户端不应因为未安装该模组（或未安装正确版本）而被拒绝连接；不过，这种服务端行为既不受支持，也不做保证。

配置

配置文件位于游戏目录下名为 config 的文件夹中，文件名为 buildguide.cfg。也可以通过 Configuration 子界面进行编辑。可配置的选项如下：

debugGenerationTimingsEnabled (默认：false)\

一个调试选项，用于将生成形状所花费的时间输出到日志中。

asyncEnabled (默认：true)\

启用此选项后，形状将以异步方式生成，这意味着形状会在后台构建，而不会阻塞你的客户端。启用该选项可能会导致形状投影出现轻微闪烁，因此如果你对闪烁图像较为敏感，尤其是在使用该模组时感到不适，建议考虑关闭此选项。这个问题应会在未来某个时候得到解决。

shapeListRandomColorsDefaultEnabled (默认：false)\

启用此选项后，在 Shape List 子界面中添加新形状时，将随机生成其颜色，而不是使用默认的白色和红色。

persistenceEnabled (默认：false)\

实验性选项，因 Forge 上存在一些奇怪的问题而默认关闭。启用此选项后，形状和状态会被保存到文件中，从而允许该模组在客户端重启后恢复这些形状。

模组包

可以随意将它加入模组包中！