Skip to content

Commit

Permalink
Updated README.me
Browse files Browse the repository at this point in the history
  • Loading branch information
playajames committed Jul 5, 2021
1 parent d99c592 commit c5aa4ad
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 9 deletions.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,30 +20,38 @@ You must have [Oraxen](https://github.com/oraxen/Oraxen), [WorldEdit](https://gi

Place the plugin jar file in your servers plugins directory.

### Adding Transparent Block Mechanic to Oraxen

Add the following to mechanics.yml in your Oraxen plugin folder

```yaml
transparent_block:
enabled: true
```
## Configuring Blocks
Create a custom item/block using [Oraxen](https://github.com/oraxen/Oraxen) and give your item/block the transpatent_block mechanic.
### Example:
```yaml
caveblock_transparent:
displayname: "&7Cave Block Transparent"
transparent_block:
displayname: '&7Transparent Block'
material: DIAMOND
Pack:
generate_model: false
model: caveblock
model: transparent_block
Mechanics:
transparent_block:
# Sounds not implemented yet
#break_sound: BLOCK_GLASS_BREAK
custom_variation: 25
armorstand_visible: false
armorstand_small: false
block_gravity: false
break_sound: BLOCK_GLASS_BREAK
drop:
loots:
- {oraxen_item: caveblock_transparent, probability: 1.0, max_amount: 1}
- {minecraft_type: DIRT, probability: 1, max_amount: 1}
- {oraxen_item: transparent_block, probability: 1.0, max_amount: 1}
```
## Block Models
Expand Down Expand Up @@ -71,7 +79,7 @@ Although not very extensive, this plugin call's the following custom events for
<dependency>
<groupId>com.github.playajames419</groupId>
<artifactId>OraxenTransparentBlocks</artifactId>
<version>1.0</version>
<version>1.1</version>
</dependency>
```

Expand Down
7 changes: 7 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -106,5 +106,12 @@
<artifactId>sqlite-jdbc</artifactId>
<version>3.34.0.1-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>io.th0rgal</groupId>
<artifactId>oraxen</artifactId>
<version>1.79.0</version>
<scope>system</scope>
<systemPath>C:/Users/James Kennedy/Dropbox/James/Workspace/OraxenTransparentBlocks/src/main/resources/oraxen-1.79.0-all.jar</systemPath>
</dependency>
</dependencies>
</project>
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
import io.th0rgal.oraxen.mechanics.Mechanic;
import io.th0rgal.oraxen.mechanics.MechanicFactory;
import me.playajames.oraxentransparentblocks.Listeners.OraxenBlockListeners.OraxenTransparentBlockBreakListener;
import me.playajames.oraxentransparentblocks.Listeners.OraxenBlockListeners.OraxenTransparentBlockInteractListener;
import me.playajames.oraxentransparentblocks.Listeners.OraxenBlockListeners.OraxenTransparentBlockPlaceListener;
import me.playajames.oraxentransparentblocks.OraxenTransparentBlocks;
import org.bukkit.Bukkit;
Expand Down

0 comments on commit c5aa4ad

Please sign in to comment.