建造指南
一个仅客户端的模组,用于将圆形和球形等形状投射到世界中。它在单人游戏和多人游戏中均能工作,即使服务器未安装该模组也是如此。
简要使用指南
显示
使用方法
按下“打开建造指南”按键(默认为“B”)将打开建造指南 GUI,初始界面位于“形状”子 GUI。切换左上角的“启用”复选框可以决定是否渲染形状。在该复选框下方,有两个按钮用于循环切换可用的形状,这些形状可以在本使用指南底部的“形状”部分找到。“设置原点”按钮会将你脚下的小方块(默认为红色)设置为原点位置。这个方块是形状的基础(例如,直线的起点或圆形的中心)。也可以通过“设置原点”按钮下方的文本字段和按钮来更改原点。GUI 的中间或右侧列出了当前所选形状的属性列表,如半径或方向。某些属性还允许负值,这可以将形状沿负轴翻转,例如。
“可视化”按钮带你进入一个子 GUI,其中包含滑块,用于更改形状较大立方体(默认为白色)和较小原点立方体(默认为红色)的颜色。该子 GUI 还包含一个切换“深度测试”的选项;禁用深度测试后,你可以透过方块看到形状。
按下“形状列表”允许你同时使用多个形状。在此子 GUI 中,按下“添加”按钮会添加上方所示形状的实例。待添加的形状同样可以通过循环切换来更改。列表中的每个形状都有各自的原点,默认情况下在首次添加时位于你的脚下。点击屏幕中央列表中的形状即可选中它,选中状态由黑色条指示。被选中的形状是在形状 GUI 中可以更改的那个。切换“可见性”复选框可以暂时隐藏选中的形状,并在总方块数统计中忽略它。按下“删除”将删除选中的形状。“全局原点”按钮和文本字段以与主 GUI 中原点按钮相同的方式移动选中形状的原点,但未选中形状的原点也会进行相同的相对移动,从而保持相对的起源位置。
所有形状及其设置都绑定到世界名称(单人游戏)或服务器 IP(多人游戏)以及维度。通过启用 persistenceEnabled 配置选项,可以在客户端重启之间保留形状。否则,当客户端关闭时,形状将会丢失。
形状
悬链线 (Catenary): 两个点之间的悬链线(又称链条或绳索线),其弧长(绳索长度)为这两点之间的距离加上给定的额外距离。
圆形 (Circle): 围绕三个轴中任意一个轴的圆形,可以堆叠形成墙壁或管道。
圆锥 (Cone): 指向三个轴中任意一个轴的圆锥,具有给定的半径和高度。
长方体 (Cuboid): 具有可切换墙壁的空心长方体。
椭圆 (Ellipse): 围绕三个轴中任意一个轴的椭圆,可以堆叠形成墙壁或管道。
椭球 (Ellipsoid): 椭球,也可以根据沿轴的方向转换为六种可能的穹顶之一。
网格 (Grid): 具有给定步长和每个轴向步骤数的方块网格。
直线 (Line): 沿轴六个方向之一的直线。
抛物线 (Parabola): 具有给定半宽度和高度的抛物线,面向给定方向并按给定角度旋转。
抛物面 (Paraboloid): 指向三个轴中任意一个轴的抛物面,具有两个给定的半宽度和给定的高度。
多边形 (Polygon): 三角形、正方形、五边形、六边形等。可以围绕三个轴中的任意一个轴旋转,并且可以堆叠形成墙壁或管道。
多边形金字塔 (Polygonal pyramid): 底面为多边形的金字塔。可以围绕三个轴中的任意一个轴旋转。注意:给定的高度可能不是最终高度。
球体 (Sphere): 球体,也可以根据沿轴的方向转换为六种可能的穹顶之一。
环形 (Torus): 类似甜甜圈的形状,具有可配置的半径和厚度,可以围绕三个轴中的任意一个轴放置。
完整使用指南
显示
建造指南 GUI
可以使用快捷键访问建造指南 GUI。默认情况下,此快捷键为“B”,但像任何快捷键一样,可以通过 Minecraft 的设置进行更改(对于 Minecraft 1.17 及更低版本,在 GUI 关闭状态下,按 Escape -> Options -> Controls;对于 Minecraft 1.18 及更高版本,按 Escape -> Options -> Controls -> Key Binds)。在此子 GUI 中,你一次只能处理一个形状。GUI 分为四个子 GUI,可通过顶部的四个按钮访问:“Shape”、“Visualization”、“Shape list”和“Configuration”。左上角有一个全局“启用”复选框,用于切换形状的渲染。还存在一个名为“Toggled enabled”的快捷键,默认未绑定,作为“Enable”复选框的替代方案。所选形状的总方块数和所有形状的总方块数显示在顶部。第一行是方块的精确数量。第二行以堆栈数量和余数的形式显示该数量。右上角的“X”按钮将关闭 GUI,就像按 Escape 键一样。
形状子 GUI
形状子 GUI 分为三个部分:“Shape”、“Origin”和“Shape properties”。
形状 (Shape)
“形状”部分确定显示哪种形状。最初,这将是模组知道的第一个形状,应该是一个圆形。按下当前形状名称左右两侧的箭头按钮将在可用形状之间循环切换。
原点 (Origin)
到目前为止,你应该已经看到一个随机形状被渲染出来(如果你勾选了“启用”复选框)。你很可能会想要移动这个形状,而这正是子 GUI 中这一部分的功能所在。假设你尚未触碰过可视化 GUI,你会看到两种类型的方块被渲染出来:大量白色方块勾勒出形状轮廓,以及一个红色小方块,称为形状的“原点”。该原点是形状的基础,通常类似于圆心或直线的起点。初始原点将是你在首次打开 GUI 时所处的位置。“原点”部分中的所有按钮都会改变原点的位置,而勾勒形状的方块也会随之移动。第一个按钮“设置原点”会将原点直接移动到你脚下。其余三行则允许对位置的三个分量(X、Y 和 Z)进行更精细的控制。“-”和“+”按钮分别用于递减和递增相应的分量。可以在黑色文本框中输入精确数值。点击“设置”按钮会尝试将分量设置为文本框中的值。如果该值不是有效的整数,分量将不会更新,且文本会变红。输入有效数字后,文本会再次变白。此外,还存在一个快捷键绑定,默认未绑定,其作用类似于“设置原点”按钮,且名称相同。
形状属性
最后,“形状属性”包含形状的参数;长度、半径、方向等。每种形状的参数及其说明可在本使用指南后面的“形状”部分找到。在切换形状时,它们的参数会被保留。
可视化子 GUI
按“可视化”按钮即可打开可视化子 GUI。可视化子 GUI 主要包含两组四个滑块和两个按钮。左侧一组控制勾勒形状的方块的颜色,右侧一组控制原点小方块的颜色。每个滑块的四个通道分别控制相应类型方块颜色的一个分量:红色、绿色、蓝色和 Alpha。其中,Alpha 是方块的透明度。将滑块调整到所需位置后,按“设置”即可应用颜色。按“默认”会将颜色恢复为默认的勾勒形状方块的白色和原点方块的红色。底部的“深度测试”复选框决定渲染时是否使用深度测试,这是“仅在没有物体介于它与相机之间时才绘制此物体”的技术术语。换句话说,取消勾选“深度测试”将使你能透过世界看到勾勒形状的方块和原点方块。这不能用作透视作弊或其他类型的作弊手段,因为该模组与游戏世界没有任何交互。
形状列表子 GUI
按“形状列表”按钮将进入形状列表子 GUI。与形状子 GUI 类似,形状列表子 GUI 也分为四个部分:“添加新形状”、“选中形状”、“全局原点”和“形状”。
添加新形状
在此部分,你可以再次在形状之间循环切换。切换到目标形状并按下方的“添加”按钮,即可将该形状添加到“形状”部分的列表中。新添加的形状的原点将位于你脚下。你可以自由循环并添加其他形状,而不会影响之前已添加的形状。
选中形状
禁用“可见性”复选框将隐藏选中的形状,这在形状列表中会以删除线标示。按“删除”按钮将从形状列表中删除该形状。
全局原点
此部分的工作原理与形状子 GUI 中的普通“原点”部分类似。使用按钮和文本字段将设置当前选中形状的原点。然而,所有其他形状的原点也会随之改变,以保持形状之间的相对位置不变。与普通原点处理一样,“设置全局原点”按钮也有同名的快捷键替代方案,默认未绑定。
形状
“形状”部分下方的列表列出了当前激活的形状。点击列表中的某个形状即可选中它,选中状态由围绕它的黑色方框标示。如果添加的形状太多导致无法全部显示在屏幕上,列表右侧会出现滚动条。拖动滚动条或使用鼠标滚轮均可滚动列表。在可视化 GUI 中设置的配色也只会影响当前选中的形状。不过,目前深度测试复选框仍然是全局设置,意味着它会影响所有形状,而不仅仅是选中的那个。这种行为未来可能会更改,以更好地与其他可视化功能保持一致。如果你从列表中删除了所有形状,大部分子 GUI 中的许多按钮将被禁用,因为此时没有可操作的形状。重新添加形状后,这些按钮将再次启用。
配置子 GUI
按“配置”按钮将打开配置子 GUI。该子 GUI 提供了对配置文件(参见模组描述末尾的“配置”部分)的直接且即时的接口。更改值无需重启即可生效。
形状
大多数形状默认只能生成奇数尺寸,因为原点位于单个方块的中心(例如,这样圆圈只能是 3x3、5x5、7x7 等)。这类形状都有一个“偶数模式”复选框,用于将原点沿相关方向偏移半个方块(从前面的例子来看,圆圈现在只能是 4x4、6x6、8x8 等)。某些参数还允许负值,从而可以将形状向负轴翻转,例如。
悬链线
悬链线,也称为链线或绳索线,是绳索悬挂在两点之间所形成的形状。悬链线基于的两个点是原点和由参数“Delta X”、“Delta Y”和“Delta Z”描述的相对于原点的点。第二个点也可以使用“Set endpoint(设置端点)”按钮进行设置,该按钮会将此位置放置在您的脚下。悬链线的弧长(即绳索的长度)由两点之间的距离加上“Additional distance(额外距离)”中给出的值定义,该值必须为 1 或更大。
圆形
一个简单的圆形。“Direction(方向)”属性决定了圆形围绕哪个轴旋转。例如,当设置为“X”时,圆形将在 Y 和 Z 方向上延伸。“Radius(半径)”将设置圆形的半径,可以是任何正整数。增加“Depth(深度)”会在“Direction(方向)”给定的方向上创建一个圆柱形管道。
圆锥体
一个圆锥体。“Direction(方向)”属性决定了圆锥体指向哪个轴。“Radius(半径)”将设置圆锥体的半径,可以是任何正整数。“Height(高度)”设置圆锥体的高度,可以为负数。
长方体
长方体是一种空心的类立方体形状,每条边的长度由参数“X”、“Y”和“Z”给出,它们都必须是正整数。“Walls(墙壁)”参数显示当前激活的墙壁,例如,“X”的存在意味着朝向负 X 方向和正 X 方向的墙壁已启用,Y 和 Z 同理。“-”表示未启用任何墙壁,长方体仅是一个线框。您可以选择原点作为长方体的角还是中心。
椭圆
椭圆与圆形非常相似。唯一的区别是,它不使用半径,而是使用两个半轴。这些半轴的作用类似于半径,但如果认为半径在两个方向上起作用,那么这些半轴只在一个方向上起作用,即参数名称中显示的那个方向。
椭球体
椭球体对于球体,就像椭圆对于圆形一样。它与球体的唯一区别在于它现在有三个半轴而不是一个半径。像球体一样,它也具有穹顶模式。
网格
由方块组成的网格。每个方向的方块数量和方块之间的步长都可以更改。
直线
一条简单的直线。直线基于的两个点是原点和由参数“Delta X”、“Delta Y”和“Delta Z”描述的相对于原点的点。第二个点也可以使用“Set endpoint(设置端点)”按钮进行设置,该按钮会将此位置放置在您的脚下。
抛物线
一条抛物线。其形状由参数“Half-width(半宽)”和“Height(高度)”描述,使得点 (Half-width, Height) 成为抛物线的一部分。“Direction(方向)”和“Rotation(旋转)”允许抛物线面向特定方向并按给定量旋转。“Depth(深度)”将向“Direction(方向)”添加层,且可以为负数。
抛物面
一个抛物面。它的工作原理类似于抛物线,但现在在由参数名称给定的方向上有两个半宽。旋转现在仅由“Direction(方向)”参数给出。
多边形
多边形是具有给定边数的规则形状。这个边数由“Sides(边数)”参数给出;3 给出三角形,4 给出正方形,5 给出五边形,等等。“Sides(边数)”参数必须是 3 或更高的整数。“Radius(半径)”是对半径的一种较为宽松的解释,它是原点到其中一条边的距离。“Radius(半径)”必须是正整数。“Direction(方向)”的工作方式与圆形类似,因为它决定了多边形围绕哪个轴旋转。“Rotation(旋转)”是多边形将旋转的 90° 的倍数。最后,“Depth(深度)”的工作方式再次与圆形相同。
多边形金字塔
底面为多边形的金字塔。它的工作原理与普通多边形完全相同,但用“Height(高度)”代替了“Depth(深度)”来表示金字塔的高度。
球体
一个球体,其半径由“Radius(半径)”给出,这是一个正整数。“Dome(穹顶)”设置球体的穹顶模式:“-”表示禁用,任何其他选项将仅在它所描述的方向上显示球体的一个半球。
环形体
也被称为甜甜圈。像圆形一样,“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.8.
Forge 1.20.6: Minecraft Forge 50.2.9.
Forge 1.21/1.21.1: Minecraft Forge 51.0.33.
Forge 1.21.3: Minecraft Forge 53.1.11.
Forge 1.21.4: Minecraft Forge 54.1.17.
Forge 1.21.5: Minecraft Forge 55.1.11.
Forge 1.21.8: Minecraft Forge 58.1.19.
Forge 1.21.10: Minecraft Forge 60.1.11.
Forge 1.21.11: Minecraft Forge 61.1.19.
Forge 26.1.2: Minecraft Forge 64.0.11.
Forge 26.2: Minecraft Forge 65.0.4.
Forge 26.3: Minecraft Forge 66.0.9.
Fabric 1.20/1.20.1: Fabric Loader 0.19.3 and Fabric API 0.83.0.
Fabric 1.20.2/1.20.3: Fabric Loader 0.19.3 and Fabric API 0.91.6.
Fabric 1.20.4/1.20.5: Fabric Loader 0.19.3 and Fabric API 0.97.3.
Fabric 1.20.6: Fabric Loader 0.19.3 and Fabric API 0.100.8.
Fabric 1.21/1.21.1: Fabric Loader 0.19.3 and Fabric API 0.102.0.
Fabric 1.21.3: Fabric Loader 0.19.3 and Fabric API 0.114.1.
Fabric 1.21.4: Fabric Loader 0.19.3 and Fabric API 0.119.4.
Fabric 1.21.5: Fabric Loader 0.19.3 and Fabric API 0.128.2.
Fabric 1.21.8: Fabric Loader 0.19.3 and Fabric API 0.136.1.
Fabric 1.21.10: Fabric Loader 0.19.3 and Fabric API 0.138.4.
Fabric 1.21.11: Fabric Loader 0.19.3 and Fabric API 0.141.4.
Fabric 26.1.2: Fabric Loader 0.19.3 and Fabric API 0.154.2.
Fabric 26.2: Fabric Loader 0.19.3 and Fabric API 0.154.2.
Fabric 26.3: Fabric Loader 0.19.5 and Fabric API 0.161.0.
NeoForge 1.21/1.21.1: NeoForge 21.0.167.
NeoForge 1.21.3: NeoForge 21.3.96.
NeoForge 1.21.4: NeoForge 21.4.157.
NeoForge 1.21.5: NeoForge 21.5.97.
NeoForge 1.21.8: NeoForge 21.8.53.
NeoForge 1.21.10: NeoForge 21.10.64.
NeoForge 1.21.11: NeoForge 21.11.42.
NeoForge 26.1.2: NeoForge 26.1.2.80.
NeoForge 26.2: NeoForge 26.2.0.18-beta.
NeoForge 26.3: NeoForge 26.3.0.45-beta.
兼容性
通过 Optifine 兼容光影的功能无法得到保证。已知 Optifine 中的光影会因看似属于 Optifine 自身的问题而导致投影失效。Optifine 中非光影相关的功能似乎运行完全正常。
从 Minecraft 1.21.5 开始,该模组明确与 Iris 兼容,即使启用光影也是如此。
本模组设计为仅在客户端运行。不建议在服务器上安装此模组,但已采取措施防止服务器立即崩溃,且未安装(正确版本)模组的客户端不应被拒绝访问。不过,这种服务端行为既不受支持也无法保证。
配置
配置文件位于游戏目录下的 config 文件夹中,文件名为 buildguide.cfg。你也可以使用配置子 GUI 进行编辑。可配置的选项如下:
debugGenerationTimingsEnabled(默认值:false)
一个调试选项,用于将生成形状所需的时间打印到日志中。
asyncEnabled(默认值:true)
启用此选项后,形状将在后台异步生成,无需阻塞你的客户端。启用此选项可能导致形状投影出现闪烁,因此如果你对标有闪烁的图像敏感,尤其是使用该模组时感到不适,请考虑禁用此选项。此问题有望在未来得到解决。
shapeListRandomColorsDefaultEnabled(默认值:false)
启用此选项后,向“形状列表”子 GUI 添加新形状时,将随机生成其颜色,而不是使用默认的红色和白色。
persistenceEnabled(默认值:false)
实验性选项,由于 Forge 上存在一些奇怪的问题,默认处于禁用状态。启用此选项后,形状和状态将被保存到文件中,从而允许模组在客户端重启后恢复形状。
整合包
欢迎将其添加到你的整合包中!
Build Guide
A client-side only mod to project shapes like circles and spheres into the world. It works both in singleplayer and multiplayer, even if the server doesn't have the mod installed.
Short usage guide
Show
Usage
Pressing the 'Open Build Guide' key (default: 'B') will open the Build Guide GUI, which is at the Shape sub-GUI initially. Toggling the 'Enable' checkbox on the top-left will determine whether or not a shape will be rendered. A bit below this checkbox, you can find two buttons to cycle through the available shapes, which can be found in the 'Shapes' section at the bottom of this usage guide. The 'Set origin' button will set the location of the little cube (red by default) at your feet. This cube is what the shape will be based on (for example, the start of a line or the centre of a circle). The origin can also be changed using the text fields and button below the 'Set origin' button. In the middle or on the right of the GUI is a list of properties belonging to the currently selected shape, like the radius or the orientation. Some properties also allow negative values, which can flip a shape towards a negative axis, for example.
The 'Visualization' button takes you to a sub-GUI with sliders to change the colours of the larger cube of the shape (white by default) and the smaller origin cube (red by default). This sub-GUI also contains an option to toggle 'Depth test'; having depth test disabled allows you to see the shape through blocks.
Pressing 'Shape list' will allow you to use multiple shapes at once. In this sub-GUI, pressing the 'Add' button adds an instance of the shape shown above. The to-be-added shape can, again, be cycled to change what shape to add. Each shape in the list has its own origin, which by default is at your feet when first adding it. Clicking a shape in the list in the centre of the screen will select it, indicated by the black bar. The selected shape is the one that can be changed in the Shape GUI. Toggling the 'Visible' checkbox can temporarily hide the selected shape and ignores it in the total number of blocks count. Pressing 'Delete' will delete the selected shape. The 'Global origin' buttons and text fields shift the origin of the selected shape the same way as the normal origin buttons in the main GUI, but the origins of the unselected shapes will also do the same relative shifts, preserving the relative origins.
All the shapes and their settings are bound to world name (singleplayer) or server IP (multiplayer) and the dimension. The shapes can be preserved between restarts of the client by enabling the persistenceEnabled config option. Otherwise, the shapes will be lost when the client closes.
Shapes
Catenary: A catenary (aka a chain or rope line) between two points with a arc length (rope length) of the distance between these points plus a given additional distance.
Circle: A circle that can be around any of the three axes and can be stacked to form walls or tubes.
Cone: A cone that can be towards any of the three axes with a given radius and height.
Cuboid: A hollow cuboid with toggleable walls.
Ellipse: An ellipse that can be around any of the three axes and can be stacked to form walls or tubes.
Ellipsoid: An ellipsoid which can also be turned into one of six possible domes towards a direction along an axis.
Grid: A grid of blocks with a given step size and number of steps in each of the three axes.
Line: A line in one of the six directions along an axis.
Parabola: A parabola with a given half-width and height, facing a given direction and rotated by a given angle.
Paraboloid: A paraboloid towards any of the three axes with two given half-width and a given height.
Polygon: A triangle or a square or a pentagon or a hexagon, etc. Can be rotated around any of the three axes and can be stacked to form walls or tubes.
Polygonal pyramid: A pyramid with the base of a polygon. Can be rotated around any of the three axes. Note that the given height may not be the final height.
Sphere: A sphere which can also be turned into one of six possible domes towards a direction along an axis.
Torus: A donut-like shape with configurable radius and thickness that can be around any of the three axes.
Full usage guide
Show
The Build Guide GUI
The Build Guide GUI can be accessed using a keybind. By default, this keybind will be 'B', but, as any keybind, it can be changed via Minecraft's settings (with the GUI closed, Escape-> Options -> Controls for Minecraft 1.17 and lower, Escape -> Options -> Controls -> Key Binds for Minecraft 1.18 and higher). In this sub-GUI, you can only handle one shape at a time. The GUI is divided into four sub-GUIs, accessible through their four buttons at the top: 'Shape', 'Visualization', 'Shape list', and 'Configuration'. On the top-left, there is a global 'Enable' checkbox which toggles the rendering of shapes.There also exists a keybind, unbound by default, called 'Toggled enabled' as an alternative to the 'Enable' checkbox. The total number of blocks for the selected shape and for all shapes in total can be found at the top. The first line is the exact number of blocks. The second line shows this amount in the number of stacks plus a remainder. The 'X' button on the top-right will close the GUI, just like pressing Escape will.
The Shape sub-GUI
The Shape sub-GUI is divided into three sections: 'Shape', 'Origin', and 'Shape properties'.
Shape
The 'Shape' section determines which shape is shown. Initially, this will be the first shape the mod knows about, which should be a circle. Pressing the arrow buttons left and right of the name of the current shape will cycle between the available shapes.
Origin
So far, you should have a random shape that is being rendered (if you've pressed the 'Enable' checkbox). You will very likely want to move that shape around, which is what this section of the sub-GUI is all about. Assuming you haven't touched the Visualization GUI yet, you should see two kinds of blocks rendered; a lot of white blocks, which trace the shape and one small red block, which is called the 'origin' of the shape. This origin is what the shape is based on and is usually something like the centre of a circle or the start of a line. The initial origin will be the location you were in when you first opened the GUI. The buttons in the 'Origin' section all change the location of the origin and the blocks that trace the shape will move along with it. The first button, 'Set origin', will simply move the origin to your feet. The other three lines allow for finer control of each of the three components of the position (X, Y and Z). The '-' and '+' buttons will decrement and increment the relevant component, respectively. An exact value can be typed into the black text box. Clicking the 'Set' button will try to set the component to the value in the text box. If this value is not a valid whole number, the component will not be updated and the text will turn red. Trying a valid number will turn it white again. Additionally, there exists a keybind, unbound by default, that acts like the 'Set origin' button, and has the same name.
Shape properties
Finally, the 'Shape properties' contains the parameters of the shape; length, radius, orientation, etc. Parameters for each shape and descriptions of parameters can be found in the 'Shapes' section further on in this usage guide. When cycling between shapes, their parameters will be preserved.
The Visualization sub-GUI
The Visualization sub-GUI can be opened by pressing the 'Visualization' button. The Visualization sub-GUI mostly contains two sets of four sliders and two buttons. The left set controls the colour of the blocks that trace the shape and the right set controls the colour of the small origin block. Each of the four slides controls one of the colour components of its respective type of block: Red, Green, Blue and Alpha. The latter of those, Alpha, is the transparency of the blocks. After the sliders are at the desired positions, the colour can be applied by pressing 'Set'. Pressing 'Default' will return the colours to the default of white for the shape tracing blocks and red for the origin block. The 'Depth test' checkbox at the bottoms determines whether depth testing will be used during rendering, which is the technical term for "only draw this if there is not something between it and the camera". In other words, unchecking 'Depth test' will allow you to see the shape tracing blocks and the origin block through the world. This cannot be used as a form of x-ray or another kind of cheat, as the mod does not interact with the world in any way.
The Shape List sub-GUI
Pressing the 'Shape list' button it will take you to the Shape List sub-GUI. Like the Shape sub-GUI, the Shape List sub-GUI is divided into four sections: 'Add new shape', 'Selected shape', 'Global origin' and 'Shapes'.
Add new shape
In this section, you'll be able to cycle between shapes again. Cycling to the desired shape and pressing the 'Add' button below it will add the shape to the list under the 'Shapes' section. The origin for the newly added shape will be at your feet. You can freely cycle and add other shapes without affecting the ones you've added before.
Selected shape
Disabling the 'Visible' checkbox will hide the selected shape, indicated by it now being crossed out in the shape list. Pressing the 'Delete' button will delete the shape from the shape list.
Global origin
This section works similarly to the normal 'Origin' section in the Shape sub-GUI. Using the buttons and text fields will set the origin of the currently selected shape. However, the origins of all the other shapes will also change such that the shapes will maintain the same relative positions. Also like the normal origin handling, the 'Set global origin' button has a keybind alternative under the same name, which is unbound by default.
Shapes
The list under the 'Shapes' section lists the currently active shapes. Clicking on one of the shapes in the list will select it, indicated by the black box around it. If too many shapes are added to fit on the screen, a scrollbar will appear on the right of the list. Either dragging the scrollbar or using the scrollwheel on your mouse will scroll the list. Setting a colour in the Visualization GUI will also only affect the currently selected shape. However, at the moment, the depth test checkbox is still a global setting, meaning that it affects all the shapes, not just the selected one. This behaviour will likely change in the future to be more in line with the rest of the visualization stuff. If you have deleted all shapes from the list, a lot of buttons across most of the sub-GUIs will be disabled, as there will not be any shape to act upon. Adding a shape will enable them again.
The Configuration sub-GUI
Pressing the 'Configuration' button will open the Configuration sub-GUI. This sub-GUI offers a direct and instantaneous interface to the configuration file (see the Configuration section at the end of the mod description). Changing values won't require a restart to take effect.
Shapes
Most shapes can only be odd size by default because the origin is centered on one block (for example, this way, circles can only be 3x3, 5x5, 7x7, etc.). Shapes like these have all have an 'Even mode' checkbox to shift the origin half a block in relevant directions (from the previous example, circles can now only be 4x4, 6x6, 8x8, etc.). Some parameters also allow negative values, which can flip a shape towards a negative axis, for example.
Catenary
A catenary, also known as a chain line or a rope line, which is the shape of a rope hanging between two points. The two points the catenary is based on are the origin and the point relative to the origin described by the parameters 'Delta X', 'Delta Y' and 'Delta Z'. This second point can also be set using the 'Set endpoint' button, which places this position at your feet. The arc length of the catenary (the length of the rope) is defined by the distance between the two points plus the value given in 'Additional distance', which has to be 1 or more.
Circle
A simple circle. The 'Direction' property determines which axis the circle goes around. For example, when set to 'X', the circle will extend into the Y and Z directions. 'Radius' will set the radius of the circle and can be any positive whole number. Increasing 'Depth' will create a cylindrical tube in the direction given by 'Direction'.
Cone
A cone. The 'Direction' property determines which axis the cone points at. 'Radius' will set the radius of the cone and can be any positive whole number. 'Height' sets the height of the cone and can be negative.
Cuboid
A cuboid is a hollow cube-like shape where the length of each side is given by the parameters 'X', 'Y' and 'Z', which all have to be positive whole numbers. The 'Walls' parameter shows the walls which are currently active, where, for example, the presence of 'X' means that the walls towards the negative X direction and the positive X direction are enabled, and similarly for 'Y' and 'Z'. '-' means that no walls are enabled and the cuboid is only a wireframe. You can choose whether the origin is the corner or the centre of the cuboid.
Ellipse
An ellipse is very similar to a circle. The only difference is that, instead of a radius, it uses two semi-axes. These semi-axes work similar to a radius, but, if you consider a radius working in two directions, these semi-axes only work in one direction, which is the one shown in the parameter's name.
Ellipsoid
An ellipsoid is to a sphere like an ellipse is to a circle. It's only difference with the sphere is that it now has three semi-axes instead of a radius. Like a sphere, it also has dome modes.
Grid
A grid of blocks. The number of blocks and the step size between the blocks can be changes for each direction.
Line
A simple line. The two points the line is based on are the origin and the point relative to the origin described by the parameters 'Delta X', 'Delta Y' and 'Delta Z'. This second point can also be set using the 'Set endpoint' button, which places this position at your feet.
Parabola
A parabola. Its shape is described by the parameters 'Half-width' and 'Height', such that the point (Half-width,Height) is part of the parabola. 'Direction' and 'Rotation' allow the parabola to face a certain direction and be rotated by a given amount. 'Depth' will add layers towards the 'Direction' and can be negative.
Paraboloid
A paraboloid. It works similarly to the parabola, but now has two half-widths in the directions given by the parameter names. Rotation is now only given by the 'Direction' parameter.
Polygon
A polygon is a regular shape with a given number of sides. This number of sides is given by the 'Sides' parameter; 3 gives a triangle, 4 gives a square, 5 gives a pentagon, etc. The 'Sides' parameter has to be a whole number of 3 or higher. 'Radius' is a bit of a loose interpretation of a radius, and is the distance between the origin and one of the sides. 'Radius'' has to be a positive whole number. 'Direction' works like it does with a circle in that it determines which axis the polygon goes around. 'Rotation' is a multiple of 90° that the polygon will be rotated. Finally, 'Depth' works like with a circle again.
Polygonal pyramid
A pyramid with the base of a polygon. It works identical to the normal polygon, but instead of 'Depth', it has 'Height' for the height of the pyramid.
Sphere
A sphere with a radius given by 'Radius', which is a positive whole number. 'Dome' sets the dome mode of the sphere: '-' means disabled, and any other option will only show only one hemisphere of the sphere in the direction it describes.
Torus
Also known as a donut. Like a circle, the 'Direction' parameter determines which axis it goes around. If you imagine the torus as a tube around a ring, then 'Outer radius' is the radius of the ring and 'Inner radius' is the radius of the tube. Both of them need to be positive whole numbers and 'Outer radius' must always be larger than or equal to 'Inner radius'. If 'Outer radius' is set to be smaller than 'Inner radius' or 'Inner radius' is set to be larger than 'Outer radius', the other parameter will be set to the same value.
Moving inbetween worlds, servers and dimensions
Planning out shapes is usually done in a very specific environment; shapes in your singleplayer world may not sense on your favourite server or another world, and the building you've planned in the Overworld is completely useless in the End where it floats in the void 500 blocks away from you. The latest version of the mod will therefore have a different state for each unique combination of world/server IP and dimension. As of writing, there is no way to transfer these a state to another world/server/dimension anyway, but a future version of the mod will implement toggling of this behaviour and moving/copying state around. By default, shapes and states are lost inbetween client restarts. Enabling the config option persistenceEnabled allows the mod to save shapes and states to files, and restore them when the client restarts. Due to technical limitations, restoring a state will begin when you open the GUI.
Minimum requirements
Versions denoted as, for example, 1.21/1.21.1 are built on 1.21, but should work on 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.8.
Forge 1.20.6: Minecraft Forge 50.2.9.
Forge 1.21/1.21.1: Minecraft Forge 51.0.33.
Forge 1.21.3: Minecraft Forge 53.1.11.
Forge 1.21.4: Minecraft Forge 54.1.17.
Forge 1.21.5: Minecraft Forge 55.1.11.
Forge 1.21.8: Minecraft Forge 58.1.19.
Forge 1.21.10: Minecraft Forge 60.1.11.
Forge 1.21.11: Minecraft Forge 61.1.19.
Forge 26.1.2: Minecraft Forge 64.0.11.
Forge 26.2: Minecraft Forge 65.0.4.
Forge 26.3: Minecraft Forge 66.0.9.
Fabric 1.20/1.20.1: Fabric Loader 0.19.3 and Fabric API 0.83.0.
Fabric 1.20.2/1.20.3: Fabric Loader 0.19.3 and Fabric API 0.91.6.
Fabric 1.20.4/1.20.5: Fabric Loader 0.19.3 and Fabric API 0.97.3.
Fabric 1.20.6: Fabric Loader 0.19.3 and Fabric API 0.100.8.
Fabric 1.21/1.21.1: Fabric Loader 0.19.3 and Fabric API 0.102.0.
Fabric 1.21.3: Fabric Loader 0.19.3 and Fabric API 0.114.1.
Fabric 1.21.4: Fabric Loader 0.19.3 and Fabric API 0.119.4.
Fabric 1.21.5: Fabric Loader 0.19.3 and Fabric API 0.128.2.
Fabric 1.21.8: Fabric Loader 0.19.3 and Fabric API 0.136.1.
Fabric 1.21.10: Fabric Loader 0.19.3 and Fabric API 0.138.4.
Fabric 1.21.11: Fabric Loader 0.19.3 and Fabric API 0.141.4.
Fabric 26.1.2: Fabric Loader 0.19.3 and Fabric API 0.154.2.
Fabric 26.2: Fabric Loader 0.19.3 and Fabric API 0.154.2.
Fabric 26.3: Fabric Loader 0.19.5 and Fabric API 0.161.0.
NeoForge 1.21/1.21.1: NeoForge 21.0.167.
NeoForge 1.21.3: NeoForge 21.3.96.
NeoForge 1.21.4: NeoForge 21.4.157.
NeoForge 1.21.5: NeoForge 21.5.97.
NeoForge 1.21.8: NeoForge 21.8.53.
NeoForge 1.21.10: NeoForge 21.10.64.
NeoForge 1.21.11: NeoForge 21.11.42.
NeoForge 26.1.2: NeoForge 26.1.2.80.
NeoForge 26.2: NeoForge 26.2.0.18-beta.
NeoForge 26.3: NeoForge 26.3.0.45-beta.
Compatibility
Compatibility with shaders through Optifine is not guaranteed. Shaders in Optifine are know to break the projections due to an issue that appears to be on Optifine's end. Non-shader features in Optifine appear to work perfectly fine.
The mod should be explicitly compatible with Iris starting from Minecraft 1.21.5, even with shaders enabled.
The mod is designed to run solely on the client. Installing the mod on a server is discouraged, but attempts have been made to prevent servers from crashing immediately and clients shouldn't be denied access for not having (the correct version of) the mod installed, though this server-side behaviour is neither supported nor guaranteed.
Configuration
The configuration file can be found in a folder called config in your game directory, and is called buildguide.cfg. The Configuration sub-GUI can also be used to edit it. The following options can be configured:
debugGenerationTimingsEnabled (default: false)
A debug option to print the time it takes to generate a shape to the logs.
asyncEnabled (default: true)
When this option is enabled, shapes will be generated asynchronously, meaning that the shapes will be put together in the background without having to block your client. Having this option enabled can cause shape projections to flash a bit, so if you're sensitive to flashing images, especially if you feel discomfort while using the mod, consider disabling this option. This issue should be addressed at some point.
shapeListRandomColorsDefaultEnabled (default: false)
If this option is enabled, adding new shapes to the Shape List sub-GUI will randomly generate their colours instead of using the default white and red.
persistenceEnabled (default: false)
Experimental option that is disabled by default due to some weird issues on Forge. When this option is enabled, shapes and states will be saved to a file, which will allow the mod to restore shapes when the client is restarted.
Modpacks
Feel free to add it to a modpack!
评论 0
登录后参与评分
还没有评论,来抢沙发吧