Updated the edit readme and added new image

This readme was very out of date
This commit is contained in:
gentlegiantJGC 2021-06-30 11:01:36 +01:00
parent 02dd75fb7b
commit 6bbd2e0b90
2 changed files with 79 additions and 29 deletions

View File

@ -15,37 +15,89 @@ The controls are customizable in `Options` -> `Controls...`, but the defaults ar
- right `D` - right `D`
- down: `Shift` - down: `Shift`
- up: `Spacebar` - up: `Spacebar`
- toggle camera rotation: Middle click or double right click - camera rotation: `Right mouse button`. Click to toggle, hold to drag.
- select box corner: Left click - Also changes selection mode. Closest non-air block when not rotating. Fixed distance when rotating.
- change mouse select mode: Right click (Select modes are closest non-air block and fixed distance) - select box corner: `Left mouse button`. Click to toggle, hold to drag.
- add new box: `Ctrl` + `Left mouse button`
- deselect: `Ctrl` + `D` - deselect: `Ctrl` + `D`
- deselect all: `Ctrl` + `Shift` + `D` - deselect all: `Ctrl` + `Shift` + `D`
- change select distance: `R` and `F` - change select distance: `R` and `F`
- change fly speed: Scroll - change fly speed: `Scroll wheel`
- inspect block: `Alt` - inspect block: `Alt`
- change projection: `Tab` - change projection: `Tab`
The rest of this guide will refer to the default keys.
## File Panel
In the top right is the file panel which will allow you to do a number of useful things.
- Coordinates: This shows your current coordinates. If clicked on will bring up a dialog to type in coordinates to teleport to.
- Dimension: Select which dimension is active
- Undo: Undo the last change. (`Ctrl` + `Z`)
- Redo: Reapply an undone change. (`Ctrl` + `Y`)
- Save: Save all changes to the world. Any changes in the editor are saved in the editor until the user requests them to be saved to the world. (`Ctrl` + `S`)
- Close: Close the current world.
## Tools ## Tools
On the left should be a bar of buttons which control different things in the editor. At the bottom is a bar of tools. When clicked they will change which tool is active. The tools usually appear on the left.
Dimension: Select which dimension is active ### Select
Undo: Undo the last change. (`Ctrl` + `Z`)
Redo: Reapply an undone change. (`Ctrl` + `Y`) The select tool will allow you to create a selection which you can run operations on.
Save: Save all changes to the world. Any changes in the editor are saved in the editor until the user requests them to be saved to the world. (`Ctrl` + `S`)
Close: Close the current world. When this tool is active you can left click in the renderer to select boxes.
If you press and hold the left mouse button you can drag a selection box between two places.
You can also quick press the left mouse button to start and stop so you do not have to hold the left mouse button.
Amulet is not limited to just one selection box. If you hold `Ctrl` and `Left mouse button` you will be able to add another selection box to the existing selection.
This will allow you to create more complex selections.
Once the selection is created you can resize the selection by clicking on it.
Clicking on a corner or edge will resize the neighbouring faces.
Clicking on a face will resize just that face.
For finer control you can also use the UI on the left to input coordinates of the green and blue edges.
Hovering on one of these entries and moving the scroll wheel will change these inputs or you can use the arrows in the UI.
Another way to change these locations is to use the move buttons at the bottom of the left UI.
To use these, click on the button and use the movement controls (WASD, Shift and Space by default) which will move that point relative to the camera orientation.
`Move Point 1` and `Move Point 2` will move the green and blue points respectively.
`Move Box` will move both points at the same time causing the whole box to move.
#### Copy and Paste
- Select an area and press the copy button in the select tool or (`Ctrl` + `C`) or (`Edit` -> `Copy`)
- Press the paste button in the select tool or (`Ctrl` + `V`) or (`Edit` -> `Paste`) to choose where to paste the selection in the world. See [paste](#paste) for more information.
- It is worth noting here that Amulet is able to have multiple worlds open at the same time and the copied area can be pasted into a different world.
- Our translation system also handles conversion between different world formats so the source and destination worlds do not need to be from the same version or platform.
### Paste
If you have previously copied a selection you paste it into the world (`Ctrl` + `V` or `Edit` > `Paste`) which will bring you to this tool.
You can place the structure down roughly where you want it and use the UI to move it to exactly where you want it.
The UI also allows rotation, scale and mirroring.
Note that blocks with orientation such as stairs will keep the blockstate they had before the rotation making them look weird after the rotation.
### Operations ### Operations
The section below this is the operation section. The operations tool is a place where users can write their own code for use within the editor.
There is a drop down list of operations that come with Amulet and user created operations. The tool consists of a drop down list of the operations and each operation can define what the rest of the UI looks like.
Below that is a button to change the options for the selected operation. This may be grayed out of the plugin does not require options. There are a number of operations that are distributed with Amulet.
As of writing they are:
- Fill: Fill the selected box(es) with the chosen block
- Replace: Replace the chosen block in the selected box(es) with another chosen block
- Set Biome: Set the biome of the selected box(es)
- Waterlog: Waterlog the blocks in the selection. The operation contains more information on usage.
Below that is a button that will run the operation. Some operations may require a selection of the world to run on and the user will be notified if this is the case but not all operations do. #### Fill and Replace
### Fill and Replace
- Select an area of the world you would like the operation to run on. - Select an area of the world you would like the operation to run on.
- Select the operation from the list of operations. - Select the operation from the list of operations.
- Fill: Select the block you wish to fill the area with. - Fill: Select the block you wish to fill the area with.
@ -53,20 +105,18 @@ Below that is a button that will run the operation. Some operations may require
-Run the operation. -Run the operation.
-Undo will undo the changes and save will apply them to the world files. -Undo will undo the changes and save will apply them to the world files.
### Import and Export
### Delete Chunks These tools will allow you to import and export a number of different structure file formats.
- Like with fill and replace select an area and select the operation. This operation will delete all chunks the selection overlaps with even if only partially selected.
- Run the operation and the chunks will be deleted.
- Undo will undo the changes and save will apply them to the world files.
### Clone Currently the supported formats are `.construction`, `.schematic`, `.schem` and `.mcstructure`
- Select an area, select the operation and click run operation.
- The operation screen will change to allow you to pick a destination location.
- Type in the coordinate where you want it to be placed or use middle mouse wheel while hovering on a number.
- Click `Confirm` to paste the selection at the new location or `Cancel` to cancel
### Copy and Paste Note that if you just want to copy between worlds you do not need to export to a file.
- Select an area and press `Ctrl` + `C` to copy (or `Edit` -> `Copy`) You can just copy from one world and without closing Amulet open the second world and paste it in.
- Press `Ctrl` + `V` (or `Edit` -> `Paste`) to choose where to paste the selection in the world. See [clone](#clone) for more information
- It is worth noting here that Amulet is able to have multiple worlds open at the same time and the copied area can be pasted into a different world. ### Chunk
- Our translation system also handles conversion between different world formats so the source and destination worlds do not need to be from the same version or platform.
This tool will allow you to chunk based modifications.
Delete Chunks: The chunks in the selected area will be deleted. The game will recreate them next time you visit them in game.
Delete Unselected Chunks: The chunks that are not in the selected area will be deleted. The game will recreate them next time you visit them in game.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 752 KiB

After

Width:  |  Height:  |  Size: 888 KiB