From 0afa4d54c6241275bc9647f01a3bdd55e637cffe Mon Sep 17 00:00:00 2001 From: WILLATRONIX Date: Sat, 25 May 2024 16:15:08 +0100 Subject: [PATCH 01/19] fix links in configuration --- src/advanced/configuration.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/advanced/configuration.md b/src/advanced/configuration.md index 57abecd..539e61c 100644 --- a/src/advanced/configuration.md +++ b/src/advanced/configuration.md @@ -2,7 +2,7 @@ Axiom has its own dedicated configuration located in `.minecraft/config/axiom` containing 3 folders and 3 files. -The folders are used to store saved [Blueprints](editor/blueprints.md), [Heightmaps](editor/tools/heightmap/elevation.md) and [Tool Presets](editor/toolpresets.md) so even if the mod is removed, your assets are saved. +The folders are used to store saved [Blueprints](/editor/blueprints.md), [Heightmaps](/editor/tools/heightmap/elevation.md) and [Tool Presets](/editor/toolpresets.md) so even if the mod is removed, your assets are saved. The files contain the more important information such as UI layout and enabled capabilities. Axiom uses a variant of JSON called HOCON (Human-Optimized Config Object Notation). @@ -30,10 +30,10 @@ Below are the three files alongside their descriptions. | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | blockAttributes | Contains the currently toggled block attributes. | | blueprint | Stores the toggle to automatically refresh and a list of all used blueprint tags. | -| capabilities | Lists all abilities and their state. Also contains the `autoSwapToCreative` boolean that controls switching to creative when opening the [context menu](builder/contextmenu.md). | +| capabilities | Lists all abilities and their state. Also contains the `autoSwapToCreative` boolean that controls switching to creative when opening the [context menu](/builder/contextmenu.md). | | keybinds | Stores in-game keybinds and settings for the Builder Mode and camera movement. | | toolKeybinds | Stores all Editor keybinds for switching tools. | -| rendering | Stores booleans representing the toggles in the Toolbox found in the [Context Menu](builder/contextmenu.md). | +| rendering | Stores booleans representing the toggles in the Toolbox found in the [Context Menu](/builder/contextmenu.md). | ### `imgui.ini` From 24a9bda91e0d416d31966f38a618d2bea7cc5892 Mon Sep 17 00:00:00 2001 From: WILLATRONIX Date: Sat, 25 May 2024 16:28:29 +0100 Subject: [PATCH 02/19] fix all broken links and removed notice beta ver --- src/builder/intro.md | 18 +++++++++--------- src/capabilities/intro.md | 4 ++-- src/tools/drawing/text.md | 2 -- src/tools/painting/scriptbrush.md | 4 +--- 4 files changed, 12 insertions(+), 16 deletions(-) diff --git a/src/builder/intro.md b/src/builder/intro.md index 238616b..0bfafc1 100644 --- a/src/builder/intro.md +++ b/src/builder/intro.md @@ -3,24 +3,24 @@ The Builder Mode is an enhancement of the vanilla Creative mode. It adds several ## Builder Context Menu -Many features for builder mode can be toggled or accessed through the Context Menu. The menu can be opened by holding down Left Alt. See [Context Menu](builder/contextmenu.md) for more information. +Many features for builder mode can be toggled or accessed through the Context Menu. The menu can be opened by holding down Left Alt. See [Context Menu](/builder/contextmenu.md) for more information. ![Builder Context Menu](/img/AltMenuOverview.png) ## Builder Tools -To the right of the hotbar, you can find the Builder Tools. These tools are very simple and are intended to ease structural/small scale building where use of the more powerful [Editor Mode](editor/intro.md) is too unwieldly. +To the right of the hotbar, you can find the Builder Tools. These tools are very simple and are intended to ease structural/small scale building where use of the more powerful [Editor Mode](/editor/intro.md) is too unwieldly. To start using a Builder Tool, scroll to the 10th slot or press 0. To switch to a different Builder Tool, hold Left Alt and then scroll. The tools that are currently available in this section are: -- [Move](builder/move.md) -- [Clone](builder/clone.md) -- [Stack](builder/stack.md) -- [Smear](builder/smear.md) -- [Extrude](builder/extrude.md) -- [Erase](builder/erase.md) -- [Setup Symmetry](builder/setupsymmetry.md) +- [Move](/builder/move.md) +- [Clone](/builder/clone.md) +- [Stack](/builder/stack.md) +- [Smear](/builder/smear.md) +- [Extrude](/builder/extrude.md) +- [Erase](/builder/erase.md) +- [Setup Symmetry](/builder/setupsymmetry.md) ![Builder Tools](/img/BuilderToolsOverview.png) diff --git a/src/capabilities/intro.md b/src/capabilities/intro.md index e9d5394..90cc275 100644 --- a/src/capabilities/intro.md +++ b/src/capabilities/intro.md @@ -12,6 +12,6 @@ The Capabilities that are currently available are: - Angel Placement (place blocks mid-air) - No Clip (move through blocks while flying) -Capabilities can be toggled using the left side of the [Context Menu](builder/contextmenu.md) +Capabilities can be toggled using the left side of the [Context Menu](/builder/contextmenu.md) -Additionally, keybinds can be associated with capabilities to quickly toggle them. By default, only the [Replace Mode](capabilities/replacemode.md) has a keybind (R), but more can be added in the vanilla controls menu (Esc > Options > Controls) +Additionally, keybinds can be associated with capabilities to quickly toggle them. By default, only the [Replace Mode](/capabilities/replacemode.md) has a keybind (R), but more can be added in the vanilla controls menu (Esc > Options > Controls) diff --git a/src/tools/drawing/text.md b/src/tools/drawing/text.md index a122369..c730a06 100644 --- a/src/tools/drawing/text.md +++ b/src/tools/drawing/text.md @@ -3,5 +3,3 @@ The **Text** tool lets the user write text with any True Type Font or .ttf file font in the world. It can be configured to have a smaller or larger font scale Just write the text desired into the ‘Text’ field and right-click to place it in the world with a gizmo. - -> Note: As of Axiom-b0.97, the text tool is unfinished and provided for demonstration purposes only. Thank you for your understanding diff --git a/src/tools/painting/scriptbrush.md b/src/tools/painting/scriptbrush.md index b31975e..b72554a 100644 --- a/src/tools/painting/scriptbrush.md +++ b/src/tools/painting/scriptbrush.md @@ -12,12 +12,10 @@ Although intimidating at first, once you understand the basic concept of program - An IDE[^note1] window is used to input your code. It uses a similar language to Python called Lua[^note2]. -> [!TIP] > Lua doesn't require line indentation like most languages but Axiom provides a tabbing feature to indent. > > There is only one built-in library[^note3] and there are currently no others. - -> [!IMPORTANT] +> > The Script must return a block or use setBlock() to modify blocks in the world. There are many predefined variables and functions that can be used throughout the script to interact with the world. Listed below, are all variables and functions with descriptions and examples. From 0558ca7774b8cd52e449ab851e063771eb372401 Mon Sep 17 00:00:00 2001 From: WILLATRONIX Date: Sat, 25 May 2024 23:12:25 +0100 Subject: [PATCH 03/19] added displayentities and removed clentaminator --- src/SUMMARY.md | 2 +- src/builder/displayentities.md | 93 +++++++++++++++++++++++++++++++ src/editor/toolpresets.md | 2 +- src/tools/painting/scriptbrush.md | 13 ++--- 4 files changed, 100 insertions(+), 10 deletions(-) create mode 100644 src/builder/displayentities.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index c967010..baa0b22 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -11,6 +11,7 @@ - [Extrude](builder/extrude.md) - [Erase](builder/erase.md) - [Setup Symmetry](builder/setupsymmetry.md) + - [Display Entities](builder/displayentities.md) - [Capabilities](capabilities/intro.md) - [Tinker](capabilities/tinker.md) - [No Updates](capabilities/noupdates.md) @@ -39,7 +40,6 @@ - [Painter](tools/painting/painter.md) - [Noise Painter](tools/painting/noisepainter.md) - [Biome Painter](tools/painting/biomepainter.md) - - [Clentaminator](tools/painting/clentaminator.md) - [Gradient Painter](tools/painting/gradientpainter.md) - [Script Brush](tools/painting/scriptbrush.md) - [Drawing Tools](tools/drawing/intro.md) diff --git a/src/builder/displayentities.md b/src/builder/displayentities.md new file mode 100644 index 0000000..336fd4d --- /dev/null +++ b/src/builder/displayentities.md @@ -0,0 +1,93 @@ +# Display Entities + +**Display Entities** were added to Minecraft in 1.19.4[^note1], introducing the ability to display blocks, items and text in the form of entities. This means you can essentially create structures at any scale. However, they are hard to use, especially for players inexperienced with commands. + +Axiom takes advantage of this difficulty and has a feature for precise display entity editing. + +In the [Context Menu](contextmenu.md), the "Create Display Entity" button will open a menu similar to the creative inventory. Use the tabs to switch between item, block and text displays. + +The tables below cover the settings for the **Create Display** Entity menu. + +## Item Display + +| Setting | Description | +| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Item | This represents the item that will be displayed. Clicking the icon will display all items in a grid. The CustomModelData filter only displays custom blocks. | +| Item Display | This setting is similar to Blockbench's display options[^note2]. This determines how the item will be displayed. | +| Additional Settings | Refer to [Additional Settings](displayentities.md#additional-settings). | + +## Block Display + +| Setting | Description | +| ------------------- | ------------------------------------------------------------------------------------------------------------ | +| Block | This represents the block that will be displayed. Clicking the stone icon will display all blocks in a grid. | +| Additional Settings | Refer to [Additional Settings](displayentities.md#additional-settings). | + +## Text Display + +| Setting | Description | +| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Text | The black box provides space to enter text for the text display. | +| Background Color | The background colour determines the colour surrounding the text. The first two hexadecimal values represent the opacity while the rest represent the colour. | +| Line Width | The line width determines the amount of space required to start a new line. | +| Alignment | The alignment determines the offset relative to the gizmo. | +| Shadow | Adds a shadow effect to the text. | +| Additional Settings | Refer to [Additional Settings](displayentities.md#additional-settings) | + +## Additional Settings + +The **Additional Settings** submenu provides further options for the display entity. However, these are much more advanced and are generally used for mapmaking. + +> After pressing "done", the display entity will be spawned at the player position with the selected settings. + +## Display Entity Manipulation + +When the white box at the centre of the display entity is selected, a [Gizmo](/editor/gizmos.md) will appear. Clicking the white box with left-click will select it. + +The gizmo allows movement, rotation and resizing in all directions. To move display entities with the gizmo, use left-click and drag one of the three arrows in a direction. Rotation is almost the same, click and drag the outer rings in any direction to rotate the display entity. To resize the display entity, drag one of the outer cubes in any direction. + +The three flat squares within the gizmo lock the movement to a 2D plane. Dragging one of these squares will move the display entity along the 2D plane. + +The central, white cube can be used to move the display entity in all three dimensions. + +## Keybinds + +There are many key combinations that can be used while moving, rotating or resizing display entities. Listed below are all key combinations alongside their description. + +| Key | Description | +| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Right Click | Moves the Display Entity to the block you're facing. However, while looking at the white cube on the gizmo, it opens the [Editing Menu](displayentities.md#editing-menu) for the selected display entity. | +| Scroll | Nudges the display by the default step size[^note3]. | +| Control | Used alongside Left Click to increase the step size. The movement step is changed to 1 block, the rotation step is set to 15 degrees and the scale is set to affect all axes rather than one. | +| Shift | Lowers the step size for movement and scale to 0.0001 blocks and sets the rotation step size to 1 degree. | +| Control + C | Copies the display entity to the clipboard. This can be pasted using `Control + V`. | +| Delete / Backspace | Deletes the selected Display Entity. | +| Control + Z | Undo the previous edit. | +| Control + Y | Redo the undone edit. | + +## Editing Menu + +The **Editing Menu** has many useful features. Listed below are all features with a description. + +| Modifier | Description | +| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Edit Properties | Opens the original menu to set the display entity properties. | +| Edit Transformation | Opens a menu to manually enter precise translation, rotation and scale. | +| Reset Translation | Resets the offset set in the Edit Transformation menu. | +| Reset Rotation | Resets the rotation to 0 on all angles. | +| Reset Scale | Resets all scale values to 1. | +| Gizmo Mode | Switches between [local](/editor/gizmos.md) and [global gizmos](/editor/gizmos.md). | +| Duplicate | Duplicates the Display Entity in the same position. | +| Grouping | Pressing this button will reveal the grouping settings. Changing the range slider will affect the area of grouping. The "Group with nearby in range" will group all Display Entities within the provided range. The "Ungroup children" button ungroups all display entities that have previously been grouped. | +| Remove | Deletes the Display Entity. | +| Copy Summon Command | Copies the display entity to the clipboard. This can be pasted using `Control + V`. | +| Copy Coordinates | Copies the exact coordinates to the clipboard. | +| Copy Transform Command | Copies the transformation to the clipboard as a command. | + +## References + +[^note1]: [Display Entities](https://minecraft.wiki/w/Display) are a vanilla Minecraft feature. + +[^note2]: Blockbench uses [display settings](https://mcreator.net/wiki/blockbench-blockitem-display-settings) for different perspecives of a model. + +[^note3]: The default step size is 1/16th of a block (0.0625). \ No newline at end of file diff --git a/src/editor/toolpresets.md b/src/editor/toolpresets.md index f74a728..c31f264 100644 --- a/src/editor/toolpresets.md +++ b/src/editor/toolpresets.md @@ -1,6 +1,6 @@ ## Tool Presets -Tool Presets allow for easy saving and loading of tool settings and configurations. Tool presets are saved in the axiom configuration at `.minecraft/config/axiom/tool_presets` in NBT format. +Tool Presets allow for easy saving and loading of tool settings and configurations. Tool presets are saved in the axiom [configuration](/advanced/configuration.md) at `.minecraft/config/axiom/tool_presets` in NBT format. ## Saving Presets diff --git a/src/tools/painting/scriptbrush.md b/src/tools/painting/scriptbrush.md index b72554a..3e7ca51 100644 --- a/src/tools/painting/scriptbrush.md +++ b/src/tools/painting/scriptbrush.md @@ -12,10 +12,10 @@ Although intimidating at first, once you understand the basic concept of program - An IDE[^note1] window is used to input your code. It uses a similar language to Python called Lua[^note2]. -> Lua doesn't require line indentation like most languages but Axiom provides a tabbing feature to indent. -> -> There is only one built-in library[^note3] and there are currently no others. -> +- Lua doesn't require line indentation like most languages but Axiom provides a tabbing feature to indent. + +- There is only one built-in library[^note3] and there are currently no others. + > The Script must return a block or use setBlock() to modify blocks in the world. There are many predefined variables and functions that can be used throughout the script to interact with the world. Listed below, are all variables and functions with descriptions and examples. @@ -56,10 +56,7 @@ Template Variables are not shown in the help text. Template Variables are used t # Code Examples -These four code examples range from a novice user all the way to a professional in terms of difficulty. Each script provides a description and a breakdown of how the script works. - -> [!NOTE] -> Feel free to copy these and mess around with them. +These four code examples range from a novice user all the way to a professional in terms of difficulty. Each script provides a description and a breakdown of how the script works. Feel free to copy these and mess around with them. ### **Novice** From d27fcbc838c933df4a5d28a4015f308895b34a17 Mon Sep 17 00:00:00 2001 From: WILLATRONIX Date: Sun, 26 May 2024 18:42:38 +0100 Subject: [PATCH 04/19] update tinker, elevation | add windows folder --- src/SUMMARY.md | 13 ++--- src/advanced/configuration.md | 2 +- src/capabilities/tinker.md | 60 ++++++++++++--------- src/editor/{ => windows}/activeblock.md | 0 src/editor/{ => windows}/blueprints.md | 0 src/editor/{ => windows}/history.md | 0 src/editor/{ => windows}/targetinfo.md | 0 src/editor/{ => windows}/toolmasks.md | 0 src/editor/{ => windows}/worldproperties.md | 0 src/tools/heightmap/elevation.md | 14 +++-- src/tools/painting/scriptbrush.md | 2 +- 11 files changed, 54 insertions(+), 37 deletions(-) rename src/editor/{ => windows}/activeblock.md (100%) rename src/editor/{ => windows}/blueprints.md (100%) rename src/editor/{ => windows}/history.md (100%) rename src/editor/{ => windows}/targetinfo.md (100%) rename src/editor/{ => windows}/toolmasks.md (100%) rename src/editor/{ => windows}/worldproperties.md (100%) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index baa0b22..491c098 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -23,14 +23,15 @@ - [Clipboard and Placements](editor/clipboardandplacements.md) - [Selections](editor/selections.md) - [Gizmos](editor/gizmos.md) - - [Blueprints](editor/blueprints.md) - [Views](editor/views.md) - - [Tool Masks](editor/toolmasks.md) - - [Active Block](editor/activeblock.md) - - [Target Info](editor/targetinfo.md) - - [History](editor/history.md) - - [World Properties](editor/worldproperties.md) - [Tool Presets](editor/toolpresets.md) + - [Windows](editor/windows/intro.md) + - [Blueprints](editor/windows/blueprints.md) + - [Active Block](editor/windows/activeblock.md) + - [History](editor/windows/history.md) + - [Tool Masks](editor/windows/toolmasks.md) + - [Target Info](editor/windows/targetinfo.md) + - [World Properties](editor/windows/worldproperties.md) - [Tools](tools/intro.md) - [Selection Tools](tools/selection/intro.md) - [Box Select](tools/selection/boxselect.md) diff --git a/src/advanced/configuration.md b/src/advanced/configuration.md index 539e61c..fcec851 100644 --- a/src/advanced/configuration.md +++ b/src/advanced/configuration.md @@ -2,7 +2,7 @@ Axiom has its own dedicated configuration located in `.minecraft/config/axiom` containing 3 folders and 3 files. -The folders are used to store saved [Blueprints](/editor/blueprints.md), [Heightmaps](/editor/tools/heightmap/elevation.md) and [Tool Presets](/editor/toolpresets.md) so even if the mod is removed, your assets are saved. +The folders are used to store saved [Blueprints](/editor/windows/blueprints.md), [Heightmaps](/editor/tools/heightmap/elevation.md) and [Tool Presets](/editor/toolpresets.md) so even if the mod is removed, your assets are saved. The files contain the more important information such as UI layout and enabled capabilities. Axiom uses a variant of JSON called HOCON (Human-Optimized Config Object Notation). diff --git a/src/capabilities/tinker.md b/src/capabilities/tinker.md index 553d5a7..c8dda3e 100644 --- a/src/capabilities/tinker.md +++ b/src/capabilities/tinker.md @@ -6,33 +6,41 @@ Aiming at specific parts of a block can change the effect of the tinker. This le Tinker interactions can be negated while the capability is toggled on by either having a non-empty hand or by holding down the sneak or ‘shift’ button. -|Block |Tinker Effect | -|-------------------------------------|-------------------------------------------------------------| -|Blocks with full/stair/slab variants |Convert between full/stair/slab by adding/removing corners | -|Walls |Cycle WallSide (none/low/tall) of targeted side | -|Fences/Iron bars |Toggle north/east/south/west sides | -|Piston |[Side] Change facing, [Front] Extends/retracts the piston | -|Furnace |[Side] Change facing, [Front] Toggles lit state | -|Carved Pumpkin/Jack O Lantern |[Side] Change facing, [Front] Swaps between the 2 blocks | -|Barrel |[Side] Change facing, [Front] Opens/closes | -|Iron Trapdoor/Door |Open/closes the block | -|Brewing Stand |Add/remove bottles | -|Glazed Terracotta |Change facing | -|Farmland |Cycle moisture | -|Scaffolding |Toggle bottom | -|Small/Medium/Large/Cluster Amethyst |Cycles between the 4 blocks | -|Lectern |Toggles book | -|Candle/Campfire/Redstone Torch |Toggles lit | -|Cave Vines |Toggles berries | -|Bamboo Stalk |Toggles bamboo leaves | -|Cauldron |Cycles fluid level | -|Composter |Cycles compost level | -|Powered Rail |Toggles powered | -|Beehive |Cycles honey level | -|Any block with 'Age' property |Cycles age | -|Cake |Cycles bites | +| Block | Tinker Property Effect | +| ------------------------------------ | ---------------------------------------------------------- | +| Blocks with full/stair/slab variants | Convert between full/stair/slab by adding/removing corners | +| Walls | Cycle WallSide (none/low/tall) of targeted side | +| Fences/Iron bars/Chorus Plant | Toggle north/east/south/west sides | +| Piston | [Side] Change facing, [Front] Extends/retracts the piston | +| Furnace | [Side] Change facing, [Front] Toggles lit state | +| Carved Pumpkin/Jack O Lantern | [Side] Change facing, [Front] Swaps between the 2 blocks | +| Barrel | [Side] Change facing, [Front] Opens/closes | +| Iron Trapdoor/Door | Open/closes the block | +| Brewing Stand | Add/remove bottles | +| Glazed Terracotta | Change facing | +| Farmland | Cycle moisture | +| Scaffolding | Toggle bottom | +| Small/Medium/Large/Cluster Amethyst | Cycles between the 4 blocks | +| Lectern | Toggles book | +| Candle/Campfire/Redstone Torch | Toggles lit | +| Cave Vines | Toggles berries | +| Bamboo Stalk | Toggles bamboo leaves | +| Cauldron | Cycles fluid level | +| Composter | Cycles compost level | +| Beehive | Cycles honey level | +| Cake | Cycles bites | +| Lantern | Toggles hanging | +| Fence Gate | Toggles lowered and facing axis | +| Player Head | Cycles rotation | +| Banner | Cycles rotation | +| Attached Melon/Pumpkin Stem | Switches facing axis | +| Rails | Cycles rotation | +| Any block with 'Age' property | Cycles age | +| Any block with 'Powered' property | Toggles powered | + Additionally: - Right-clicking with Moss Block on cobblestone/stone converts the block into its mossy variant -- Right-clicking with Shears on removes mossy +- Right-clicking with Shears on removes the mossy variant - Right-clicking on a pot with a plant replaces the plant inside the pot +- Any block with a slab or stair variant can be tinkered \ No newline at end of file diff --git a/src/editor/activeblock.md b/src/editor/windows/activeblock.md similarity index 100% rename from src/editor/activeblock.md rename to src/editor/windows/activeblock.md diff --git a/src/editor/blueprints.md b/src/editor/windows/blueprints.md similarity index 100% rename from src/editor/blueprints.md rename to src/editor/windows/blueprints.md diff --git a/src/editor/history.md b/src/editor/windows/history.md similarity index 100% rename from src/editor/history.md rename to src/editor/windows/history.md diff --git a/src/editor/targetinfo.md b/src/editor/windows/targetinfo.md similarity index 100% rename from src/editor/targetinfo.md rename to src/editor/windows/targetinfo.md diff --git a/src/editor/toolmasks.md b/src/editor/windows/toolmasks.md similarity index 100% rename from src/editor/toolmasks.md rename to src/editor/windows/toolmasks.md diff --git a/src/editor/worldproperties.md b/src/editor/windows/worldproperties.md similarity index 100% rename from src/editor/worldproperties.md rename to src/editor/windows/worldproperties.md diff --git a/src/tools/heightmap/elevation.md b/src/tools/heightmap/elevation.md index 1cc20dd..1a8e701 100644 --- a/src/tools/heightmap/elevation.md +++ b/src/tools/heightmap/elevation.md @@ -1,7 +1,15 @@ # Elevation -The simplest heightmap tool is the **Elevation** tool. It is used to simply raise or lower an area within your selection one layer at a time. For the time being the brush options only let you configure a cylindrical shape from which the Radius and the Height of the brush can be configured. These are pretty self explanatory where the height setting affects the y range in which the blocks are affected and the radius is the size of the heightmap. +The **Elevation Tool** can raise and lower pre-existing terrain. Its main feature is the ability to add custom heightmaps. These modify the elevation depending on the brightness in the image provided. -The Sharpness setting lets you change the behaviour of the aforementioned curvature and falloff. Increasing the sharpness makes the edges sharper/more flat. +## Tool Options -Then there are the raise and lower modes. This affects whether the brush will add or remove blocks from the world. +| Option | Description | +| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Y Limit | This determines the height of the cylindrical shape to affect surfaces. | +| Mode | Determines how the terrain is affected. **Raise**, **Lower** and **Flatten** are some of the modes. | +| Smoothing | Determines how smooth the elevation will turn out. | +| Apply | This dropdown allows you to switch between a single application and a continuous application. | +| Rate / Amount | These determine how many blocks are applied at a time. | +| Falloff | The falloff determines how the elevation is applied around the center. | +| Load Heightmap | Similar to falloff, heightmaps allow for further modification to the elevation. Pressing "Load Heightmap" will open an explorer window prompting you to choose an image. When using a coloured image, the image will automatically be converted to black and white. | diff --git a/src/tools/painting/scriptbrush.md b/src/tools/painting/scriptbrush.md index 3e7ca51..a35ce81 100644 --- a/src/tools/painting/scriptbrush.md +++ b/src/tools/painting/scriptbrush.md @@ -8,7 +8,7 @@ Although intimidating at first, once you understand the basic concept of program - The Script Brush is a powerful, yet advanced tool so some knowledge of programming languages similar to Python is recommended. -- The Script Brush is similar to [Mask Scripting](/editor/toolmasks.md). +- The Script Brush is similar to [Mask Scripting](/editor/windows/toolmasks.md). - An IDE[^note1] window is used to input your code. It uses a similar language to Python called Lua[^note2]. From b5276df0baaefda6195e0de6d1f0bd9460b9aa2f Mon Sep 17 00:00:00 2001 From: WILLATRONIX Date: Mon, 27 May 2024 00:22:21 +0100 Subject: [PATCH 05/19] Add palette, tooloptions | add cross refs --- src/SUMMARY.md | 4 +++- src/advanced/configuration.md | 28 +++++++++++++++------------- src/editor/mainmenubar.md | 20 ++++++++++---------- src/editor/windows/intro.md | 27 +++++++++++++++++++++++++++ src/editor/windows/palette.md | 19 +++++++++++++++++++ src/editor/windows/tooloptions.md | 3 +++ src/editor/{ => windows}/views.md | 0 7 files changed, 77 insertions(+), 24 deletions(-) create mode 100644 src/editor/windows/intro.md create mode 100644 src/editor/windows/palette.md create mode 100644 src/editor/windows/tooloptions.md rename src/editor/{ => windows}/views.md (100%) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 491c098..cc12519 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -23,15 +23,17 @@ - [Clipboard and Placements](editor/clipboardandplacements.md) - [Selections](editor/selections.md) - [Gizmos](editor/gizmos.md) - - [Views](editor/views.md) - [Tool Presets](editor/toolpresets.md) - [Windows](editor/windows/intro.md) + - [Views](editor/windows/views.md) - [Blueprints](editor/windows/blueprints.md) - [Active Block](editor/windows/activeblock.md) - [History](editor/windows/history.md) - [Tool Masks](editor/windows/toolmasks.md) - [Target Info](editor/windows/targetinfo.md) - [World Properties](editor/windows/worldproperties.md) + - [Palette](editor/windows/palette.md) + - [Tool Options](editor/windows/tooloptions.md) - [Tools](tools/intro.md) - [Selection Tools](tools/selection/intro.md) - [Box Select](tools/selection/boxselect.md) diff --git a/src/advanced/configuration.md b/src/advanced/configuration.md index fcec851..90c7636 100644 --- a/src/advanced/configuration.md +++ b/src/advanced/configuration.md @@ -10,19 +10,19 @@ Below are the three files alongside their descriptions. ### `.axiominternal.hocon` -| Key | Description | -| ------------------------------ | --------------------------------------------------------------------- | -| completedTutorials | Lists the tools that have shown their short tutorial. | -| customDowngradeSuggestions | Lists the downgrades suggested by Axiom. | -| globalScale | A float representing the [Editor](editor/intro.md) UI Scale. | -| lastTranslationCount | A value determining the amount of translations. | -| openEditorWindowTypes | A list of open windows in the editor. | -| rootEditorPalette | The default block palette for the editor mode. | -| savedCustomTheme | Stores the currently active theme as a string. | -| showCloseWindowButton | A boolean to toggle the "x" to close windows. | -| showNon90DegreeRotationWarning | A boolean to toggle the warning before applying non-90-degree angles. | -| showToolMaskOpenWarning | A boolean to toggle the warning when using tool masks. | -| shownIntroduction | A boolean representing whether the introduction has been completed. | +| Key | Description | +| ------------------------------ | --------------------------------------------------------------------------------- | +| completedTutorials | Lists the tools that have shown their short tutorial. | +| customDowngradeSuggestions | Lists the downgrades suggested by Axiom. | +| globalScale | A float representing the [Editor](editor/intro.md) UI Scale. | +| lastTranslationCount | A value determining the amount of translations. | +| openEditorWindowTypes | A list of open windows in the editor. | +| rootEditorPalette | The default block palette for the editor mode. | +| savedCustomTheme | Stores the currently active [Theme](/editor/windows/intro.md#Themes) as a string. | +| showCloseWindowButton | A boolean to toggle the "x" to close windows. | +| showNon90DegreeRotationWarning | A boolean to toggle the warning before applying non-90-degree angles. | +| showToolMaskOpenWarning | A boolean to toggle the warning when using tool masks. | +| shownIntroduction | A boolean representing whether the introduction has been completed. | ### `.axiom.hocon` @@ -38,4 +38,6 @@ Below are the three files alongside their descriptions. ### `imgui.ini` +This file stores [windows](/editor/windows/intro.md) and their positions. + This file is generally not meant to be modified, hence why it uses a different file format. However, if you're having an issue with a specific window that you can't recover, you can either edit or delete this file to fix the issue. \ No newline at end of file diff --git a/src/editor/mainmenubar.md b/src/editor/mainmenubar.md index 0145040..9ff4cb6 100644 --- a/src/editor/mainmenubar.md +++ b/src/editor/mainmenubar.md @@ -3,14 +3,14 @@ The main menu bar gives users access to crucial functionality of the mod. Here y ## File -| Function | Description | -|----------|------------------------------| -| Import Schematic | Imports schematic files to your clipboard | -| Export Schematic | Exports a selection as a schematic file | -| Open Reference Image | Adds a window with an image of your choice | -| Load Bedrock Packs | Allows you to import Bedrock Edition textures or models. | -| Save Selection as CSV | Exports a selection to a CSV[^note1] format. | -| Save Clipboard as JSON Model | This allows you to take blocks and convert them to an item model. Models can be used in resource packs or imported into Blockbench. | +| Function | Description | +| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | +| Import Schematic | Imports schematic files to your clipboard | +| Export Schematic | Exports clipboard as a schematic file | +| Open Reference Image | Adds a window with an image of your choice | +| Load Bedrock Packs | Allows you to import Bedrock Edition textures or models. (Requires [Commercial License](https://axiom.moulberry.com/commercial)) | +| Save Selection as CSV | Exports a selection to a CSV[^note1] format. | +| Save Clipboard as JSON Model | This allows you to take blocks and convert them to an item model. Models can be used in resource packs or imported into Blockbench. | ## Edit @@ -77,7 +77,7 @@ Clear and open the tool mask editing window. See [Tool Masks](toolmasks.md) ## Window -The **Windows** submenu lets the user toggle the visibility of important windows. If you ever close a window and want it back, this submenu allows you to reenable it. +The **Windows** submenu lets the user toggle the visibility of [Windows](windows/intro.md). If you ever close a window and want it back, this submenu allows you to reenable it. ## Keybinds @@ -87,7 +87,7 @@ The **Keybinds** button opens a window to edit and set keybinds for tools and op The **Help** submenu contains useful information and configuration options. -The dropdown contains links to information and resources. The style editor can be accessed through this window, allowing you to change and import custom colours for the UI. +The dropdown contains links to information and resources. The [style editor](windows/themes.md) can be accessed through this window, allowing you to change and import custom colours for the UI. ## References [^note1]: comma-separated values (CSV) is a plaintext format that uses commas to separate values in a table-like manner. diff --git a/src/editor/windows/intro.md b/src/editor/windows/intro.md new file mode 100644 index 0000000..f156d74 --- /dev/null +++ b/src/editor/windows/intro.md @@ -0,0 +1,27 @@ +# Windows + +**Windows** are the main part of the Editor Mode. Allowing for any layout, **Windows** are extremely versatile and customisable. + +All **Windows** are built around the main [view](views.md) as it's the only window that cannot be removed. + +### Opening New Windows + +To open a closed window, use the [Main Menu Bar](/editor/mainmenubar.md) and find the `Windows` category. In there, you will find a list of each Window and its toggle. + +When enabling a window, it will appear in the centre of the screen as slightly transparent. This is due to the window being undocked. + +## Window Layouts + +Windows can be laid out in multiple ways on the screen. To adjust a window's position, simply drag the topmost part of the window and drag it to where you would like it to be. + +> Tip: Undocked windows can be minimised by clicking the triangle next to the window title. + +### Docking + +To dock a window, drag the window and hover it over one of the eight blue shapes that appear. You can either dock using pre-existing windows or add a new position. + +To undock a window, drag it by the title and it will undock. + +## Themes + +Themes can be used to further customise the Editor UI with custom colours. To edit the current theme, click `Style Editor` under `Help` in the [Main Menu Bar](editor/mainmenubar.md). Themes can be imported and exported from the clipboard. \ No newline at end of file diff --git a/src/editor/windows/palette.md b/src/editor/windows/palette.md new file mode 100644 index 0000000..14f0582 --- /dev/null +++ b/src/editor/windows/palette.md @@ -0,0 +1,19 @@ +# Palette + +The palette window is very useful for saving blocks in groups to be used in the future. + +The top part of the window shows the 16 previously used blocks. Clicking on one of these blocks will set it as your [Active Block](activeblock.md). + +## Creating Presets + +The lower part is used to display your saved palettes. Right clicking on this lower half and pressing "Add new category" will present a window to name your new palette category. + +After naming your palette, a dropdown with your title with a stone block inside will appear. With the drop-down open, right clicking the stone block will display an option to add a new block or remove that block. + +Right clicking on the dropdown when closed will display some options related to the category. Through this you can add to, rename or delete the category. + +You can also add to the category by dragging and dropping blocks from the **Recently Used** blocks. + +## Using Presets in Other Tools + +Tools that paint more than one block type like the [Noise Painter](/tools/painting/noisepainter.md) support dragging and dropping presets into them. \ No newline at end of file diff --git a/src/editor/windows/tooloptions.md b/src/editor/windows/tooloptions.md new file mode 100644 index 0000000..d98e8c9 --- /dev/null +++ b/src/editor/windows/tooloptions.md @@ -0,0 +1,3 @@ +# Tool Options + +The **Tool Options** window is used for all [tools](/tools/intro.md) to change properties of tools. \ No newline at end of file diff --git a/src/editor/views.md b/src/editor/windows/views.md similarity index 100% rename from src/editor/views.md rename to src/editor/windows/views.md From 246dbd0a802e9cd1a41f8324e3893d660890df31 Mon Sep 17 00:00:00 2001 From: WILLATRONIX Date: Mon, 27 May 2024 17:27:02 +0100 Subject: [PATCH 06/19] Add marker, stamp | update 2.3.0 --- src/SUMMARY.md | 2 ++ src/builder/clone.md | 2 +- src/builder/marker.md | 9 +++++++++ src/builder/move.md | 4 ++-- src/builder/stack.md | 2 +- src/editor/windows/blueprints.md | 2 +- src/editor/windows/tooloptions.md | 14 +++++++++++++- src/tools/drawing/stamp.md | 14 ++++++++++++++ src/tools/painting/noisepainter.md | 2 ++ 9 files changed, 45 insertions(+), 6 deletions(-) create mode 100644 src/builder/marker.md create mode 100644 src/tools/drawing/stamp.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index cc12519..e1dba66 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -12,6 +12,7 @@ - [Erase](builder/erase.md) - [Setup Symmetry](builder/setupsymmetry.md) - [Display Entities](builder/displayentities.md) + - [Marker Entities](builder/marker.md) - [Capabilities](capabilities/intro.md) - [Tinker](capabilities/tinker.md) - [No Updates](capabilities/noupdates.md) @@ -51,6 +52,7 @@ - [Rock](tools/drawing/rock.md) - [Weld](tools/drawing/weld.md) - [Melt](tools/drawing/melt.md) + - [Stamp](tools/drawing/stamp.md) - [Text](tools/drawing/text.md) - [Shape](tools/drawing/shape.md) - [Heightmap Tools](tools/heightmap/intro.md) diff --git a/src/builder/clone.md b/src/builder/clone.md index 101d3ce..3abba38 100644 --- a/src/builder/clone.md +++ b/src/builder/clone.md @@ -1,5 +1,5 @@ # Clone -Clone is similar to [Move](move.md), but it copies the blocks instead of moving them. +Clone is similar to [Move](move.md), but it copies the blocks and entities instead of moving them. The process for using Clone is the same as the Move tool, so refer to [Move](move.md) for more detailed information diff --git a/src/builder/marker.md b/src/builder/marker.md new file mode 100644 index 0000000..4c20b2d --- /dev/null +++ b/src/builder/marker.md @@ -0,0 +1,9 @@ +# Marker Entities + +**Marker Entities** are a vanilla minecraft[^note1] feature which was added in 1.17. Essentially, they are entities that have little to no behaviour. Axiom takes advantage of this and provides a [Gizmo](/editor/gizmos.md) to control the marker. + +Right-clicking the marker gizmo will open a menu, allowing you to input custom NBT for the marker. + +## References + +[^note1]: [Display Entities Wiki](https://minecraft.wiki/w/Marker). \ No newline at end of file diff --git a/src/builder/move.md b/src/builder/move.md index e9ab720..8e501d4 100644 --- a/src/builder/move.md +++ b/src/builder/move.md @@ -1,6 +1,6 @@ # Move -The move tool allows you to adjust the position of blocks in a cuboid region +The move tool allows you to adjust the position of blocks and entities in a cuboid region ## Selecting a region @@ -17,7 +17,7 @@ See below for a step-by-step demonstration. The initial selection is made with a Once you have a selection, simply start scrolling to nudge the blocks in the direction you are looking -The blocks can be flipping using Ctrl+F, and rotated using Ctrl+R +The blocks can be flipped using Ctrl+F, and rotated using Ctrl+R To confirm the movement, press Right Click diff --git a/src/builder/stack.md b/src/builder/stack.md index 354f1ed..12ba7d2 100644 --- a/src/builder/stack.md +++ b/src/builder/stack.md @@ -1,6 +1,6 @@ # Stack -Stack allows you to copy blocks in a row or grid +Stack allows you to copy blocks and entities in a row or grid ## Selecting a region Refer to [Move](move.md) diff --git a/src/editor/windows/blueprints.md b/src/editor/windows/blueprints.md index 9818117..7b00795 100644 --- a/src/editor/windows/blueprints.md +++ b/src/editor/windows/blueprints.md @@ -14,6 +14,6 @@ When you save a blueprint a file system dialog opens up native to your operating The blueprint files themselves can be sent to others who can then also use them in Axiom if they place the files in the designated file location. The blueprint folder supports nested directories as well, meaning that you can for example, put all your trees in one folder under the blueprints folder. -## Loading blueprints +## Blueprint Browser Once you have Blueprints, you can view them in the **Blueprint Browser**. You'll be able to see thumbnails for all of your blueprints, as well as perform searches or filter by tags. Clicking a blueprint will 'open' it and place the blocks into your [clipboard](blocks_and_clipboard.md#clipboard). diff --git a/src/editor/windows/tooloptions.md b/src/editor/windows/tooloptions.md index d98e8c9..0a7ae52 100644 --- a/src/editor/windows/tooloptions.md +++ b/src/editor/windows/tooloptions.md @@ -1,3 +1,15 @@ # Tool Options -The **Tool Options** window is used for all [tools](/tools/intro.md) to change properties of tools. \ No newline at end of file +The **Tool Options** [Window](editor/windows/intro.md) is used for [Tools](/tools/intro.md) to change their properties. Tool properties are essential for using the [Editor Mode](/editor/intro.md). + +This window contains sections for each type of option as well as [Tool Presets](/editor/toolpresets.md). + +## Common Options + +| Option | Description | +| -------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| Shape | Determines the shape of your brush. | +| Radius | Determines the size of your brush. | +| Mask Surface | Ensures the tool only affects solid blocks adjacent to a non-solid block. | +| Replace Solid Blocks | Ensures the tool only replaces solid blocks. | +| Extend to Ground | Ensures the final placement is connected to the ground by stretching each block down until it collides with a solid block. | \ No newline at end of file diff --git a/src/tools/drawing/stamp.md b/src/tools/drawing/stamp.md new file mode 100644 index 0000000..c5074da --- /dev/null +++ b/src/tools/drawing/stamp.md @@ -0,0 +1,14 @@ +# Stamp + +The **Stamp Tool** is a [Blueprint](/editor/windows/blueprints.md) placement tool designed for placing muliple, randomly placed blueprints. Listed below are all [Tool Options](/editor/windows/tooloptions.md) for the **Stamp Tool**. + +| Option | Description | +| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Base Chance | The base chance is the final factor that determines placement. A base chance of 1 means it will always place the blueprint regarding the Min Spacing. | +| Min Spacing | The Minimum Spacing is the first factor that determines placement. A minimum spacing of 5 will result in the centre of two blueprints being at least five blocks apart. | +| Place (Immediate) | The immediate option places all blueprints immediately after releasing your brush stroke. | +| Place (Deferred) | The deferred option allows you to place blueprints with multiple strokes. You can also manually offset the positions of the blueprints by using the [Gizmo](/editor/gizmos.md) located at the centre of the blueprint. New brush strokes will still apply the placement rules to previously placed blueprints. | +| Random Yaw | Randomises the placement by rotating the blueprint in a random direction. | +| Random X/Z Flip | Randomises the placement by flipping the blueprint on the X and Z axis. | + +To load blueprints into the **Stamp Tool**, click the 'Add Blueprint' button. This will open your [Blueprint Browser](/editor/windows/blueprints.md#Blueprint_Browser) and click on the blueprint you'd like to add. To add multiple blueprints, you can either [Dock](/editor/windows/intro.md#Docking) the Blueprint Browser or use Shift + Click to avoid closing the window. \ No newline at end of file diff --git a/src/tools/painting/noisepainter.md b/src/tools/painting/noisepainter.md index 99a8bd3..fd0ede8 100644 --- a/src/tools/painting/noisepainter.md +++ b/src/tools/painting/noisepainter.md @@ -55,6 +55,8 @@ The section beneath the noise configuration allows you to specify the blocks use Clicking the '+' sign adds a new block. Clicking on an existing block allows you to select and add different blocks to your noise pattern. You can also drag and drop palettes and active blocks onto the blocks section. +To modify the property of a block, right-click on the block icon and a menu will appear, allowing you to toggle and set different properties. + ## Preview Lastly, beneath the settings, there are three windows to aid in visualizing the noise pattern, cumulative distribution, and probability density: From b4fa9835320ddf88ad9457e7b38243a948ef74c8 Mon Sep 17 00:00:00 2001 From: WILLATRONIX Date: Mon, 27 May 2024 18:20:31 +0100 Subject: [PATCH 07/19] update 2.4.2 --- src/SUMMARY.md | 2 +- src/builder/marker.md | 2 ++ src/editor/clipboardandplacements.md | 17 ------------ src/editor/gizmos.md | 8 ++++++ src/editor/windows/blueprints.md | 2 ++ src/editor/windows/clipboard.md | 41 ++++++++++++++++++++++++++++ 6 files changed, 54 insertions(+), 18 deletions(-) delete mode 100644 src/editor/clipboardandplacements.md create mode 100644 src/editor/windows/clipboard.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index e1dba66..9fc039d 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -21,11 +21,11 @@ - [Bulldozer](capabilities/bulldozer.md) - [Editor Mode](editor/intro.md) - [Main Menu Bar](editor/mainmenubar.md) - - [Clipboard and Placements](editor/clipboardandplacements.md) - [Selections](editor/selections.md) - [Gizmos](editor/gizmos.md) - [Tool Presets](editor/toolpresets.md) - [Windows](editor/windows/intro.md) + - [Clipboard](editor/clipboard.md) - [Views](editor/windows/views.md) - [Blueprints](editor/windows/blueprints.md) - [Active Block](editor/windows/activeblock.md) diff --git a/src/builder/marker.md b/src/builder/marker.md index 4c20b2d..f124300 100644 --- a/src/builder/marker.md +++ b/src/builder/marker.md @@ -1,5 +1,7 @@ # Marker Entities +> Similar to [Display Enities](displayentities.md) + **Marker Entities** are a vanilla minecraft[^note1] feature which was added in 1.17. Essentially, they are entities that have little to no behaviour. Axiom takes advantage of this and provides a [Gizmo](/editor/gizmos.md) to control the marker. Right-clicking the marker gizmo will open a menu, allowing you to input custom NBT for the marker. diff --git a/src/editor/clipboardandplacements.md b/src/editor/clipboardandplacements.md deleted file mode 100644 index 2492fab..0000000 --- a/src/editor/clipboardandplacements.md +++ /dev/null @@ -1,17 +0,0 @@ -# Clipboard and Placements - -## Clipboard - -A selection can be copied to the clipboard using Ctrl+C. - -With blocks in your clipboard, you can paste back into the world by hovering over the desired location and pressing Ctrl+V. Pasting like this will initiate a **Placement** (see below). - -The clipboard can be cleared by right-clicking the icon and choosing the 'clear' option. Left-clicking the clipboard opens up the [**Blueprint Browser**](blueprints.md). - -## Placement - -Placements can be repositioned and rotated using the [Gizmo](gizmos.md). - -Once the placement is in the correct position, you can use Enter or Ctrl+V to confirm it. To cancel a placement, use the Delete key. - -> Tip: The placement can be rotated clockwise using the Ctrl+R keybind, and can be flipped in the direction of your mouse vector using the Ctrl+F keybind. diff --git a/src/editor/gizmos.md b/src/editor/gizmos.md index bcde2ac..10c7cf6 100644 --- a/src/editor/gizmos.md +++ b/src/editor/gizmos.md @@ -9,3 +9,11 @@ A gizmo can contain the following elements: - **Global Gizmos** A global gizmo has its rotation and axis arrows locked to the world xyz. - **Local Gizmos** Unlike global gizmos, local gizmos have their rotation and axis locked to the object itself. Rotating your object 45 degrees will alter your axis arrows by 45 degrees. + +## Placement + +Placements can be repositioned and rotated using the Gizmo. + +Once the placement is in the correct position, you can use Enter or Ctrl+V to confirm it. To cancel a placement, use the Delete or Backspace key. + +> Tip: The placement can be rotated clockwise using the Ctrl+R keybind, and can be flipped in the direction of your mouse vector using the Ctrl+F keybind. \ No newline at end of file diff --git a/src/editor/windows/blueprints.md b/src/editor/windows/blueprints.md index 7b00795..23cb8c3 100644 --- a/src/editor/windows/blueprints.md +++ b/src/editor/windows/blueprints.md @@ -17,3 +17,5 @@ The blueprint files themselves can be sent to others who can then also use them ## Blueprint Browser Once you have Blueprints, you can view them in the **Blueprint Browser**. You'll be able to see thumbnails for all of your blueprints, as well as perform searches or filter by tags. Clicking a blueprint will 'open' it and place the blocks into your [clipboard](blocks_and_clipboard.md#clipboard). + +> Tip: You can go back and refresh by clicking the appropriate button next to the seach box. \ No newline at end of file diff --git a/src/editor/windows/clipboard.md b/src/editor/windows/clipboard.md new file mode 100644 index 0000000..59fc3bd --- /dev/null +++ b/src/editor/windows/clipboard.md @@ -0,0 +1,41 @@ +# Clipboard and Placements + +## Clipboard + +A selection can be copied to the clipboard using Ctrl+C. + +With blocks in your clipboard, you can paste back into the world by hovering over the desired location using your cursor position and pressing Ctrl+V. Pasting like this will initiate a [Placement](/editor/gizmos.md#Placement). + +The clipboard can be cleared by right-clicking the icon and choosing the 'clear' option. + +## Rotation and Scaling + +While the placement is initiated and the [Gizmo](/editor/gizmos.md) is visible, some options will appear on your [View](views.md) window[^note1]. + +## Placement Options + +| Option | Description | +| --------------- | ---------------------------------------------------------------------------- | +| Keep Existing | Stops the placement from overriding pre-existing blocks | +| Paste Air | Enables air to override pre-existing blocks | +| Merge Blocks | Merges new blocks with existing blocks based on the block shape. | +| Unlock Rotation | Allows the placement to be rotated at any angle rather than 90 degree steps. | +| Rotate/Scale | Opens the [Rotate/Scale](clipboard.md#Rotate_and_Scale) window. | +| Snap to ground | Repositions the placement down to the nearest solid surface. | + +## Rotate and Scale + +The Rotate/Scale window allows for rotating and resizing by any amount. This window contains a drop-down with for multiple functions. Below are all options with a description. + +| Option | Description | +| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Nearest Neighbour | Nearest Neighbour has 6 translation inputs, one for each rotation axis and one for each scale axis. However the output may contain more artifacts than using the other translation types. | +| RotSprite | RotSprite has 3 translation inputs, there is one input for each rotation axis. | +| Scale2x | Scale2x has no inputs. It scales your placement by two times its size. | +| Scale3x | Scale3x has no inputs. It scales your placement by three times its size. | + +> Tip: Left-clicking the 'Empty' clipboard icon opens up the [Blueprint Browser](blueprints.md). + +## References + +[^note1]: For versions 3.0.0 and below, the options will appear inside the clipboard window. \ No newline at end of file From bab179d1918671f4ec7c9e02a7bf1cff64877de5 Mon Sep 17 00:00:00 2001 From: WILLATRONIX Date: Mon, 27 May 2024 19:26:52 +0100 Subject: [PATCH 08/19] update 2.5.0 --- src/editor/intro.md | 4 ++-- src/tools/painting/noisepainter.md | 2 ++ src/tools/painting/painter.md | 2 ++ src/tools/selection/lasso.md | 7 +++++++ 4 files changed, 13 insertions(+), 2 deletions(-) create mode 100644 src/tools/selection/lasso.md diff --git a/src/editor/intro.md b/src/editor/intro.md index e759f34..144f9f2 100644 --- a/src/editor/intro.md +++ b/src/editor/intro.md @@ -16,8 +16,8 @@ The default camera controls are: - Arcball Camera: Ctrl + Left Click - Pan Camera: Ctrl + Right Click -> If you wish to invert the left click rotation, toggle Help > Keybinds > Invert Camera Rotate +The flight speed can be changed using the slider at the very bottom of the Editor UI. -Other keybinds can be found in Help > Keybinds, where they can also be rebound +Keybinds can be found in the [Main Menu Bar](mainmenubar.md) as 'Keybinds' If you'd prefer a default key layout reminiscent of Blender, use Load Default > Blender-like diff --git a/src/tools/painting/noisepainter.md b/src/tools/painting/noisepainter.md index fd0ede8..f6444e7 100644 --- a/src/tools/painting/noisepainter.md +++ b/src/tools/painting/noisepainter.md @@ -6,6 +6,8 @@ The first unqiue option is the toggle for the ‘3D’ setting. This allows the Next, we have the scale option, which adjusts the size of the noise relative to the block grid. A larger scale means that the noise pattern is spread over a larger area of blocks. +Finally, the Anisotropic option enables control of scale on each axis individually, allowing for a stretched effect. + ## Noises There are a few shared settings across the different noises. The common options between these noises are listed below, with sepcific settings for each noise described in their respective sections. diff --git a/src/tools/painting/painter.md b/src/tools/painting/painter.md index e255f2d..57e9b08 100644 --- a/src/tools/painting/painter.md +++ b/src/tools/painting/painter.md @@ -3,3 +3,5 @@ The **Painter** is the most basic painting tool. It allows you to paint blocks with a single type using a brush stroke. The **Mask Surface** option allows only painting blocks which are adjacent to a non-solid block. + +The **Mode** drop-down allows switching between [Active Block](/editor/windows/activeblock.md), [Clipboard](/editor/windows/clipboard.md) and Gradient. The active block mode paints with your active block. The clipboard mode paints using your clipboard in a repeating grid pattern. The gradient mode is similar to The [Gradient Painter](gradientpainter.md) but instead paints the gradient around the centre of the brush. The merge strokes option for the gradient mode stops the painter from overriding blocks that are in the gradient. \ No newline at end of file diff --git a/src/tools/selection/lasso.md b/src/tools/selection/lasso.md new file mode 100644 index 0000000..f753ddd --- /dev/null +++ b/src/tools/selection/lasso.md @@ -0,0 +1,7 @@ +# Lasso Select + +The lasso select is very unique, it allows the user to draw out a shape on screen to determine the selection. + +To draw the selection, use right-click and draw out the looped shape. After releasing right-click, the drawn outline will be cast to the blocks within your view. You can set the depth of the selection by adjusting the **Depth** slider. + +Enabling the 'Include Non-Solid' will allow the selection to include blocks such as short grass. \ No newline at end of file From b84eb2f80f8497b616cb4e42ba9276ba05e50993 Mon Sep 17 00:00:00 2001 From: WILLATRONIX Date: Mon, 27 May 2024 20:28:32 +0100 Subject: [PATCH 09/19] 2.6.0 --- src/SUMMARY.md | 6 ++++-- src/builder/contextmenu.md | 2 ++ src/builder/intro.md | 12 ++++++++++++ src/editor/windows/blueprints.md | 2 ++ src/editor/windows/intro.md | 10 ++++++++-- src/editor/windows/palette.md | 4 +++- src/tools/other/intro.md | 3 +++ src/tools/{ => other}/path.md | 0 src/tools/{ => other}/ruler.md | 2 ++ 9 files changed, 36 insertions(+), 5 deletions(-) create mode 100644 src/tools/other/intro.md rename src/tools/{ => other}/path.md (100%) rename src/tools/{ => other}/ruler.md (91%) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 9fc039d..264d349 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -37,6 +37,7 @@ - [Tool Options](editor/windows/tooloptions.md) - [Tools](tools/intro.md) - [Selection Tools](tools/selection/intro.md) + - [Lasso Select](tools/selection/lasso.md) - [Box Select](tools/selection/boxselect.md) - [Magic Select](tools/selection/magicselect.md) - [Freehand Select](tools/selection/freehandselect.md) @@ -65,8 +66,9 @@ - [Shatter](tools/manipulation/shatter.md) - [Extrude](tools/manipulation/extrude.md) - [Modify](tools/manipulation/modify.md) - - [Ruler Tool](tools/ruler.md) - - [Path Tool](tools/path.md) + - [Other](tools/other/intro.md) + - [Ruler Tool](tools/other/ruler.md) + - [Path Tool](tools/other/path.md) - [Advanced](advanced/intro.md) - [Commands](advanced/commands.md) - [Config](advanced/configuration.md) diff --git a/src/builder/contextmenu.md b/src/builder/contextmenu.md index 3d0395a..30605f5 100644 --- a/src/builder/contextmenu.md +++ b/src/builder/contextmenu.md @@ -10,6 +10,8 @@ This feature aids in organization, allowing you to swap between building materia You can reorganize your hotbars by clicking items like you would in any other inventory. The fastest way to fill a hotbar is to open an empty bar and fill it using the creative inventory or pick block as you normally would. +Clicking the red 'x' below the flight speed will remove all saved hotbars except for the current one. + ### Capabilities On the left-hand side you can find a number of buttons for toggling building **Capabilities**. A raised or lighter background means the Capability is disabled, while a depressed or darker background means the Capability is enabled. diff --git a/src/builder/intro.md b/src/builder/intro.md index 0bfafc1..5b0c530 100644 --- a/src/builder/intro.md +++ b/src/builder/intro.md @@ -13,6 +13,12 @@ To the right of the hotbar, you can find the Builder Tools. These tools are very To start using a Builder Tool, scroll to the 10th slot or press 0. To switch to a different Builder Tool, hold Left Alt and then scroll. +The three main keybinds for the Builder Tools are left-click, right-click and middle-click. Middle-click has similar a functionality to left and right-click but instead of selecting the corners, middle-click is used to select the faces. + +When working with a selection, useful information such as offset and size is displayed above the hotbar. + +Holding either x, y or z while scrolling to move the placement will lock it to that direction. + The tools that are currently available in this section are: - [Move](/builder/move.md) - [Clone](/builder/clone.md) @@ -24,3 +30,9 @@ The tools that are currently available in this section are: ![Builder Tools](/img/BuilderToolsOverview.png) + +## Gameplay + +Using Ctrl + C while looking at a block will copy its exact nbt state. + +When searching in the creative inventory, pressing enter will add the first listed block to your current hotbar slot. \ No newline at end of file diff --git a/src/editor/windows/blueprints.md b/src/editor/windows/blueprints.md index 23cb8c3..4285028 100644 --- a/src/editor/windows/blueprints.md +++ b/src/editor/windows/blueprints.md @@ -10,6 +10,8 @@ Authors, tags and names are all ways by which you can easily look up blueprints When you save a blueprint a file system dialog opens up native to your operating system. This confirms the name you want to give to the blueprint and lets to save it as a .bp file on your local computer. This means that you can easily create blueprints in one world or server and then use them in another world without having to deal with messy import or export schemas. The files themselves are stored in your .minecraft folder under `.minecraft/config/axiom/blueprints` +> Tip: Use tab to navigate the create blueprint window faster. + ## Sharing blueprints The blueprint files themselves can be sent to others who can then also use them in Axiom if they place the files in the designated file location. The blueprint folder supports nested directories as well, meaning that you can for example, put all your trees in one folder under the blueprints folder. diff --git a/src/editor/windows/intro.md b/src/editor/windows/intro.md index f156d74..dc73146 100644 --- a/src/editor/windows/intro.md +++ b/src/editor/windows/intro.md @@ -22,6 +22,12 @@ To dock a window, drag the window and hover it over one of the eight blue shapes To undock a window, drag it by the title and it will undock. -## Themes +## Other Windows -Themes can be used to further customise the Editor UI with custom colours. To edit the current theme, click `Style Editor` under `Help` in the [Main Menu Bar](editor/mainmenubar.md). Themes can be imported and exported from the clipboard. \ No newline at end of file +### Themes + +Themes can be used to further customise the Editor UI with custom colours. To edit the current theme, click `Style Editor` under `Help` in the [Main Menu Bar](editor/mainmenubar.md). Themes can be imported and exported from the clipboard. + +### Select Block + +The select block window is essentially the creative inventory for the Editor Mode. You can either search by block name or block ID. \ No newline at end of file diff --git a/src/editor/windows/palette.md b/src/editor/windows/palette.md index 14f0582..8c2172b 100644 --- a/src/editor/windows/palette.md +++ b/src/editor/windows/palette.md @@ -16,4 +16,6 @@ You can also add to the category by dragging and dropping blocks from the **Rece ## Using Presets in Other Tools -Tools that paint more than one block type like the [Noise Painter](/tools/painting/noisepainter.md) support dragging and dropping presets into them. \ No newline at end of file +Tools that paint more than one block type like the [Noise Painter](/tools/painting/noisepainter.md) support dragging and dropping presets into them. + +> Tip: Dragging and dropping palettes on a block will replace all adjacent blocks of the same type with random blocks from the palette. \ No newline at end of file diff --git a/src/tools/other/intro.md b/src/tools/other/intro.md new file mode 100644 index 0000000..a7ca67d --- /dev/null +++ b/src/tools/other/intro.md @@ -0,0 +1,3 @@ +# Other + +Contains tools that aren't categorised as drawing, heightmap, manipulation, painting or selection tools. \ No newline at end of file diff --git a/src/tools/path.md b/src/tools/other/path.md similarity index 100% rename from src/tools/path.md rename to src/tools/other/path.md diff --git a/src/tools/ruler.md b/src/tools/other/ruler.md similarity index 91% rename from src/tools/ruler.md rename to src/tools/other/ruler.md index 6a510d6..55a7234 100644 --- a/src/tools/ruler.md +++ b/src/tools/other/ruler.md @@ -13,3 +13,5 @@ Here's the information you'll see: - Bounding Size: The size of the box needed to draw around all the points. - Yaw (Only visible with two points): The yaw of the line between two points. - Pitch (Only visible with two points): The pitch of the line between two points. + +> Tip: Ruler measurements are permanantely visible even outside the editor, so make sure to remove them once you're done. \ No newline at end of file From 3cab6908d995b4a5241ce37b708f31c7f727fe18 Mon Sep 17 00:00:00 2001 From: WILLATRONIX Date: Mon, 27 May 2024 20:36:38 +0100 Subject: [PATCH 10/19] 2.6.1 --- src/editor/windows/activeblock.md | 2 ++ src/tools/other/path.md | 6 +++--- src/tools/selection/magicselect.md | 2 ++ 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/src/editor/windows/activeblock.md b/src/editor/windows/activeblock.md index 865c356..bb0deab 100644 --- a/src/editor/windows/activeblock.md +++ b/src/editor/windows/activeblock.md @@ -8,3 +8,5 @@ Blocks in the Editor UI can be drag-dropped on different locations to various ef - Into the main viewport to flood replace the targeted block with the dropped block The **Active Block** can be quickly set using 'pick block', which is bound to middle-click by default. + +> Tip: You can use middle-click to copy blocks from the world to your active block \ No newline at end of file diff --git a/src/tools/other/path.md b/src/tools/other/path.md index d03dfb4..404d8d1 100644 --- a/src/tools/other/path.md +++ b/src/tools/other/path.md @@ -8,18 +8,18 @@ You may select from Linear(Bresenham), Linear(DDA), Catenary, Catmull-Rom Spline # Linear(Bresenham) -This creates a straight line from node to node. Diagonal blocks are not filled in. You cannot change the radius. +This creates a straight line from node to node. Diagonal blocks are not filled in. You cannot change the radius and shape. ![Linear(Bresenham)](https://imagedelivery.net/W9K_l6ndK9x4x8m3rurakg/5fd8e02b-0698-453c-8f90-cbd716807d00/original) # Linear(DDA) -This also creates a straight line from node to node. The diagonal blocks are filled in. You may change the radius. +This also creates a straight line from node to node. The diagonal blocks are filled in. You may change the radius and shape. ![Linear(DDA)](https://imagedelivery.net/W9K_l6ndK9x4x8m3rurakg/b9d88f87-5f1a-4e87-deb1-60a6485e1300/original) # Catenary -This creates a line which has some slack. It dangles down from node to node. The diagonal blocks are filled in. You may change the radius. +This creates a line which has some slack. It dangles down from node to node. The diagonal blocks are filled in. You may change the radius and shape. There are two more parameters for this curve. You may invert it such that it is flipped upside down. You may also adjust the slack, a 0% slack is a straight line. diff --git a/src/tools/selection/magicselect.md b/src/tools/selection/magicselect.md index fa38bc3..43472bb 100644 --- a/src/tools/selection/magicselect.md +++ b/src/tools/selection/magicselect.md @@ -17,3 +17,5 @@ The **Limit** option is a slider which can be configured to set how many blocks The **Range** option is a slider which lets you set how far the algorithm should look for any adjacent blocks. This lets the tool ‘jump the gap’ between two blocks. The range simply represents how far it can look before cutting off. For example a bushy tree might have two or more blocks of air between it’s leaves and logs. This lets you select all the leaves that are on the tree regardless of the fact that there are air blocks between two branches with leaves. The **Surface Only** option is a toggle which makes the tool only select the blocks on the surface of the selection or, equivalently, all blocks adjacent to air or the ‘outside’. + +> Tip: You can drag-click across multiple block types to select more than one block type. \ No newline at end of file From f6639bf9be14997d901ed99d8a8627fb657fc9d9 Mon Sep 17 00:00:00 2001 From: WILLATRONIX Date: Mon, 27 May 2024 21:32:13 +0100 Subject: [PATCH 11/19] 2.7.0 --- src/SUMMARY.md | 1 + src/advanced/configuration.md | 28 ++++++++++++++-------------- src/builder/blockattributes.md | 12 ++++++++++++ 3 files changed, 27 insertions(+), 14 deletions(-) create mode 100644 src/builder/blockattributes.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 264d349..e2d7b32 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -13,6 +13,7 @@ - [Setup Symmetry](builder/setupsymmetry.md) - [Display Entities](builder/displayentities.md) - [Marker Entities](builder/marker.md) + - [Edit Block Attributes](builder/blockattributes.md) - [Capabilities](capabilities/intro.md) - [Tinker](capabilities/tinker.md) - [No Updates](capabilities/noupdates.md) diff --git a/src/advanced/configuration.md b/src/advanced/configuration.md index 90c7636..e690aff 100644 --- a/src/advanced/configuration.md +++ b/src/advanced/configuration.md @@ -10,25 +10,25 @@ Below are the three files alongside their descriptions. ### `.axiominternal.hocon` -| Key | Description | -| ------------------------------ | --------------------------------------------------------------------------------- | -| completedTutorials | Lists the tools that have shown their short tutorial. | -| customDowngradeSuggestions | Lists the downgrades suggested by Axiom. | -| globalScale | A float representing the [Editor](editor/intro.md) UI Scale. | -| lastTranslationCount | A value determining the amount of translations. | -| openEditorWindowTypes | A list of open windows in the editor. | -| rootEditorPalette | The default block palette for the editor mode. | -| savedCustomTheme | Stores the currently active [Theme](/editor/windows/intro.md#Themes) as a string. | -| showCloseWindowButton | A boolean to toggle the "x" to close windows. | -| showNon90DegreeRotationWarning | A boolean to toggle the warning before applying non-90-degree angles. | -| showToolMaskOpenWarning | A boolean to toggle the warning when using tool masks. | -| shownIntroduction | A boolean representing whether the introduction has been completed. | +| Key | Description | +| ------------------------------ | -------------------------------------------------------------------------------------- | +| completedTutorials | Lists the tools that have shown their short tutorial. | +| customDowngradeSuggestions | Lists the downgrades suggested by Axiom. | +| globalScale | A float representing the [Editor](editor/intro.md) UI Scale. | +| lastTranslationCount | A value determining the amount of translations. | +| openEditorWindowTypes | A list of open windows in the editor. | +| rootEditorPalette | The default block palette for the editor mode. | +| savedCustomTheme | Stores the currently active [Theme](/editor/windows/intro.md#Themes) as a string. | +| showCloseWindowButton | A boolean to toggle the "x" to close windows. | +| showNon90DegreeRotationWarning | A boolean to toggle the warning before applying non-90-degree angles. | +| showToolMaskOpenWarning | A boolean to toggle the warning when using [Tool Masks](/editor/windows/toolmasks.md). | +| shownIntroduction | A boolean representing whether the introduction has been completed. | ### `.axiom.hocon` | Key | Description | | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| blockAttributes | Contains the currently toggled block attributes. | +| blockAttributes | Contains the currently toggled [Block Attributes](/builder/blockattributes.md). | | blueprint | Stores the toggle to automatically refresh and a list of all used blueprint tags. | | capabilities | Lists all abilities and their state. Also contains the `autoSwapToCreative` boolean that controls switching to creative when opening the [context menu](/builder/contextmenu.md). | | keybinds | Stores in-game keybinds and settings for the Builder Mode and camera movement. | diff --git a/src/builder/blockattributes.md b/src/builder/blockattributes.md new file mode 100644 index 0000000..6722b56 --- /dev/null +++ b/src/builder/blockattributes.md @@ -0,0 +1,12 @@ +# Edit Block Attributes + +The Edit Block Attributes menu can be used to configure multiple settings that alter gameplay. + +| Setting | Description | +| ---------------------------- | ------------------------------------------------------------------------------------------ | +| Show Collision Mesh | Creates a red outline for every block with a transparent hitbox like leaves or fences. | +| Show Light Blocks | Adds a texture for light blocks and enables interactions with them. | +| Show Structure Void Blocks | Adds a texture for structure void blocks. | +| Expand Hitboxes to Full Cube | Sets all hitboxes to a full block. Affects blocks like slabs or buttons. | +| Make Fluid Hitboxes Solid | Allows you to break individual blocks of water with your fist. | +| Prevent Interactions | Stops the player from opening containers or interacting with blocks while holding a block. | \ No newline at end of file From 8cb09c46eed06b7a49a0b5b3a2754f41fa4ec7f3 Mon Sep 17 00:00:00 2001 From: WILLATRONIX Date: Tue, 28 May 2024 17:17:12 +0100 Subject: [PATCH 12/19] Builder Mode Overhaul --- src/advanced/commands.md | 18 +++++++ src/builder/blockattributes.md | 12 +++-- src/builder/clone.md | 32 ++++++++++-- src/builder/contextmenu.md | 57 ++++++++++++++++----- src/builder/displayentities.md | 2 +- src/builder/erase.md | 25 +++++++-- src/builder/extrude.md | 10 ++-- src/builder/marker.md | 2 +- src/builder/move.md | 37 ++++++++----- src/builder/setupsymmetry.md | 25 ++++++--- src/builder/smear.md | 27 ++++++---- src/builder/stack.md | 28 ++++++---- src/editor/mainmenubar.md | 3 +- src/editor/windows/blueprints.md | 12 ++++- src/editor/windows/clipboard.md | 2 +- src/editor/windows/worldproperties.md | 2 +- src/img/AltMenuOverview.png | Bin 195859 -> 342485 bytes src/img/axiomIcon.png | Bin 0 -> 4394 bytes src/img/buildertools/builderIcons.gif | Bin 0 -> 1827 bytes src/img/buildertools/builderIconsLarge.gif | Bin 0 -> 20557 bytes src/img/buildertools/clone.png | Bin 0 -> 168 bytes src/img/buildertools/erase.png | Bin 0 -> 288 bytes src/img/buildertools/extrude.png | Bin 0 -> 224 bytes src/img/buildertools/move.png | Bin 0 -> 240 bytes src/img/buildertools/setupSymmetry.png | Bin 0 -> 208 bytes src/img/buildertools/smear.png | Bin 0 -> 170 bytes src/img/buildertools/stack.png | Bin 0 -> 210 bytes src/img/light_block_15.png | Bin 0 -> 191 bytes src/img/structure_void.png | Bin 0 -> 162 bytes src/multiplayer/permissions.md | 0 src/multiplayer/whitelists.md | 0 src/tools/painting/scriptbrush.md | 2 +- 32 files changed, 221 insertions(+), 75 deletions(-) create mode 100644 src/img/axiomIcon.png create mode 100644 src/img/buildertools/builderIcons.gif create mode 100644 src/img/buildertools/builderIconsLarge.gif create mode 100644 src/img/buildertools/clone.png create mode 100644 src/img/buildertools/erase.png create mode 100644 src/img/buildertools/extrude.png create mode 100644 src/img/buildertools/move.png create mode 100644 src/img/buildertools/setupSymmetry.png create mode 100644 src/img/buildertools/smear.png create mode 100644 src/img/buildertools/stack.png create mode 100644 src/img/light_block_15.png create mode 100644 src/img/structure_void.png create mode 100644 src/multiplayer/permissions.md create mode 100644 src/multiplayer/whitelists.md diff --git a/src/advanced/commands.md b/src/advanced/commands.md index 72fa409..4faed31 100644 --- a/src/advanced/commands.md +++ b/src/advanced/commands.md @@ -26,6 +26,24 @@ Commands are essential for management and debugging. - Returns Axiom's status and information on how to resolve issues. +## Axiom Gamerule Commands + +### axiomDoBlockDrops + +- Unlike the [doTileDrops](https://minecraft.wiki/w/Game_rule) gamerule, Axiom's gamerule covers all blocks. + +### axiomDoBlockGravity + +- When False, all gravity affected blocks like sand will never update regardless of the interaction. + +### axiomDoTrampleFarmland + +- When False, farmland cannot be trampled by any entity. + +### axiomPlayerInvulnerability + +- Prevents all forms of death, including void damage and /kill. + ## Compatible commands `//pos1` and `//pos2` are part of Axiom, but are intended to be used alongside WorldEdit. \ No newline at end of file diff --git a/src/builder/blockattributes.md b/src/builder/blockattributes.md index 6722b56..63780b2 100644 --- a/src/builder/blockattributes.md +++ b/src/builder/blockattributes.md @@ -5,8 +5,14 @@ The Edit Block Attributes menu can be used to configure multiple settings that a | Setting | Description | | ---------------------------- | ------------------------------------------------------------------------------------------ | | Show Collision Mesh | Creates a red outline for every block with a transparent hitbox like leaves or fences. | -| Show Light Blocks | Adds a texture for light blocks and enables interactions with them. | -| Show Structure Void Blocks | Adds a texture for structure void blocks. | +| Show Light Blocks | Adds a texture[^note1] for light blocks and enables interactions with them. | +| Show Structure Void Blocks | Adds a texture[^note2] for structure void blocks. | | Expand Hitboxes to Full Cube | Sets all hitboxes to a full block. Affects blocks like slabs or buttons. | | Make Fluid Hitboxes Solid | Allows you to break individual blocks of water with your fist. | -| Prevent Interactions | Stops the player from opening containers or interacting with blocks while holding a block. | \ No newline at end of file +| Prevent Interactions | Stops the player from opening containers or interacting with blocks while holding a block. | + +## Notes + +[^note1]: ![Light Block Texture](/img/light_block_15.png) + +[^note2]: ![Light Block Texture](/img/structure_void.png) \ No newline at end of file diff --git a/src/builder/clone.md b/src/builder/clone.md index 3abba38..9ed8ec6 100644 --- a/src/builder/clone.md +++ b/src/builder/clone.md @@ -1,5 +1,31 @@ -# Clone +# ![](/img/buildertools/clone.png) Clone -Clone is similar to [Move](move.md), but it copies the blocks and entities instead of moving them. +The clone tool allows you to copy a cuboid area and paste it elsewhere multiple times. -The process for using Clone is the same as the Move tool, so refer to [Move](move.md) for more detailed information +## Creating Selections + +To create a selection, start by using left-click to select your first corner and then right-click to select the second. You can use middle-click to select faces instead of the corners. This makes it much easier to select blocks that don't already have edges. + +## Moving Selections + +Once you're happy with your selection, you can move it by scrolling with the mouse wheel. Now, a hologram will represent the selection you'll be working with. You will also be presented with different controls, using middle-click you can move the selection to the direction you're facing. + +Using the scroll wheel, you can nudge the selection by one block. Scrolling up will push the selection away from the player and scrolling down will bring the selection closer to the player, so the direction the player is facing determines the direction the selection is pulled or pushed. The arrows on the faces of your selection will indicate the scroll up direction. + +By holding the 'X', 'Y' or 'Z' keys, you can force the selection to move in a single axis. For example, holding the 'X' key while nudging the selection will force it to move on the X axis only. + +## Modifying Selections + +You can further modify a selection by two ways: flip and rotate. These can alter the orentation of the selection in almost any way. + +To flip a selection, use `Ctrl + F`. This will flip the selection depending on the direction you're facing. The arrow on the side of your selection will indicate the direction your selection will be flipped. + +To rotate a selection, use `Ctrl + R`. This will rotate the selection clockwise on the X and Z axis. For example, a selection facing north will be face east after rotating it. + +With a selection, you're still able to expand the selection with middle-click. Using left or right-click also works to set a corner again. + +## Confirming Selections + +After you're happy with your movement and modifications, use right-click to confirm the selection, then use left-click to finish the selection. If you want to create multiple copies, move the selection using your scroll wheel instead of finishing the selection. + +If you're not happy with the result, use `Ctrl + Z` to undo the placement. If you can't make up your mind, you can use `Ctrl + Y` to redo your undo. \ No newline at end of file diff --git a/src/builder/contextmenu.md b/src/builder/contextmenu.md index 30605f5..88c9400 100644 --- a/src/builder/contextmenu.md +++ b/src/builder/contextmenu.md @@ -1,26 +1,57 @@ -## Builder Context Menu -The features for builder mode are accessed in the builder context menu. By default, holding down Left Alt opens the menu. +# Context Menu +The features for builder mode are accessed in the builder context menu. By default, holding down `left alt` opens the menu. -![Builder Context Menu](../img/AltMenuOverview.png) +![Builder Context Menu](/img/AltMenuOverview.png) ### Hotbar Swapper -The hotbar swapper is the most prominent feature you’ll notice when you first open the builder context menu. While the menu is open you can use your scroll wheel or number keys to quickly swap to another hotbar. -This feature aids in organization, allowing you to swap between building materials without needing to open your inventory and move things around. +The Hotbar Swapper is a better version of the vanilla “Saved Hotbars” which are stored in the creative inventory and are loaded using keybinds. The Hotbar Swapper is in the centre of the Context Menu and has 9 saveable hotbars. -You can reorganize your hotbars by clicking items like you would in any other inventory. The fastest way to fill a hotbar is to open an empty bar and fill it using the creative inventory or pick block as you normally would. +To save items to the hotbar swapper, use the scroll wheel while the context menu is open to select the hotbar you would like to save to. -Clicking the red 'x' below the flight speed will remove all saved hotbars except for the current one. +Then close the context menu and fill your hotbar with the items you want. When you’re done, you can scroll to the next hotbar you would like to modify. Another way to modify hotbars would be to click on an item with left-click and drop it into another position with left-click. + +> Note: Hotbars are not transferred between worlds + +Loading saved Hotbars is simple. Just use the scroll wheel in the context menu to select the hotbar you’d like to use. Then close the context menu and the blocks and items you previously saved should be loaded into your hotbar. ### Capabilities -On the left-hand side you can find a number of buttons for toggling building **Capabilities**. A raised or lighter background means the Capability is disabled, while a depressed or darker background means the Capability is enabled. +Capabilities allow you to change the way you place, destroy and modify blocks. When a capability is enabled, the button will be tinted green. Disabled capabilities are represented as greyed. + +Further information on the individual capabilities can be found [here](/capabilities/intro.md). + +### Create Display Entity + +Allows for creating and manipulating display entities. Read more [here](displayentities.md). + +### Edit Block Attributes -Documentation for Capabilities can be found [here](/capabilities/intro.md) +Provides settings that alter gameplay. Read more [here](blockattributes.md). -### Gamemode Switchers -Above the hotbar swappers are 3 buttons for quickly swapping to other gamemodes. Using these buttons can be slightly faster than messing around with F3+F4 or chat commands. +### Gamemode Switcher -> Tip: Pressing Left Alt while not in creative mode will put you into creative mode, this can be useful if you are in spectator mode and want to swap back to place some blocks. +Using these buttons can be slightly faster than messing around with F3+F4 or chat commands. + +Pressing Left Alt while in another gamemode will put you into creative mode, this can be useful if you are in spectator mode and want to quickly switch to creative. This can be disabled in the [config](/advanced/configuration.md) as `autoSwapToCreative`. ### Flight Speed -On the right-hand side you can find a slider which allows you to quickly change your flight speed, up to 1000% or 10x faster. + +The Flight Speed is represented as a vertical slider on the right side of the context menu. The current speed is represented as a percentage above the slider. 100% is normal flight speed and 200% would be two times as fast. The limit is 999%. + +To change the flight speed, use left-click on the slider to select a specific speed. Dragging the slider and clicking the plus and minus symbols are other ways you can change the flight speed. + +### Toolbox + +The Toolbox is located under the flight speed slider in the context menu and contains useful settings for building. Listed below are all Toolbox settings alongside their description. + +| Setting | Description | +| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Show marker entity gizmos | Toggles visualisation of [Marker Entity](marker.md) [Gizmos](/editor/gizmos.md). | +| Show display entity gizmos | Toggles visualisation of [Display Entitiy](displayentities.md) [Gizmos](/editor/gizmos.md). | +| Show key hints | Toggles the ability to view currently pressed keys at the bottom right corner of the screen. This can be useful for debugging or tutorials. | +| Infinite reach limit | Sets the range for the [Infinite Reach capability](/capabilities/intro.md). The slider ranges from 5 to 100 and is set to infinite by default. | +| Liquid opacity | Sets the opacity of water. 100% normal opacity and 0% results in water being invisible. | +| Minimum Brightness | Sets the minimum brightness. 0% is default and 100% removes all shadows. | +| Type replace | The Type Replace toggle affects the [Replace capability](/capabilities/replacemode.md). Replacing blocks with multiple variants such as stairs and slabs with another multi-variant block will change that block to the variant regardless of what block it is. | +| Flight direction | Flight Direction changes the way you fly in creative mode. The vanilla flight mode is 'Horizontal' and the Axiom version is called 'Camera'. The camera mode allows you to fly in all directions using the direction of the camera. | +| Flight momentum | The flight momentum affects how long it takes to change speeds while flying. A higher momentum means a longer delay until you reach full speed, resulting in a smoother flight. | \ No newline at end of file diff --git a/src/builder/displayentities.md b/src/builder/displayentities.md index 336fd4d..1f90b19 100644 --- a/src/builder/displayentities.md +++ b/src/builder/displayentities.md @@ -84,7 +84,7 @@ The **Editing Menu** has many useful features. Listed below are all features wit | Copy Coordinates | Copies the exact coordinates to the clipboard. | | Copy Transform Command | Copies the transformation to the clipboard as a command. | -## References +## Notes [^note1]: [Display Entities](https://minecraft.wiki/w/Display) are a vanilla Minecraft feature. diff --git a/src/builder/erase.md b/src/builder/erase.md index 7e5b3dc..eebc03a 100644 --- a/src/builder/erase.md +++ b/src/builder/erase.md @@ -1,10 +1,25 @@ -# Erase +# ![](/img/buildertools/erase.png) Erase -Erase allows removing a box-region (with left click) or 128 connected blocks of the same type (with right click) +Erase allows for removing a cuboid selection, or 128 connected blocks of the same type. -See below for a demonstration of both modes +## Creating Selections + +To create a selection, start by using left-click to select your first corner and then right-click to select the second. You can use middle-click to select faces instead of the corners. This makes it much easier to select blocks that don't already have edges. + +With a selection, you're still able to expand the selection with middle-click. Using left or right-click also works to set a corner again. + +## Confirming Selections + +After you're happy with your selection, use the `del` or `backspace` key on your keyboard to remove the selected area. + +If you're not happy with the result, use `Ctrl + Z` to undo the deletion. If you can't make up your mind, you can use `Ctrl + Y` to redo your undo. + +## Erase Connected + +To remove the nearest 128 blocks of the same type, use right-click while facing at the block you'd like to remove. The use of `Ctrl + Z` and `Ctrl + Y` still applies. + +Below is a demonstration of both methods. - + \ No newline at end of file diff --git a/src/builder/extrude.md b/src/builder/extrude.md index 46bb6fb..dbaf5b5 100644 --- a/src/builder/extrude.md +++ b/src/builder/extrude.md @@ -1,8 +1,12 @@ -# Extrude +# ![](/img/buildertools/extrude.png) Extrude -Extrude expands a flat surfure by 1 block when right-clicking and shrinks a flat surface by 1 block when left-clicking +Extrude is a unique builder tool as it doesn't use a selection. Extrude simply extrudes and shrinks a face of the same block. -See below for a demonstration +To extrude a face, use right-click. To shrink a face, use left-click. + +If you're not happy with the result, use `Ctrl + Z` to undo the placement. If you can't make up your mind, you can use `Ctrl + Y` to redo your undo. + +Below is a video showcasing the extrude tool.