Skip to content

Commit

Permalink
Changed the README to be less messy.
Browse files Browse the repository at this point in the history
  • Loading branch information
Sandertv committed Feb 25, 2017
1 parent f53fd66 commit a0a2d08
Showing 1 changed file with 2 additions and 56 deletions.
58 changes: 2 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# BlockSniper<a href="https://github.com/Sandertv/BlockSniper"><img src="https://github.com/Sandertv/BlockSniper/blob/master/resources/BlockSniperLogo.png" width="60" height="60" align="right"></a>
An innovative world editing tool, made for PocketMine-MP: An MCPE server software written in PHP. Worlds can be easily edited using a Golden Carrot, which is used as brush.
An innovative world editing tool, made for PocketMine-MP: An MCPE server software written in PHP. Worlds can be easily edited using a Golden Carrot, which is used as brush. Find more information about BlockSniper and on how to use it at the [Wiki](https://github.com/Sandertv/BlockSniper/wiki).

> Third party versions, forks or spoons of PocketMine are **not** supported.
>
Expand All @@ -19,66 +19,12 @@ BlockSniper is an advanced world editing tool, based on the idea of VoxelSniper
BlockSniper allows you to edit your world on a long range, with several different types and shapes. Shapes are the shapes types are being executed in. This means that every type can be executed in any shape.
**For more information, make sure to check the [Wiki](https://github.com/Sandertv/BlockSniper/wiki).**

>> Shapes
>
> Cube > Selects a cube area around the target block.
>
> Sphere > Selects a sphere area around the target block.
>
> Cylinder (standing) > Selects a *standing* cylinder are around the target block.
>
> Cuboid > Selects a cuboid area around the target block.
>
>> Types
>
> Fill > Basic type, fills up the whole shape with blocks.
>
> Overlay > Lays a layer of blocks over other blocks.
>
> Layer > Creates a thin layer of blocks on top of the target block.
>
> Replace > Replaces a block for other blocks.
>
> Leafblower > Blows away all nearby plants.
>
> Clean > Cleans up the landscape, only leaving behind ground.
>
> Drain > Drains all liquid blocks.
>
> Flatten > Flattens the area around the selected block.
>
> More coming soon!
>
>> Clone types
>
> Template > Saves the selected clone in a sharable file.
>
> Copy > Virtually saves the selected area to paste later.
## Translation
BlockSniper has a multi-language system, so everybody can have a good time using the plugin. We currently have nowhere near enough translated languages though, and we need your help! It is very appreciated if you help translate, so please do so whenever you have time. The available languages can be found under resources/languages.

## How does it work?
BlockSniper has several commands to edit your world. The commands work as follows:

>> /brush < size|shape|type|blocks|height|obsolete > < args >
>
> Additional blocks can be added by separating them with a comma.
>
>> /undo
>
> Undoes the last modification done.
>
>> /clone < template/copy > < radiusXheight > < name >
>
> Templates can be downloaded and shared, while copies are only temporary.
>
>> /paste < template/copy > < name >
>
> Downloaded templates can be pasted using the according name, copies can be pasted without name.
BlockSniper has several commands to edit your world. The commands can be found on the Wiki page [here](https://github.com/Sandertv/BlockSniper/wiki/Commands).

**For more information, make sure to check the [Wiki](https://github.com/Sandertv/BlockSniper/wiki).**

## Are there permissions? Where can I find them?
A full list of permissions can be found in the [plugin.yml](https://github.com/Sandertv/BlockSniper/blob/master/plugin.yml) file.
Expand Down

0 comments on commit a0a2d08

Please sign in to comment.