Skip to content

Commit

Permalink
Merge pull request #24 from WILLATRONIX/master
Browse files Browse the repository at this point in the history
3.1.0
  • Loading branch information
Moulberry committed Jun 20, 2024
2 parents 9f32d9e + 3cf504d commit 90b9012
Show file tree
Hide file tree
Showing 26 changed files with 477 additions and 208 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.vscode/
4 changes: 3 additions & 1 deletion src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,10 @@
- [Selections](editor/selections.md)
- [Gizmos](editor/gizmos.md)
- [Tool Presets](editor/toolpresets.md)
- [Placements](editor/placement.md)
- [Common UI Elements](editor/commonUIelements.md)
- [Windows](editor/windows/intro.md)
- [Clipboard](editor/clipboard.md)
- [Clipboard](editor/windows/clipboard.md)
- [Views](editor/windows/views.md)
- [Blueprints](editor/windows/blueprints.md)
- [Active Block](editor/windows/activeblock.md)
Expand Down
2 changes: 1 addition & 1 deletion src/advanced/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ These are some extra commands for controlling the world and its properties. Thes

## Compatible commands

`//pos1` and `//pos2` are part of Axiom, but are intended to be used alongside WorldEdit. They expand the provided corner point to the player's position.
`//pos1` and `//pos2` can be used in conjunction with WorldEdit. Using these commands will cause Axiom to render a box to visualise your selection.
1 change: 1 addition & 0 deletions src/advanced/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,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. |
| lastTranslationCount | A value determining the amount of translations. |
| openEditorWindowTypes | A list of open windows in the editor. |
Expand Down
35 changes: 15 additions & 20 deletions src/builder/displayentities.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The tables below cover the settings for the **Create Display** Entity menu.
| 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 colour fomat for the background colour is ARGB in Hexadecimal. |
| Background Color | The background colour determines the colour surrounding the text. The colour fomat for the background colour is ARGB in Hexadecimal. |
| 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. |
Expand All @@ -42,28 +42,23 @@ The **Additional Settings** submenu provides further options for the display ent
## 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.
Left-clicking the white node at the centre of the Display Entity will display a [Gizmo](/editor/gizmos.md). Using the gizmo, you can move, rotate and scale the Display Entity in any direction.

## 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. |
There are many key combinations that can be used while the gizmo is active. 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. |
| Middle-Click | Copies the Display Entity to an item. This works the same as spawn eggs and can be snapped to different rotation steps by using control or shift while placing. |

## Editing Menu

Expand Down
17 changes: 7 additions & 10 deletions src/builder/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Many features for builder mode can be toggled or accessed through the Context Me
![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 unwieldy.

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.
Expand All @@ -17,8 +17,6 @@ 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.

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)
Expand All @@ -28,11 +26,10 @@ The tools that are currently available in this section are:
- [Erase](/builder/erase.md)
- [Setup Symmetry](/builder/setupsymmetry.md)

![Builder Tools](/img/BuilderToolsOverview.png)

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.

## 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.
![Builder Tools](/img/BuilderToolsOverview.png)
2 changes: 2 additions & 0 deletions src/builder/marker.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

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.

## Notes

[^note1]: [Display Entities Wiki](https://minecraft.wiki/w/Marker).
6 changes: 6 additions & 0 deletions src/capabilities/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,9 @@ The Capabilities that are currently available are:
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)

## 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.
74 changes: 43 additions & 31 deletions src/capabilities/tinker.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,37 +6,49 @@ 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 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 |
| Block | Tinker Property Effect |
| --------------------------------- | ------------------------------------------------------- |
| Walls | Cycle `axis` and cycle `none`, `low`, `tall` |
| Fences | Cycle `axis` |
| Chorus Plant | Cycle `axis` and toggle `up` / `down` |
| Iron Bars | Cycle `axis` |
| Piston | Cycle `facing` and switches `Extended` / `Retracted` |
| Furnace | Cycle `facing` and toggle `lit` |
| Carved Pumpkin/Jack o'Lantern | Cycle `facing` and switches `Carved` / `Jack o'Lantern` |
| Barrel | Cycle `facing` |
| Iron Trapdoor/Door | Cycle `open` |
| Brewing Stand | Cycle `bottles` |
| Glazed Terracotta | Cycle `facing` |
| Farmland | Cycle `moisture` |
| Scaffolding | Toggle `bottom` |
| Amethyst Cluster | Cycles `stages` |
| Lectern | Toggles `book` |
| Cave Vines | Toggles `berries` |
| Bamboo Stalk | Toggles `leaves` |
| Cauldron | Cycles `fluid level` |
| Composter | Cycles `compost level` |
| Beehive | Cycles `honey level` |
| Cake | Cycles `bites` |
| Lantern | Toggles `hanging` |
| Fence Gate | Toggles `lowered` and cycles `facing` |
| Player Head | Cycles `rotation` |
| Banner | Cycles `rotation` |
| Attached Melon/Pumpkin Stem | Cycles `facing` |
| Rails | Cycles `rotation` |
| Bell | Cycles `facing` |
| Bamboo Block | Cycle `facing` and toggles `stripped` |
| Chest | Cycle facing |
| End Portal Frame | Cycle `facing` and toggles `eye` |
| Observer | Cycle `facing` and toggle `powered` |
| Snow | Cycle layer |
| Turtle Egg | Cycle eggs |
| Suspicious Sand/Gravel | Switch `Suspicious Sand` and `Suspicious Gravel` |
| Grass Block / Dirt Path | Switch `Grass Block` and `Dirt Path` |
| Azalea | Switch `flowering` |
| Water / Lave | Cycle `level` |
| Any block with 'age' property | Cycles `age` |
| Any block with 'lit' property | Toggles `lit` |
| Any block with 'powered' property | Toggles `powered` |


Additionally:
Expand Down
Loading

0 comments on commit 90b9012

Please sign in to comment.