Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HotFix AxiomDocs 0.1/ AxiomDocs v1.2 #13

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@
- [Replace Mode](capabilities/replacemode.md)
- [Bulldozer](capabilities/bulldozer.md)
- [Enhanced Flight](capabilities/enhancedflight.md)
- [Sidebar](sidebar\intro.md)
- [Clone](sidebar\clone.md)
- [Extrude](sidebar\extrude.md)
- [Move](sidebar\move.md)
- [Smear](sidebar\smear.md)
- [Stack](sidebar\stack.md)
- [Editor Mode](editor/intro.md)
- [Main Menu Bar](editor/mainmenubar.md)
- [Clipboard and Placements](editor/clipboardandplacements.md)
Expand Down
6 changes: 4 additions & 2 deletions src/builder/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ On the right-hand side you can find a slider which allows you to quickly change

![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].
# Builder slot (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 AltLeft to select the mode.

Documentation for Sidebar can be found [here](/src/builderslot\intro.md)

![Alt text](<../capabilities/img/Sidebar (right hand).png>)
7 changes: 7 additions & 0 deletions src/builderslot/clone.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<div style="display: flex; align-items: center;">
<img src="img/Clone.png" alt="Stack Icon" width="35" height="35" style="margin-right: 10px;">
<h1>Clone</h1>
</div>


![Alt text](img/Clone-min.gif)
6 changes: 6 additions & 0 deletions src/builderslot/extrude.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<div style="display: flex; align-items: center;">
<img src="img\Extrude.png" alt="Stack Icon" width="35" height="35" style="margin-right: 10px;">
<h1>Extrude</h1>
</div>

![Alt text](img/Extrude-min.gif)
Binary file added src/builderslot/img/Clone-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/builderslot/img/Clone.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/builderslot/img/Extrude-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/builderslot/img/Extrude.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/builderslot/img/Move 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/builderslot/img/Move-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/builderslot/img/Smear-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/builderslot/img/Smear.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/builderslot/img/Stack-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/builderslot/img/Stack.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/builderslot/img/sidehand.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions src/builderslot/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
##Page in process...
7 changes: 7 additions & 0 deletions src/builderslot/move.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<div style="display: flex; align-items: center;">
<img src="img\Move icon.png" alt="Move Icon" width="35" height="35" style="margin-right: 10px;">
<h1>Stack</h1>
</div>
TEXT

![Alt text](img/Move-min.gif)
6 changes: 6 additions & 0 deletions src/builderslot/smear.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<div style="display: flex; align-items: center;">
<img src="img\Smear.png" alt="Stack Icon" width="35" height="35" style="margin-right: 10px;">
<h1>Smear</h1>
</div>

![Alt text](img/Smear-min.gif)
6 changes: 6 additions & 0 deletions src/builderslot/stack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<div style="display: flex; align-items: center;">
<img src="img\Stack.png" alt="Stack Icon" width="35" height="35" style="margin-right: 10px;">
<h1>Stack</h1>
</div>

![Alt text](img/Stack-min.gif)
Binary file removed src/capabilities/img/Axiom_preview.png
Binary file not shown.
Binary file modified 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.
2 changes: 1 addition & 1 deletion src/capabilities/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ This chapter covers Capabilities, toggleable features which can enhance your bui
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;">
<img src="img/Capabilities.png" alt="Capabilities" width="35" style="margin-right: 10px;">
</div>
4 changes: 4 additions & 0 deletions src/editor/activeblock.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,7 @@ Blocks in the Editor UI can be drag-dropped on different locations to various ef
- Into the main viewport to flood replace the targeted block with the dropped block

The **Active Block** can be quickly set using 'pick block', which is bound to middle-click by default.

<div style="display: flex; align-items: center; justify-content: center;">
<img src="img\Active Block.png" alt="Active Block" style="margin-right: 10px;">
</div>
7 changes: 6 additions & 1 deletion src/editor/blueprints.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Blueprints are a system for saving and loading prefabricated assets. They are si

## Creating a blueprint

A **Blueprint** can be created by having content in your clipboard and pressing Ctrl+P. This brings up the **Create Blueprint** menu. In here you can do a few things, you can name your blueprint, add authors, tags and rotate your blueprint to generate a thumbnail to easily recognize it later.
A **Blueprint** can be created by having content in your clipboard and pressing **Ctrl+P**. This brings up the **Create Blueprint** menu. In here you can do a few things, you can name your blueprint, add authors, tags and rotate your blueprint to generate a thumbnail to easily recognize it later.

Authors, tags and names are all ways by which you can easily look up blueprints later. For example by searching the tag ‘tree’ or ‘structure’ you can find all blueprints that include that tag. There are a couple dozen default tags that Axiom ships with in order to cover a wide array of possible blueprints but if those don’t quite cover your needs you can always create your own tag by clicking the ‘+’, entering the name and clicking the ‘Create Tag’ button inside the ‘Add Tag’ menu.

Expand All @@ -17,3 +17,8 @@ The blueprint files themselves can be sent to others who can then also use them
## Loading blueprints

Once you have Blueprints, you can view them in the **Blueprint Browser**. You'll be able to see thumbnails for all of your blueprints, as well as perform searches or filter by tags. Clicking a blueprint will 'open' it and place the blocks into your [clipboard](blocks_and_clipboard.md#clipboard).


<div style="display: flex; align-items: center; justify-content: center;">
<img src="img\Blueprints.gif" alt="Blueprints" style="margin-right: 10px;">
</div>
4 changes: 4 additions & 0 deletions src/editor/clipboardandplacements.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,7 @@ Placements can be repositioned and rotated using the [Gizmo](gizmos.md).
Once the placement is in the correct position, you can use Enter or Ctrl+V to confirm it. To cancel a placement, use the Delete key.

> Tip: The placement can be rotated clockwise using the Ctrl+R keybind, and can be flipped in the direction of your mouse vector using the Ctrl+F keybind.

<div style="display: flex; align-items: center; justify-content: center;">
<img src="img\Clipboard.png" alt="Clipboard" style="margin-right: 10px;">
</div>
3 changes: 3 additions & 0 deletions src/editor/gizmos.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@ A gizmo can contain the following elements:
- **Center Node** The center node can be clicked and dragged to move the gizmo on all 3 axis. While dragging, the gizmo will maintain the same distance to the camera.
- **Rotation Rings** Some operations like placement or shape placement will add a rotation ring to the Gizmo, allowing you to perform rotations in addition to translations. The rotation ring can be grabbed and drag to rotate the object around that axis.

<div style="display: flex; align-items: center; justify-content: center;">
<img src="img\Gizmos.png" alt="Gizmos" style="margin-right: 10px;">
</div>
5 changes: 5 additions & 0 deletions src/editor/history.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,8 @@
The History window shows you an overview of how many and what operations you just performed. It serves as a visual aid to assist in performing undo (Ctrl+Z) and redo (Ctrl+Y) operations.

> Tip: You can left-click history elements to *rewind* to that point, or right-click to point your camera towards the center of the edit.


<div style="display: flex; align-items: center; justify-content: center;">
<img src="img\History.png" alt="History" style="margin-right: 10px;">
</div>
Binary file added src/editor/img/Active Block.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/editor/img/Blueprints.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/editor/img/Clipboard.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/editor/img/Editor 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/editor/img/Gizmos.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/editor/img/History.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/editor/img/Main Menu Bar.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/editor/img/Target info.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/editor/img/Tool mask.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/editor/img/View.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/editor/img/World Properties Player.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/editor/img/World Properties.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/editor/img/World Proporties Blocks.png
Binary file added src/editor/img/World Proporties Time.png
2 changes: 2 additions & 0 deletions src/editor/intro.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Editor Mode

The Editor Mode includes a large variety of tools and operations for large-scale world manipulation, painting, terraforming and sculpting. The Editor UI has been designed specially for this purpose, combining camera controls from conventional 3D software with powerful tools tailored for Minecraft building. The layout of the Editor UI can be customized by rearranging and docking the windows to your liking.

![Alt text](<img/Editor menu.png>)
2 changes: 2 additions & 0 deletions src/editor/mainmenubar.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Main Menu Bar
The main menu bar gives users access to crucial functionality of the mod. Here you can find menu items for accessing windows, manipulating selections, performing operations and viewing helpful information.

![Alt text](<img/Main Menu Bar.png>)

## Edit

| Function | Default Shortcut | Description |
Expand Down
4 changes: 4 additions & 0 deletions src/editor/targetinfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,7 @@ The window contains:
- The position of that block in the world.
- The biome at that position.
- The distance from your camera to that position.

<div style="display: flex; align-items: center; justify-content: center;">
<img src="img\Target info.png" alt="Target Info" style="margin-right: 10px;">
</div>
4 changes: 4 additions & 0 deletions src/editor/toolmasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,7 @@ The 'Neighbor' condition returns true when any of the six blocks directly adjace
>
> Tools currently incompatible with Masks:
> - Slope Tool

<div style="display: flex; align-items: center; justify-content: center;">
<img src="img\Tool mask.png" alt="Tool mask" style="margin-right: 10px;">
</div>
5 changes: 5 additions & 0 deletions src/editor/views.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,8 @@ A new view can be created in the [View submenu](mainmenubar.md#view) or by click
Views will keep track of your last position and teleport you back to that location when you switch back to the view. If you want to make sure the view stays at the correct location, you can turn on *Pin World* and *Pin Location* options. Pinning the location will make it so that you always teleport back to the pinned spot when you switch to the view.

> Tip: If a location is pinned, you can teleport to the pinned location simply by clicking the view tab again, even if the tab is already selected


<div style="display: flex; align-items: center; justify-content: center;">
<img src="img\View.gif" alt="View" style="margin-right: 10px;">
</div>
15 changes: 15 additions & 0 deletions src/editor/worldproperties.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,16 @@

The **World Properties** window lets you change certain properties and vanilla behavior about the world. This is freely accessed in single player worlds but permissions need to be granted on multiplayer due to the significant impact that these might have for those sharing a world with others. See below for the various world properties you can adjust.

<div style="display: flex; align-items: center; justify-content: center;">
<img src="img\World Properties.png" alt="World Properties" style="margin-right: 10px;">
</div>

## Time

The **Time** submenu lets you change things about the time in the world. You can freeze the time in the world, use the slider for a specific time or use a preconfigured time by pressing the designated buttons.
<div style="display: flex; align-items: center; justify-content: center;">
<img src="img\World Proporties Time.png" alt="World Proporties Time" style="margin-right: 10px;">
</div>

## Player

Expand All @@ -14,6 +21,10 @@ The **Player** submenu lets you adjust properties relating to the player entity:
- **Trample Farmland** Disabling this property prevents farmland from being trampled.
- **Mob Spawning** This property corresponds to the vanilla "doMobSpawning" gamerule.

<div style="display: flex; align-items: center; justify-content: center;">
<img src="img\World Properties Player.png" alt="World Proporties Player" style="margin-right: 10px;">
</div>

## Blocks

The **Blocks** submenu lets you adjust properties relating to blocks in the world
Expand All @@ -22,3 +33,7 @@ The **Blocks** submenu lets you adjust properties relating to blocks in the worl
- **Block Gravity** Disabling this property will prevent gravity-affected blocks like sand and gravel from falling.
- **Fire Tick** This property corresponds to the vanilla "doFireTick" gamerule.
- **Random Tick Speed** is a slider which corresponds to the vanilla "randomTickSpeed" gamerule. Setting this to 0 will disable random ticking.

<div style="display: flex; align-items: center; justify-content: center;">
<img src="img\World Proporties Blocks.png" alt="World Proporties Blocks" style="margin-right: 10px;">
</div>
2 changes: 0 additions & 2 deletions src/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,3 @@ 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
Binary file added src/tools/img/Ruller.png
Binary file added src/tools/img/Tool select.png
2 changes: 2 additions & 0 deletions src/tools/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Axiom presents a rich set of tools for real-time, precise manipulation of your Minecraft world. These tools are readily accessible in the top layer of the 'Tool' window. Additionally, the 'Tool Options' window offers further configuration possibilities. Each tool comes with its unique settings that can dramatically change its functionality and impact. We encourage exploration and experimentation as it can lead to unanticipated yet fascinating or beneficial applications of these tools.

![Alt text](<img/Tool select.png>)

Note: By ctrl clicking on a slider, you can manually input a value that exceeds the default parameter limits. Use this feature with caution.

## Brushes
Expand Down
1 change: 1 addition & 0 deletions src/tools/ruler.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ The **Ruler** Tool is designed to measure the distance between two or more point

When you check the tool options, you'll find more information about these points. What's shown depends on whether you've chosen two or more points.

![Alt text](img/Ruller.png)
Here's the information you'll see:

- Total Length (Euclidean): This is the straight-line distance from the first point to the last one, as if a bird flew directly there, not caring about the blocks in between.
Expand Down