Merge pull request #21 from WILLATRONIX/master

added / updated: modify, masks, script brush, shape, configuration, commands
Moulberry · May 25, 2024 · 00242f0 · 00242f0
2 parents 3b9b5d4 + 6fdd848
commit 00242f0
Show file tree

Hide file tree

Showing 9 changed files with 304 additions and 66 deletions.
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -59,6 +59,9 @@
         - [Roughen](tools/manipulation/roughen.md)
         - [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)
-
+- [Advanced](advanced/intro.md)
+    - [Commands](advanced/commands.md)
+    - [Config](advanced/configuration.md)
diff --git a/src/advanced/commands.md b/src/advanced/commands.md
@@ -0,0 +1,31 @@
+# Commands
+
+Commands are essential for management and debugging.
+
+### /axiomdocs
+
+- This command provides a link to this documentation.
+
+### /axiomenablecheats
+
+- Forces the world to have cheats enabled, even if they are disabled.
+
+### /axiomhandshake
+
+- Tests the connection by emulating a player join on a server.
+
+### /axiomintro
+
+- Displays the introduction shown when first using the mod.
+
+### /axiomtogglecapability
+
+- Target a capability and toggle it.
+
+### /whynoaxiom
+
+- Returns Axiom's status and information on how to resolve issues.
+
+## Compatible commands
+
+`//pos1` and `//pos2` are part of Axiom, but are intended to be used alongside WorldEdit.
diff --git a/src/advanced/configuration.md b/src/advanced/configuration.md
@@ -0,0 +1,41 @@
+# Configuration
+
+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 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).
+
+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.   |
+
+### `.axiom.hocon`
+
+| Key             | Description                                                                                                                                                                       |
+| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 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). |
+| 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).                                                                     |
+
+
+### `imgui.ini`
+
+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.
diff --git a/src/advanced/intro.md b/src/advanced/intro.md
@@ -0,0 +1,3 @@
+# Advanced
+
+The advanced section covers some of the niche but good-to-know bits of information such as commands and configurations. This can be especially helpful for debugging issues.
diff --git a/src/editor/mainmenubar.md b/src/editor/mainmenubar.md
@@ -9,7 +9,7 @@ The main menu bar gives users access to crucial functionality of the mod. Here y
 | 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[^note3] format. |
+| 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
@@ -43,11 +43,11 @@ The View submenu lets you configure options related to viewing and rendering cer
 |----------------|------------------|-------------|
 | New View       | None             | Create a new [View](views.html) |
 | Show Selection | None             | Lets you toggle the rendering of your selections |
-| Show Biomes    | Ctrl+B           | Enables the biome overlay[^note1] |
+| Show Biomes    | Ctrl+B           | Enables the biome overlay[^note2] |
 | Show Key Presses| None            | This shows your inputs including mouse clicks on the bottom right of the viewport. This can be useful for making tutorials. |
 | UI Scale       | None             | A slider ranging from 0.5 to 2. This lets you change the size of all graphical elements in the editor mode. |
 | Min Brightness | None             | A slider ranging from 0 to 1. This lets you change how dark unlit places look in your world. A value of 1 means all blocks are fully lit, this is also known as Fullbright. |
-| Fluid Opacity  | None             | A slider ranging from 0 to 1. This lets you change the opacity of transluscent[^note2] fluids to make it easier to look through. A value of 0 will make the fluid invisible. |
+| Fluid Opacity  | None             | A slider ranging from 0 to 1. This lets you change the opacity of transluscent[^note3] fluids to make it easier to look through. A value of 0 will make the fluid invisible. |
 
 ## Operations
 
@@ -89,10 +89,11 @@ 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. 
 
-[^note1]: Be aware that biomes in Minecraft are defined in a 4x4x4 grid. However, to make biomes feel more natural, vanilla warps the biomes visually. The biome overlay shows the "real" position of biomes, while biome blending and the f3 screen show the "warped" position of biomes.
-
-[^note2]: Lava and other non-translucent fluids (if the game is modded) are not affected by opacity due to performance and mod compatibility concerns.
+## References
+[^note1]: comma-separated values (CSV) is a plaintext format that uses commas to separate values in a table-like manner.
 
-[^note3]: comma-separated values (CSV) is a plaintext format that uses commas to separate values in a table-like manner.
+[^note2]: Be aware that biomes in Minecraft are defined in a 4x4x4 grid. However, to make biomes feel more natural, vanilla warps the biomes visually. The biome overlay shows the "real" position of biomes, while biome blending and the f3 screen show the "warped" position of biomes.
+
+[^note3]: Lava and other non-translucent fluids (if the game is modded) are not affected by opacity due to performance and mod compatibility concerns.
 
 [^note4]: [CIELAB](https://en.wikipedia.org/wiki/CIELAB_color_space) is a type of colour space that can utilise the XYZ coordinates to display colours.