# These are the Voxel Sniper Commands

## VoxelSniper Default Commands

***

### Reset your Vox

This command is to reset your brush settings

![img.png](https://1963109498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZqDdaVdug36HV1mJDOZ0%2Fuploads%2Fgit-blob-75d317f8955bbae3d694610d041796ad6638281c%2FbrushReset.png?alt=media)

**Usage:** `/d`

**Aliases:** none

**Permissions:**

Primary:

{% hint style="info" %}
When you are new to VoxelSniper, be in the habit of using this after every job, especially if you are doing heavy terraforming where one click can cause a big mess to clean up.
{% endhint %}

***

### VoxelSniper Settings

This command will give you a printout of all of VoxelSniper's current settings, letting you check them over before you pull the trigger.

![img.png](https://1963109498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZqDdaVdug36HV1mJDOZ0%2Fuploads%2Fgit-blob-81f8a348127f4a649eb376fe216efbcf513b7203%2Fvs.png?alt=media)

**Usage:** `/vs`

**Aliases:** `[voxelsniper,favs,fastasyncvoxelsniper]`

**Permissions:**

Primary:

{% hint style="info" %}
Replace and ink information is only displayed on applicable brushes. If you're not seeing them, make sure you are using the proper brush! /vs brushes Brush List. This command returns all of VoxelSniper's brush options.
{% endhint %}

***

### **vs brusheslong**

Brush long-name List. This command will give you the long-name versions of the brushes.

![img.png](https://1963109498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZqDdaVdug36HV1mJDOZ0%2Fuploads%2Fgit-blob-d438bee77cf1c4a0ad5623cb6c5b0e631caaeadf%2FbrushesLong.png?alt=media)

**Usage:** `/vs brusheslong`

**Aliases:** `[voxelsniper brusheslong, fastasyncvoxelsniper brusheslong]`

**Permissions:**

***

### **vs brushes**

Brush short-name List. This command will give you the short-name versions of the brushes.

![img.png](https://1963109498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZqDdaVdug36HV1mJDOZ0%2Fuploads%2Fgit-blob-eb1749866f4ee561ecd80e6631dd8996ff7d17a5%2FbrushesAbbreviated.png?alt=media)

**Usage:** `/vs brushes`

**Aliases:** `[voxelsniper brushes, fastasyncvoxelsniper brushes]`

**Permissions:**

Primary:

***

### **vs perf**

Performer List. This command returns all of VoxelSniper's Performer options in short names.

![img.png](https://1963109498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZqDdaVdug36HV1mJDOZ0%2Fuploads%2Fgit-blob-5f63829313472a21bf114c8f8f3f8979965df92f%2FperfAbbreviated.png?alt=media)

**Usage:** `/vs perf`

**Aliases:** `[voxelsniper perf, fastasyncvoxelsniper perf]`

**Permissions:**

Primary:

***

### **vs perflong**

Performer long-name List. This command will give you the long-name versions of the performers.

![img.png](https://1963109498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZqDdaVdug36HV1mJDOZ0%2Fuploads%2Fgit-blob-61dfd488f05a4e98859b55755844b408aec8abfe%2FperfLong.png?alt=media)

**Usage:** `/vs perflong`

**Aliases:** `[voxelsniper perflong, fastasyncvoxelsniper perflong]`

**Permissions:**

Primary:

## Brush

***

### **/b \[instructions]**

The brush command is the gateway to the VoxelSniper box of world-editing wonders. This command can be as simple as changing the active brush type, its size, or to issue a string of instructions (such as the Erosion Brush's settings). Many brushes behave wildly differently depending on the settings you've loaded into your Sniper's Brush, so make sure you know what variables you are working with before pulling the trigger!

![img.png](https://1963109498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZqDdaVdug36HV1mJDOZ0%2Fuploads%2Fgit-blob-c6c96dae7026e39d2285fb52c48bd38f02869b57%2Fbrush.png?alt=media)

**Usage:** `/b [instructions]`

**Aliases:** None

**Permissions:**

Primary:

{% hint style="info" %}
Each brush has its own in-game manual! To access this, we just ask VoxelSniper for "info" on that particular brush
{% endhint %}

{% hint style="success" %}
`/b b info` - will give you information on the Ball Brush.
{% endhint %}

{% hint style="info" %}
The name of your favorite brushes may have changed from VS4 to VS5, make sure to read the section on Performers below.
{% endhint %}

***

## Performer

You use **/v m** to set the performer for a brush. The m is a placeholder for your blocks or patterns you want to use on a brush. Example below:

![img.png](https://1963109498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZqDdaVdug36HV1mJDOZ0%2Fuploads%2Fgit-blob-53419129d30802887ea2ca067c22870441cca144%2FperformerExample.png?alt=media)

**Aliases:**

**Permissions:**

{% hint style="warning" %}
This part of documentation might be outdated or won't work like explained right now!
{% endhint %}

{% hint style="info" %}
A "plain" ball brush is **/b b m** (the m stands for material)
{% endhint %}

{% hint style="success" %}
An "ink" ball brush is **/b b i** (the i stands for ink)
{% endhint %}

{% hint style="info" %}
Some brushes, such as the erosion brush or the monster brush, do not use Performers as it would not augment their functionality.
{% endhint %}

* To replace a ball of stone with a ball of dirt, use `/b b mm`
  * The first m means that you are only placing a material, just like in the disc examples. Just like before, you'd need to `/v dirt` for this. The second m means that you are only replacing a material - likewise you'd need to `/vr stone` for this.
* To replace a ball of stone with a ball of redwood log, use `/b b cm`
  * The c means that you are placing both a material (`/v log`) and a data (`/vi 1`), the m means that you are replacing just a material(`/vr stone`)
* To rotate a collection of cobblestone stairs and wooden stairs (all with data 2) to face a different direction (data 3) without disturbing that data 10 cloth right next to it, use `/b b ii`
  * The first i indicates that you are placing data (`/vi 3`) and the second i indicates that you are replacing only a specific ink (`/vir 2`)
* To snipe in a still water block, use `/b s mp`
  * The m means that you are placing a material (`/v 9`) and the p means that no-physics will be engaged for erosions. It may help to think of this parameter as half of the overall "brush strength".
* `rf[#]` - The number of recursions the brush will perform for filling.

{% hint style="info" %}
Always start small with recursions, and work your way up if needed! Re-sniping in a different location with a weaker brush can yield a better result than using a stronger brush in fewer locations!
{% endhint %}

* `b[#]` - Brush Size. (example: b23)

{% hint style="info" %}
The ideal sizes for erosion brushes tended to run between 8-20. Larger brushes are far more clumsy and often yield unwanted results.
{% endhint %}

***

## Anatomy of an Instruction Set

Let's take a look at how these variables get the desired effect from the Erosion Brush's "melt" preset. The preset's instructions look like this:

`/b e e2 f5 re1 rf1 b10.`

**Aliases:** none

**Permissions:**

* **e2** - Our brush will be eroding blocks with 2 or more exposed faces. This means that only blocks that are well-embedded within the landscape will be eroded, giving us that "wither" to the landscape we want.
* **f5** - New blocks will only be created if what has been eroded has created a block space with 5 covered faces. This is just to keep things a bit smoother as we melt our landscape away.
* **re1** - This is our brush strength parameter for erosion. The melt brush repeats its erode function in the assigned area once.
* **ref** - This is our brush strength parameter for filling. The melt brush repeats its fill function in the assigned area once.

{% hint style="info" %}
Note how powerful the melt brush is with just _one_ recursion!
{% endhint %}

***

## The Random-Erode Brush

The downside to the normal erosion brush is that, with repeated usage, an area can become too perfectly smooth. The landscape, for example, can look more like melted wax than dirt and stone. This randomized variant produces similar results without generating these inorganic features. On each click, the four erosion parameters are randomized. This brush is also easier to use, as it uses the regular brush size variable.

Usage: `/b re`

**Aliases:**

**Permissions:**

{% hint style="info" %}
The \*_arrow tool_ variant of the brush favors erosion while the **gunpowder tool** version favors fill.
{% endhint %}

**Example with arrow:** ![img.png](https://1963109498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZqDdaVdug36HV1mJDOZ0%2Fuploads%2Fgit-blob-b5fbb8f2fc91cb5876b2a672c9f2b8503f71a74f%2FrandomErodeArrow.png?alt=media)

## **Example with gunpowder:** ![img.png](https://1963109498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZqDdaVdug36HV1mJDOZ0%2Fuploads%2Fgit-blob-6ec0e1aae5ae072be9503d7236ffd6e81352eb98%2FrandomErodeGunpowder.png?alt=media)

## The Overlay / Topsoil Brush

The overlay brush paints over existing landscape.

![img.png](https://1963109498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZqDdaVdug36HV1mJDOZ0%2Fuploads%2Fgit-blob-7b4520aff6d6bbd31a981a0c32440dce053eb310%2FbOverlay.png?alt=media)

Usage: `/b over d[#]:` The Overlay Brush will "spray-paint" the top most blocks in its area to the blocktype set by your "/v" command. This can be used to easily clean up any exposed materials once you are done with the erosion brush, or to create new fill material two link two pieces of landscape together.

Usage: `/b over info:`

![img.png](https://1963109498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZqDdaVdug36HV1mJDOZ0%2Fuploads%2Fgit-blob-d9461c1676ad72c0fc63790ded41125249a8b16e%2FoverlayInfo.png?alt=media)

**Aliases:**

**Permissions:**

{% hint style="info" %}
By default, this brush will only paint over "natural" materials (stone, dirt, gravel, grass, trees, ores, etc)
{% endhint %}

The area to the covered bit by the Overlay Brush is defined by the brush size variable. When using this brush, The arrow tool will "spray down" onto the topmost blocks of the spray zone.

**/b over all** will set the brush to paint over all material types. You can return to "natural" mode with **/b over some**. overlay brush is sprayed near them.

{% hint style="success" %}
**/b over d5 + /v 12 + /b 20 + /b over all** will be a substantial "desert maker" brush that will demolish any structures in its wake using the arrow tool.
{% endhint %}

***

## Splatter Overlay Brush

This brush combines the functions of the Splatter and Overlay Brushes.

![img.png](https://1963109498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZqDdaVdug36HV1mJDOZ0%2Fuploads%2Fgit-blob-26d8e7203b47ff8a0cd079661c9e4dbea4b87e04%2FsplatterOverlay.png?alt=media)

Usage: `/b sover s[#] g[#] r[#]`

**Aliases:**

**Permissions:**

{% hint style="info" %}
What you see through /b sover info:
{% endhint %}

![img.png](https://1963109498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZqDdaVdug36HV1mJDOZ0%2Fuploads%2Fgit-blob-7579bd48d97ce48c8dcc4c2a2e891ac3e01a04ae%2FsplatterOverlayInfo.png?alt=media)

The `/v` Voxel Select value is used to paint in, as an overlay brush would, using the seed (s), growth (g) and recursion (r) of the splatter.

***

## Underlay Brush

The Underlay is essentially the opposite of the Overlay Brush and will paint the ceilings of caves and buildings by your **/v** command. The (d) variable determines the depth of the brush. This will be how high you want the brush to penetrate

![img.png](https://1963109498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZqDdaVdug36HV1mJDOZ0%2Fuploads%2Fgit-blob-6fa1fa5faae367ed380f6895d1100b7634708903%2FunderlayInfo.png?alt=media)

Usage: `/b under d[#]`

**Aliases:**

**Permissions:**

***

## Blend Brushes

This suite of brushes allows the sniper to clean up ragged borders between different types of materials. The brush looks at the neighboring blocks of each block in the brush's area of effect to determine which material is the most common neighbor. If the brush can find a most common neighboring material for a given voxel (this excludes ties), that voxel is changed to better match the surrounding blocks.

The user may choose to either include or exclude air in this search:

By using the **arrow tool**, air is included, so repeated uses of these brushes are likely to act similarly to the melt and smooth presets of the erosion brush.

On the other hand, excluding air (by using the **gunpowder tool** will make repeated uses of the blend brushes act more like the fill preset of the erosion brush.

Additionally, water may also be optionally included or excluded (default).

Blend brushes use standard brush size and several available sized shapes:

![img.png](https://1963109498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZqDdaVdug36HV1mJDOZ0%2Fuploads%2Fgit-blob-38a7ff0c39ec9ea74e1892f95862f15e534fa351%2FblendBall.png?alt=media)

**Usage:**

* `/b bd`: Blend Disc
* `/b bb`: Blend Ball
* `/b bvd`: Blend Voxel Disc
* `/b bv`: Blend Voxel
* `/b bb water`: Blend Ball, toggles water exclusion

**Aliases:**

**Permissions:**

***

## The Drain Brush

The drain brush removes all liquid (water or lava) in a ball shape using the standard brush size variable.

![img.png](https://1963109498-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZqDdaVdug36HV1mJDOZ0%2Fuploads%2Fgit-blob-d4347c5dfc50090b5c290d7698550f5d4ebc9d93%2Fdrain.png?alt=media)

Usage: `/b drain`:

* _/b drain d_: Toggles the shape of the brush to be a disc.
* _/b drain true|false_: Uses either the true sphere algorithm or the normal one.

**Aliases:**

**Permissions:**
