Skip to content

Commit

Permalink
Update README.md (openhab#7363)
Browse files Browse the repository at this point in the history
Added additional information specifically for defining 'things' via configuration files
Minor formatting changes

Signed-off-by: Stephen Farnsworth <robotoman@gmail.com>
  • Loading branch information
ilektron authored and LoungeFlyZ committed Jun 8, 2020
1 parent 9335ae7 commit 41c14a6
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions bundles/org.openhab.binding.minecraft/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ It furthermore keeps track of redstone power going below signs and links them to
The Minecraft binding automatically finds all Minecraft servers running [this plugin](https://github.com/ibaton/bukkit-openhab-plugin/releases/download/1.9/OHMinecraft.jar) on the local network.
Servers can be added manually if they are not found automatically.

::: tip Note
Discovery uses zeroconf, which may not work if you host a Minecraft server in a virtual machine or container.
:::

## Channels

Depending on the thing type, different channels are provided:
Expand Down Expand Up @@ -54,8 +58,22 @@ Depending on the thing type, different channels are provided:
| signActive | Switch | Does the sign have powered redstone below it |


Active switch (Controllable from openHAB)
#### Active switch (Controllable from openHAB)

<a href="https://drive.google.com/uc?export=view&id=0B3UO0c11-Q6hMkNZSjJidGk4b28"><img src="https://drive.google.com/uc?export=view&id=0B3UO0c11-Q6hMkNZSjJidGk4b28" style="width: 500px; max-width: 100%; height: auto" title="Click for the larger version." /></a>

Passive sensor
#### Passive sensor

<a href="https://drive.google.com/uc?export=view&id=0B3UO0c11-Q6hUG1wd3h0MDUzUzQ"><img src="https://drive.google.com/uc?export=view&id=0B3UO0c11-Q6hUG1wd3h0MDUzUzQ" style="width: 500px; max-width: 100%; height: auto" title="Click for the larger version." /></a>

### Example Thing Definition

The easiest method to add Minecraft servers, players, and signs is use the automatic discovery through Paper UI. However, you can manualy define the objects using thing configuration files. Players and signs are connected through Minecraft server [bridges](https://www.openhab.org/docs/configuration/things.html#defining-bridges-using-files).

```xtend
Bridge minecraft:server:myminecraftserver "Minecraft server for Friends" @ "Minecraft" [ hostname="192.168.1.100", port=10692 ] {
Thing player my_name "My Minecraft User" @ "Minecraft" [ playerName="minecraft_username" ]
Thing player friends_name "My Friend's Minecraft User" @ "Minecraft" [ playerName="friends_username" ]
Thing sign sign_name "Example Sign" @ "Minecraft" [ signName="sensor" ]
}
```

0 comments on commit 41c14a6

Please sign in to comment.