Merge pull request #28 from WILLATRONIX/master

4.0.0 - Final PR
Moulberry · Oct 16, 2024 · fffd71c · fffd71c
2 parents ceb339b + 0277d93
commit fffd71c
Show file tree

Hide file tree

Showing 86 changed files with 643 additions and 376 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1 @@
-.vscode/
+*.vscode*
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -3,23 +3,24 @@
 [Introduction](intro.md)
 
 - [Builder Mode](builder/intro.md)
-    - [Context Menu](builder/contextmenu.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)
-    - [Display Entities](builder/displayentities.md)
+    - [Builder Tools](builder/buildertools/intro.md)
+        - [Move](builder/buildertools/move.md)
+        - [Clone](builder/buildertools/clone.md)
+        - [Stack](builder/buildertools/stack.md)
+        - [Smear](builder/buildertools/smear.md)
+        - [Extrude](builder/buildertools/extrude.md)
+        - [Erase](builder/buildertools/erase.md)
+        - [Setup Symmetry](builder/buildertools/setupsymmetry.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)
-    - [Force Place](capabilities/forceplace.md)
-    - [Replace Mode](capabilities/replacemode.md)
-    - [Bulldozer](capabilities/bulldozer.md)
+- [Context Menu](contextmenu/intro.md)
+    - [Capabilities](contextmenu/capabilitiesintro.md)
+        - [Tinker](contextmenu/capabilitiestinker.md)
+        - [No Updates](contextmenu/capabilitiesnoupdates.md)
+        - [Force Place](contextmenu/capabilitiesforceplace.md)
+        - [Replace Mode](contextmenu/capabilitiesreplacemode.md)
+        - [Bulldozer](contextmenu/capabilitiesbulldozer.md)
+    - [Display Entities](contextmenu/displayentities.md)
+    - [Edit Block Attributes](contextmenu/blockattributes.md)
 - [Editor Mode](editor/intro.md)
     - [Selections](editor/selections.md)
     - [Gizmos](editor/gizmos.md)
@@ -50,12 +51,12 @@
         - [Freehand Select](tools/selection/freehandselect.md)
         - [Lasso Select](tools/selection/lasso.md)
     - [Utility Tools](tools/utility/intro.md)
-        - [Ruler Tool](tools/utility/ruler.md)
+        - [Ruler](tools/utility/ruler.md)
+        - [Annotation](tools/utility/annotator.md)
     - [Painting Tools](tools/painting/intro.md)
         - [Painter](tools/painting/painter.md)
         - [Noise Painter](tools/painting/noisepainter.md)
         - [Biome Painter](tools/painting/biomepainter.md)
-        - [Clentaminator](tools/painting/clentaminator.md)
         - [Script Brush](tools/painting/scriptbrush.md)
         - [Gradient Painter](tools/painting/gradientpainter.md)
     - [Drawing Tools](tools/drawing/intro.md)
@@ -67,7 +68,7 @@
         - [Stamp](tools/drawing/stamp.md)
         - [Text](tools/drawing/text.md)
         - [Shape](tools/drawing/shape.md)
-        - [Path Tool](tools/other/path.md)
+        - [Path](tools/drawing/path.md)
     - [Fluid Tools](tools/fluid/intro.md)
         - [Floodfill](tools/fluid/floodfill.md)
         - [Fluid Ball](tools/fluid/fluidball.md)

diff --git a/src/advanced/configuration.md b/src/advanced/configuration.md
@@ -15,7 +15,7 @@ Below are the three files alongside their descriptions.
 | completedTutorials             | Lists the tools that have shown their short tutorial.                                  |
 | customDowngradeSuggestions     | Lists the downgrades suggested by Axiom.                                               |
 | defaultLayout                  | Stores the UI data for the currently enabled UI layout.                                |
-| globalScale                    | A float representing the [Editor](editor/intro.md) UI Scale.                           |
+| 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.                                         |
@@ -27,14 +27,14 @@ Below are the three files alongside their descriptions.
 
 ### `.axiom.hocon`
 
-| Key             | Description                                                                                                                                                                       |
-| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| 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.                                                                                                    |
-| 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).                                                                     |
+| Key             | Description                                                                                                                                                                          |
+| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| blockAttributes | Contains the currently toggled [Block Attributes](/contextmenu/blockattributes.md).                                                                                                  |
+| blueprint       | Stores the toggle to automatically refresh, a custom blueprint path and the 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](/contextmenu/intro.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](/contextmenu/intro.md) alongside the option to show [annotations](/tools/utility/annotation.md). |
 
 
 ### `imgui.ini`

diff --git a/src/builder/clone.md → src/builder/buildertools/clone.md b/src/builder/clone.md → src/builder/buildertools/clone.md
@@ -1,4 +1,4 @@
-# ![](/img/buildertools/clone.png) Clone 
+# Clone 
 
 The clone tool allows you to copy a cuboid area and paste it elsewhere multiple times. 
 

diff --git a/src/builder/erase.md → src/builder/buildertools/erase.md b/src/builder/erase.md → src/builder/buildertools/erase.md
@@ -1,4 +1,4 @@
-# ![](/img/buildertools/erase.png) Erase 
+# Erase 
 
 Erase allows for removing a cuboid selection, or 128 connected blocks of the same type.
 

diff --git a/src/builder/extrude.md → src/builder/buildertools/extrude.md b/src/builder/extrude.md → src/builder/buildertools/extrude.md
@@ -1,4 +1,4 @@
-# ![](/img/buildertools/extrude.png) Extrude
+# Extrude
 
 Extrude is a unique builder tool as it doesn't use a selection. Extrude simply extrudes and shrinks a face of the same block.
 

diff --git a/src/builder/buildertools/intro.md b/src/builder/buildertools/intro.md
@@ -0,0 +1,19 @@
+# Builder Tools
+
+The tools that are currently available in this section are:
+
+- [Move](move.md)
+- [Clone](clone.md)
+- [Stack](stack.md)
+- [Smear](smear.md)
+- [Extrude](extrude.md)
+- [Erase](erase.md)
+- [Setup Symmetry](setupsymmetry.md)
+
+There are two flags that apply to most Builder Tools:
+- **Copy Entities**
+  - Toggles the ability to copy entities when moving a selection.
+- **Copy Air**
+  - Toggles the ability to copy air when moving a selection.
+
+![Builder Tools](/src/img/BuilderToolsOverview.png)
diff --git a/src/builder/move.md → src/builder/buildertools/move.md b/src/builder/move.md → src/builder/buildertools/move.md
@@ -1,4 +1,4 @@
-# ![](/img/buildertools/move.png) Move 
+# Move 
 
 The move tool allows you to alter the position of blocks and entities within a cuboid area.
 

diff --git a/src/builder/setupsymmetry.md → src/builder/buildertools/setupsymmetry.md b/src/builder/setupsymmetry.md → src/builder/buildertools/setupsymmetry.md
@@ -1,4 +1,4 @@
-# ![](/img/buildertools/setupSymmetry.png) Setup Symmetry
+# Setup Symmetry
 
 Setup Symmetry allows you to position and configure a 'symmetry node'. Once the node is set, you can start placing blocks with symmetry.
 

diff --git a/src/builder/smear.md → src/builder/buildertools/smear.md b/src/builder/smear.md → src/builder/buildertools/smear.md
@@ -1,4 +1,4 @@
-# ![](/img/buildertools/smear.png) Smear
+# Smear
 
 Stretches blocks between two points.
 

diff --git a/src/builder/stack.md → src/builder/buildertools/stack.md b/src/builder/stack.md → src/builder/buildertools/stack.md
@@ -1,4 +1,4 @@
-# ![](/img/buildertools/stack.png) Stack
+# Stack
 
 Stack allows you to copy blocks and entities in a row or grid pattern.
 

diff --git a/src/builder/intro.md b/src/builder/intro.md
@@ -1,13 +1,15 @@
 # Builder Mode
-The Builder Mode is an enhancement of the vanilla Creative mode. It adds several new features that take a lot of the pain away from traditional building and make everything just a bit easier.
 
+The Builder Mode is an enhancement of the vanilla Creative mode. It adds several new features that take a lot of the pain away from traditional building and make everything just a bit easier.
 
 ## 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](/contextmenu/intro.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 unwieldy.
 
 To start using a Builder Tool, scroll to the 10th slot or press 0.
@@ -17,19 +19,8 @@ The three main keybinds for the Builder Tools are left-click, right-click and mi
 
 When working with a selection, useful information such as offset and size is displayed above the hotbar.
 
-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)
-
-There are two flags that apply to all builder tools:
-- **Copy Air**
-  - Toggles the ability to copy air when moving a selection.
-- **Copy Entities**
-  - Toggles the ability to copy entities when moving a selection.
-
-![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.
diff --git a/src/builder/marker.md b/src/builder/marker.md
@@ -1,13 +1,13 @@
 # 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.
 
 Using `Ctrl+C` while the gizmo is active, will copy the marker data to the clipboard. Using `Ctrl+V` will paste the copied marker into the world. 
 
+> Marker entities cannot be spawned using axiom.
+
 ## Notes
 
 [^note1]: [Display Entities Wiki](https://minecraft.wiki/w/Marker).
diff --git a/src/capabilities/enhancedflight.md b/src/capabilities/enhancedflight.md
diff --git a/src/capabilities/img/Axiom_preview.png b/src/capabilities/img/Axiom_preview.png
diff --git a/src/capabilities/img/Bulldozer_icon.png b/src/capabilities/img/Bulldozer_icon.png
diff --git a/src/capabilities/img/Bulldozer_min.gif b/src/capabilities/img/Bulldozer_min.gif
diff --git a/src/capabilities/img/Capabilities.png b/src/capabilities/img/Capabilities.png
diff --git a/src/capabilities/img/Context_Menu.png b/src/capabilities/img/Context_Menu.png
diff --git a/src/capabilities/img/Enhanced_Flight_icon.png b/src/capabilities/img/Enhanced_Flight_icon.png
diff --git a/src/capabilities/img/Enhanced_Flight_min.gif b/src/capabilities/img/Enhanced_Flight_min.gif
diff --git a/src/capabilities/img/Flight Speed.png b/src/capabilities/img/Flight Speed.png
diff --git a/src/capabilities/img/Force_Place_icon.png b/src/capabilities/img/Force_Place_icon.png
diff --git a/src/capabilities/img/Force_Place_min.gif b/src/capabilities/img/Force_Place_min.gif
diff --git a/src/capabilities/img/Gamemode Switchers-min.gif b/src/capabilities/img/Gamemode Switchers-min.gif
diff --git a/src/capabilities/img/Hotbar Swapper-min.gif b/src/capabilities/img/Hotbar Swapper-min.gif
diff --git a/src/capabilities/img/Infinite_reach_icon.png b/src/capabilities/img/Infinite_reach_icon.png
diff --git a/src/capabilities/img/Infinite_reach_min.gif b/src/capabilities/img/Infinite_reach_min.gif
diff --git a/src/capabilities/img/No_Updates_Icon.png b/src/capabilities/img/No_Updates_Icon.png
diff --git a/src/capabilities/img/No_Updates_min.gif b/src/capabilities/img/No_Updates_min.gif
diff --git a/src/capabilities/img/Replace_Mode_Icon.png b/src/capabilities/img/Replace_Mode_Icon.png
diff --git a/src/capabilities/img/Replace_Mode_min.gif b/src/capabilities/img/Replace_Mode_min.gif
diff --git a/src/capabilities/img/Sidebar (right hand).png b/src/capabilities/img/Sidebar (right hand).png
diff --git a/src/capabilities/img/Tinker_Icon.png b/src/capabilities/img/Tinker_Icon.png
diff --git a/src/capabilities/img/Tinker_min.gif b/src/capabilities/img/Tinker_min.gif
diff --git a/src/capabilities/intro.md b/src/capabilities/intro.md
diff --git a/src/builder/blockattributes.md → src/contextmenu/blockattributes.md b/src/builder/blockattributes.md → src/contextmenu/blockattributes.md
@@ -5,14 +5,8 @@ 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 barriers or fences.   |
-| 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.                                          |
+| Show Light Blocks            | Adds a light block texture for all light blocks and enables interactions with them.                |
+| Show Structure Void Blocks   | Adds a structure void texture for all 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. |
-
-## Notes
-
-[^note1]: ![Light Block Texture](/img/light_block_15.png)
-
-[^note2]: ![Structure Void Texture](/img/structure_void.png)
diff --git a/src/capabilities/bulldozer.md → src/contextmenu/capabilities/bulldozer.md b/src/capabilities/bulldozer.md → src/contextmenu/capabilities/bulldozer.md
diff --git a/src/capabilities/forceplace.md → src/contextmenu/capabilities/forceplace.md b/src/capabilities/forceplace.md → src/contextmenu/capabilities/forceplace.md
@@ -8,7 +8,7 @@ The **Force Place** capability bypasses normal placement restrictions.
 - Blocks can be placed regardless of light level
 - And much more!
 
-> Force Place is best used in combination with [No Updates](noupdates.md) in order to ensure illegally placed blocks don't break when updated. You may also need to disable random updates with /gamerule randomTickSpeed 0
+> Tip: Force Place is best used in combination with [No Updates](noupdates.md) in order to ensure illegally placed blocks don't break when updated. You may also need to disable random updates with /gamerule randomTickSpeed 0.
 
 <video width="960" height="520" controls autoplay loop>
     <source src="/img/ForcePlace.mp4" type="video/mp4">

diff --git a/src/contextmenu/capabilities/intro.md b/src/contextmenu/capabilities/intro.md
@@ -0,0 +1,26 @@
+# Capabilities
+
+Capabilities alter the way you interact with the world.
+
+- [Bulldozer](bulldozer.md) 
+  - Ability to break blocks faster than normal.
+- [Replace Mode](replacemode.md) 
+  - Replace the block you're looking at with the one in your hand.
+- [Force Place](forceplace.md) 
+  - Bypasses block placement restrictions.
+- [No Updates](noupdates.md) 
+  - Prevents surrounding blocks from updating when placing or breaking blocks.
+- [Tinker](tinker.md) 
+  - Ability to modify the block properties when using right-click and an empty hand.
+- Infinite Reach 
+  - Allows for placing and breaking blocks from any distance.
+- Fast Place 
+  - Removes the placement cooldown when placing blocks off different supporting blocks.
+- Angel Placement 
+  - Allows the player to place blocks in the air, removing the requirement of a supporting block.
+- No Clip 
+  - Disables player collision with solid blocks, allowing you to fly through them.
+
+Capabilities can be toggled using the left side of the [Context Menu](/contextmenu/intro.md)
+
+Additionally, keybinds can be associated with capabilities to quickly toggle them. By default, the [Replace Mode](/contextmenu/capabilitiesreplacemode.md) has the keybind: `R`, but more can be added in the Minecraft controls menu.
diff --git a/src/capabilities/noupdates.md → src/contextmenu/capabilities/noupdates.md b/src/capabilities/noupdates.md → src/contextmenu/capabilities/noupdates.md
diff --git a/src/capabilities/replacemode.md → src/contextmenu/capabilities/replacemode.md b/src/capabilities/replacemode.md → src/contextmenu/capabilities/replacemode.md
@@ -12,7 +12,7 @@ A basic demonstration of Replace Mode can be found below
 
 ## Type Replace
 
-Type Replace can be toggled on through the [Options Toolbox](/builder/contextmenu.md#Toolbox) in the Alt Menu. Turning this on allows you to hold a base material block (eg. Spruce Planks) to replace stairs/slabs/walls/fences/etc. with their spruce variant
+Type Replace can be toggled on through the [Options Toolbox](/contextmenu/intro.md#Toolbox) in the Alt Menu. Turning this on allows you to hold a base material block (eg. Spruce Planks) to replace stairs/slabs/walls/fences/etc. with their spruce variant
 
 A demonstration of Type Replace can be found below
 

diff --git a/src/capabilities/tinker.md → src/contextmenu/capabilities/tinker.md b/src/capabilities/tinker.md → src/contextmenu/capabilities/tinker.md