<commit_before># AstralEdit [![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://raw.githubusercontent.com/Shynixn/AstralEdit/master/LICENSE)

| branch        | status        | download      |
| ------------- | --------------| --------------| 
| master        | [![Build Status](https://travis-ci.org/Shynixn/PetBlocks.svg?branch=master)](https://travis-ci.org/Shynixn/AstralEdit) |[Download latest release (recommend)](https://github.com/Shynixn/AstralEdit/releases)|
| experimental      | [![Build Status](https://travis-ci.org/Shynixn/PetBlocks.svg?branch=workflow)](https://travis-ci.org/Shynixn/AstralEdit) | [Download snapshots](https://oss.sonatype.org/content/repositories/snapshots/com/github/shynixn/astraledit/) |

JavaDocs: https://shynixn.github.io/AstralEdit/apidocs/

## Description
WorldEdit Extension to modify your world in a way you have not seen before.

## Features

* Modify your world in a unique and funny way
* Helps being more productive
* Version support 1.8.R1 - 1.12.R1
* Check out the [AstralEdit-Spigot-Page](COMING SOON) to get more information. 

## Installation

* [Download the plugin AstralEdit](COMING SOON)
* Put the plugin into your plugin folder
* Start the server (1.8.0 - 1.12.0, Java 8)
* Join and play :)

## API

* Reference the AstralEdit.jar in your own projects.
* If you are using maven or gradle you can add it from the central maven repository

### Maven

```xml
<dependency>
     <groupId>com.github.shynixn</groupId>
     <artifactId>astraledit</artifactId>
     <version>1.0.0</version>
</dependency>
```

### Gradle

```json
dependencies {
    compile 'com.github.shynixn:astraledit:1.0.0'
}
```

## How to use the it

#### Sample to render the worldEdit selection of the player and moving it to the player's location

```java
     //Get a player and a plugin instance
     Player player;
     Plugin plugin;
   
     //It is highly recommend to work with selections asynchronly to increase server performance
     Bukkit.getServer().getScheduler().runTaskAsynchronously(plugin, new Runnable() {
       @Override
       public void run() {
           Selection selection = AstralEditApi.render(player);
           selection.move(player.getLocation());
       }
     });
```
#### Sample to render the blocks between two given corners, moving it to a targetLocation and placing the blocks. 

```java
    //Select the locations
    Location corner1 = new Location(Bukkit.getWorld("world"), 20, 5, 20);
    Location corner2 = new Location(Bukkit.getWorld("world"), 40, 10, 40);
    Location targetLocation  = new Location(Bukkit.getWorld("world"), 70, 8, 40);

   //Get a player and a plugin instance
    Player player;
    Plugin plugin;
   
    Bukkit.getServer().getScheduler().runTaskAsynchronously(plugin, new Runnable() {
            @Override
            public void run() {
                Selection selection = AstralEditApi.renderAndDestroy(player,corner1, corner2);
                selection.move(targetLocation);
                selection.placeBlocks();
                AstralEditApi.clearRenderedObject(player); //Do not forget to clear up the selection
            }
    });
```

* Check out the [AstralEdit-Spigot-Page](COMING SOON) to get more information. 

## Screenshots

Coming soon

## Licence

Copyright 2017 Shynixn

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
<commit_msg>Fixed README<commit_after># AstralEdit [![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://raw.githubusercontent.com/Shynixn/AstralEdit/master/LICENSE)

| branch        | status        | download      |
| ------------- | --------------| --------------| 
| master        | [![Build Status](https://travis-ci.org/Shynixn/AstralEdit.svg?branch=master)](https://travis-ci.org/Shynixn/AstralEdit) |[Download latest release (recommend)](https://github.com/Shynixn/AstralEdit/releases)|
| experimental      | [![Build Status](https://travis-ci.org/Shynixn/AstralEdit.svg?branch=workflow)](https://travis-ci.org/Shynixn/AstralEdit) | [Download snapshots](https://oss.sonatype.org/content/repositories/snapshots/com/github/shynixn/astraledit/) |

JavaDocs: https://shynixn.github.io/AstralEdit/apidocs/

## Description
WorldEdit Extension to modify your world in a way you have not seen before.

## Features

* Modify your world in a unique and funny way
* Helps being more productive
* Version support 1.8.R1 - 1.12.R1
* Check out the [AstralEdit-Spigot-Page](COMING SOON) to get more information. 

## Installation

* [Download the plugin AstralEdit](COMING SOON)
* Put the plugin into your plugin folder
* Start the server (1.8.0 - 1.12.0, Java 8)
* Join and play :)

## API

* Reference the AstralEdit.jar in your own projects.
* If you are using maven or gradle you can add it from the central maven repository

### Maven

```xml
<dependency>
     <groupId>com.github.shynixn</groupId>
     <artifactId>astraledit</artifactId>
     <version>1.0.0</version>
</dependency>
```

### Gradle

```xml
dependencies {
    compile 'com.github.shynixn:astraledit:1.0.0'
}
```

## How to use the it

#### Sample to render the worldEdit selection of the player and moving it to the player's location

```java
//Get a player and a plugin instance
Player player;
Plugin plugin;

 //It is highly recommend to work with selections asynchronly to increase server performance
Bukkit.getServer().getScheduler().runTaskAsynchronously(plugin, new Runnable() {
   @Override
   public void run() {
       Selection selection = AstralEditApi.render(player);
       selection.move(player.getLocation());
   }
});
```
#### Sample to render the blocks between two given corners, moving it to a targetLocation and placing the blocks. 

```java
//Select the locations
Location corner1 = new Location(Bukkit.getWorld("world"), 20, 5, 20);
Location corner2 = new Location(Bukkit.getWorld("world"), 40, 10, 40);
Location targetLocation  = new Location(Bukkit.getWorld("world"), 70, 8, 40);

//Get a player and a plugin instance
Player player;
Plugin plugin;

Bukkit.getServer().getScheduler().runTaskAsynchronously(plugin, new Runnable() {
        @Override
        public void run() {
            Selection selection = AstralEditApi.renderAndDestroy(player,corner1, corner2);
            selection.move(targetLocation);
            selection.placeBlocks();
            AstralEditApi.clearRenderedObject(player); //Do not forget to clear up the selection
        }
});
```

* Check out the [AstralEdit-Spigot-Page](COMING SOON) to get more information. 

## Screenshots

Coming soon

## Licence

Copyright 2017 Shynixn

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

{'fraction_non_alphanumeric': 0.12955465587044535, 'fraction_numerical': 0.015326778484673221, 'mean_word_length': 3.5091264667535853, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 19, 'https://': 18, 'lorem ipsum': 0, 'www.': 0, 'xml': 3}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1709602', 'n_tokens_mistral': 2218, 'n_tokens_neox': 2077, 'n_words': 603}