Skip to content

Commit

Permalink
Merge pull request #10 from MrZlre/master
Browse files Browse the repository at this point in the history
Axiom Docs v.1.1
  • Loading branch information
Moulberry authored Sep 20, 2023
2 parents 21f7d18 + 776b4c2 commit 8f6158f
Show file tree
Hide file tree
Showing 30 changed files with 56 additions and 8 deletions.
12 changes: 11 additions & 1 deletion src/builder/intro.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# 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.


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

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

This feature aids in organization, allowing you to swap between building materials without needing to open your inventory and move things around.

Expand All @@ -22,5 +24,13 @@ Above the hotbar swappers are 3 buttons for quickly swapping to other gamemodes.

> 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>)
9 changes: 7 additions & 2 deletions src/capabilities/bulldozer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# Bulldozer
The **Bulldozer** capability allows 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.
<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>

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.

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.

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>)
8 changes: 7 additions & 1 deletion src/capabilities/enhancedflight.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# Enhanced Flight
<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>)
8 changes: 7 additions & 1 deletion src/capabilities/forceplace.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# Force Place
<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>

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)
- Blocks can be placed regardless of light level
- And many more!

![Alt text](img/Force_Place_min.gif)
Binary file added src/capabilities/img/Axiom_preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Bulldozer_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Bulldozer_min.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Capabilities.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Context_Menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Enhanced_Flight_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Enhanced_Flight_min.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Flight Speed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Force_Place_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Force_Place_min.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Gamemode Switchers-min.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Hotbar Swapper-min.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Infinite_reach_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Infinite_reach_min.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/No_Updates_Icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/No_Updates_min.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Replace_Mode_Icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Replace_Mode_min.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Sidebar (right hand).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Tinker_Icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/capabilities/img/Tinker_min.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions src/capabilities/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@
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.

<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>
7 changes: 6 additions & 1 deletion src/capabilities/noupdates.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# No Updates
<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>

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)
7 changes: 6 additions & 1 deletion src/capabilities/replacemode.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# Replace Mode
<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>

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.

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)
7 changes: 6 additions & 1 deletion src/capabilities/tinker.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Tinker
<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>

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.

Aiming at specific parts of a block can change the effect of the tinker. This lets you quickly change full blocks into stairs, stairs into slabs and vice versa. It also lets you easily adjust walls/fences to create states that Minecraft normally doesn’t allow.
Expand Down Expand Up @@ -37,3 +41,4 @@ Additionally:
- 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)
2 changes: 2 additions & 0 deletions src/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ Welcome to the Axiom Documentation, an introductory book about the all-in-one to

## Who Axiom Is For
Axiom is intended for everyone from novice to professional. The tools are intuitive and easy to approach, while still providing lots of depth through settings for experienced users.
![Alt text](capabilities/img/Axiom_preview.png)
© ThePossibilitiesOf

0 comments on commit 8f6158f

Please sign in to comment.