Skip to content

Commit

Permalink
Improve basic documentation, add builder tool documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Moulberry committed Dec 23, 2023
1 parent a20a128 commit 4a72250
Show file tree
Hide file tree
Showing 36 changed files with 250 additions and 92 deletions.
10 changes: 8 additions & 2 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,20 @@
[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)
- [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)
- [Enhanced Flight](capabilities/enhancedflight.md)
- [Editor Mode](editor/intro.md)
- [Main Menu Bar](editor/mainmenubar.md)
- [Clipboard and Placements](editor/clipboardandplacements.md)
Expand Down Expand Up @@ -42,7 +49,6 @@
- [Text](tools/drawing/text.md)
- [Heightmap Tools](tools/heightmap/intro.md)
- [Elevation](tools/heightmap/elevation.md)
- [Flatten](tools/heightmap/flatten.md)
- [Slope](tools/heightmap/slope.md)
- [Manipulation Tools](tools/manipulation/intro.md)
- [Smooth](tools/manipulation/smooth.md)
Expand Down
5 changes: 5 additions & 0 deletions src/builder/clone.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Clone

Clone is similar to [Move](move.md), but it copies the blocks 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
24 changes: 24 additions & 0 deletions src/builder/contextmenu.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Builder 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)

### 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.

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.

### 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.

Documentation for Capabilities can be found [here](/capabilities/intro.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.

> 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.
### 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.
10 changes: 10 additions & 0 deletions src/builder/erase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Erase

Erase allows removing a box-region (with left click) or 128 connected blocks of the same type (with right click)

See below for a demonstration of both modes

<video width="960" height="520" controls autoplay loop>
<source src="/img/EraseTool.mp4" type="video/mp4">
</video>

10 changes: 10 additions & 0 deletions src/builder/extrude.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Extrude

Extrude expands a flat surfure by 1 block when right-clicking and shrinks a flat surface by 1 block when left-clicking

See below for a demonstration

<video width="960" height="520" controls autoplay loop>
<source src="/img/ExtrudeTool.mp4" type="video/mp4">
</video>

40 changes: 15 additions & 25 deletions src/builder/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,24 @@ The Builder Mode is an enhancement of the vanilla Creative mode. It adds several


## Builder Context Menu
The features for builder mode are accessed in the builder context menu. By default, holding down Left Alt opens the menu. The context menu allows you to access the features listed below.
![Alt text](../capabilities/img/Context_Menu.png)
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.

### 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.
![Alt text](<../capabilities/img/Hotbar Swapper-min.gif>)
![Builder Context Menu](/img/AltMenuOverview.png)

This feature aids in organization, allowing you to swap between building materials without needing to open your inventory and move things around.
## 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.

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 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.

### 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.
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)

Documentation for Capabilities can be found [here](/capabilities/intro.md)
![Builder Tools](/img/BuilderToolsOverview.png)

### 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.

> 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.
![Alt text](<../capabilities/img/Gamemode Switchers-min.gif>)
### 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.

![Alt text](<../capabilities/img/Flight Speed.png>)

# Sidebar (right hand)
On your right hand, you have an additional slot for building and editing your projects. To use it, you need to select the 10th slot with the mouse wheel and use Alt+Left to select the mode. For more details, you can find them [LINK].

![Alt text](<../capabilities/img/Sidebar (right hand).png>)
30 changes: 30 additions & 0 deletions src/builder/move.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Move

The move tool allows you to adjust the position of blocks in a cuboid region

## Selecting a region

To select the region, start by pressing Left Click and then Right Click
If you need to select a non-cuboid shape, you can use Middle Click to extend the selection to that point

See below for a step-by-step demonstration. The initial selection is made with a Left & Right click, which is then further refined to include the whole tree using 3 Middle Clicks

<video width="960" height="520" controls autoplay loop>
<source src="/img/BuilderToolSelection.mp4" type="video/mp4">
</video>

## Moving blocks

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

To confirm the movement, press Right Click

To undo/redo the action, use Ctrl+Z/Ctrl+Y

See below for a step-by-step demonstration

<video width="960" height="520" controls autoplay loop>
<source src="/img/MoveTool.mp4" type="video/mp4">
</video>
22 changes: 22 additions & 0 deletions src/builder/setupsymmetry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Setup Symmetry

Setup Symmetry allows you to position and configure a 'symmetry node'. Once the node is set up, you can use the 1-9 hotbar hotkeys to switch back and start placing blocks with symmetry.

## Setup

Begin by placing a node with right click

Add a 'flip modifier' using Ctrl+F

Add a 'rotation modifier' using Ctrl+R

The node can be removed at any time by pressing Delete/Backspace. The node can also be temporarily disabled by simply removing all the flip/rotation modifiers

Multiple modifiers can be used at the same time to achieve more complex symmetry

See below for a demonstration

<video width="960" height="520" controls autoplay loop>
<source src="/img/SymmetryTool.mp4" type="video/mp4">
</video>

20 changes: 20 additions & 0 deletions src/builder/smear.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Smear

Smear blocks in a 3D direction

## Selecting a region
Refer to [Move](move.md)

## Smearing

Scroll in a direction to move the target point

To confirm the smear, use Right Click

To undo/redo the action, use Ctrl+Z/Ctrl+Y

See below for a demonstration

<video width="960" height="520" controls autoplay loop>
<source src="/img/SmearTool.mp4" type="video/mp4">
</video>
23 changes: 23 additions & 0 deletions src/builder/stack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Stack

Stack allows you to copy blocks in a row or grid

## Selecting a region
Refer to [Move](move.md)

## Stacking

Start scrolling in a direction to stack the region end-to-end

Scrolling in another direction will turn it from a 1D stack into a 2D stack, and scrolling in all 3 dimensions will perform a 3D stack

To confirm the stack, use Right Click

To undo/redo the action, use Ctrl+Z/Ctrl+Y

See below for a demonstration

<video width="960" height="520" controls autoplay loop>
<source src="/img/StackTool.mp4" type="video/mp4">
</video>

13 changes: 5 additions & 8 deletions src/capabilities/bulldozer.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
<div style="display: flex; align-items: center;">
<img src="img/Bulldozer_icon.png" alt="Bulldozer Icon" width="35" height="35" style="margin-right: 10px;">
<h1>Bulldozer</h1>
</div>
# Bulldozer

The **Bulldozer** capability allows you to break blocks very quickly after an initial warmup period. In many cases, bulldozer can be faster and more convenient than the alternatives: configuring a left-click macro, breaking blocks slowly by holding left-click, or making a selection and running //set air.
The **Bulldozer** capability allows you to break blocks very quickly after an initial warmup period by simply holding down the left mouse button. The warmup period is intended to prevent accidental mass destruction.

To use Bulldozer, simply start holding down the left mouse button. Your breaking speed will increase after a short warmup period, which is designed to prevent accidental mass destruction when you only intend to break a small number of blocks.
<video width="960" height="520" controls autoplay loop>
<source src="/img/Bulldozer.mp4" type="video/mp4">
</video>

In addition to being more convenient than a left-click macro, the bulldozer capability also has a faster update rate to prevent misses.
![Alt text](<img/Bulldozer_min.gif>)
11 changes: 1 addition & 10 deletions src/capabilities/enhancedflight.md
Original file line number Diff line number Diff line change
@@ -1,10 +1 @@
<div style="display: flex; align-items: center;">
<img src="img/Enhanced_Flight_icon.png" alt="" width="35" height="35" style="margin-right: 10px;">
<h1>Enhanced Flight </h1>
</div>

The **Enhanced Flight** capability changes your normal creative mode flight to a more precise flight without any leftover momentum. It also allows you to move in the direction the camera is facing.

> Some users have mentioned that it took some time to get used to the enhanced flight, but once they did it improved their building experience dramatically. I'd recommend trying out the capability for at least a little bit to see if it suits your building workflow.
![Alt text](<img/Enhanced_Flight_min.gif>)
# Enhanced Flight
16 changes: 9 additions & 7 deletions src/capabilities/forceplace.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
<div style="display: flex; align-items: center;">
<img src="img\Force_Place_icon.png" alt="" width="35" height="35" style="margin-right: 10px;">
<h1>Force Place</h1>
</div>
# Force Place

The **Force Place** capability bypasses normal placement restrictions.

- Blocks which normally need to be attached to solid blocks can be placed in mid air
- Blocks can be placed inside entities (including yourself)
- Plant blocks no longer need to be placed on farmland (or sand/dirt for sugarcane and clay for dripleaf)
- Plant blocks no longer need to be placed on farmland
- Blocks can be placed regardless of light level
- And many more!
- 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
<video width="960" height="520" controls autoplay loop>
<source src="/img/ForcePlace.mp4" type="video/mp4">
</video>

![Alt text](img/Force_Place_min.gif)
17 changes: 13 additions & 4 deletions src/capabilities/intro.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
# Capabilities
This chapter covers Capabilities, toggleable features which can enhance your building workflow.

By default, the **Replace Mode** capability can be toggled using the R keybind. Toggle keybinds for all capabilities can be configured in the vanilla keybinds menu.
The Capabilities that are currently available are:
- [Bulldozer](bulldozer.md) (break blocks fast)
- [Replace Mode](replacemode.md) (replace blocks in the world)
- [Force Place](forceplace.md) (bypass block placement restrictions)
- [No Updates](noupdates.md) (prevent block updates when placing/breaking)
- [Tinker](tinker.md) (various useful interactions when right-clicking with an empty hand)
- Infinite Reach (removes the reach limit)
- Fast Place (place blocks fast)
- Angel Placement (place blocks mid-air)
- No Clip (move through blocks while flying)

<div style="display: flex; align-items: center; justify-content: center;">
<img src="img/Capabilities.png" alt="" width="35" height="35" style="margin-right: 10px;">
</div>
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)
11 changes: 6 additions & 5 deletions src/capabilities/noupdates.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
<div style="display: flex; align-items: center;">
<img src="img\No_Updates_Icon.png" alt="" width="35" height="35" style="margin-right: 10px;">
<h1>No Updates </h1>
</div>
# No Updates

The **No Updates** capability ‘freezes’ blocks and adjacent blocks in their current state and prevents shape and neighbour updates when breaking or placing blocks nearby.

This is useful when working with "non-vanilla" states of stairs/fences/walls/etc. which would normally revert to their vanilla state when breaking/placing blocks near them.
![Alt text](img/No_Updates_min.gif)

<video width="960" height="520" controls autoplay loop>
<source src="/img/NoUpdates.mp4" type="video/mp4">
</video>

26 changes: 19 additions & 7 deletions src/capabilities/replacemode.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
<div style="display: flex; align-items: center;">
<img src="img\Replace_Mode_Icon.png" alt="" width="35" height="35" style="margin-right: 10px;">
<h1>Replace Mode </h1>
</div>
# Replace Mode

The **Replace Mode** capability allows you to right-click to replace the targeted block with the held block. This allows you to easily replace a large amount of blocks by holding the right-mouse button instead of needing to press left+right click for each individual block you want to replace.
The **Replace Mode** capability allows you to right-click to replace the targeted block with the held block. This allows you to easily replace a large amount of blocks by holding the right-mouse button.

Additionally, when you replace a block, the newly placed block will inherit the properties of the old block. This mechanic means that, for example, if you have a copper stair and replace it with an oak stair, the oak stair will be in the exact same orientation and shape as the original copper stair.
![Alt text](img/Replace_Mode_min.gif)
Additionally, when you replace a block, the newly placed block will inherit the properties of the old block.

A basic demonstration of Replace Mode can be found below

<video width="960" height="520" controls autoplay loop>
<source src="/img/ReplaceModeBasic.mp4" type="video/mp4">
</video>

## Type Replace

Type Replace can be toggled on through the Options 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

<video width="960" height="520" controls autoplay loop>
<source src="/img/TypeReplace.mp4" type="video/mp4">
</video>
8 changes: 1 addition & 7 deletions src/capabilities/tinker.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
<div style="display: flex; align-items: center;">
<img src="img\Tinker_Icon.png" alt="" width="35" height="35" style="margin-right: 10px;">
<h1>Tinker</h1>
</div>
# Tinker

The **Tinker** capability has various features related to right-clicking with your fist on blocks. Tinker often can be used in place of the debug stick, being slighty faster compared to the debug stick's clunky interface but sometimes lacking the ability to change some non-visual properties.

Expand Down Expand Up @@ -35,10 +32,7 @@ Tinker interactions can be negated while the capability is toggled on by either
|Any block with 'Age' property |Cycles age |
|Cake |Cycles bites |


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 on a pot with a plant replaces the plant inside the pot

![Alt text](img/Tinker_min.gif)
Loading

0 comments on commit 4a72250

Please sign in to comment.