Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zml2008/landiscovery

Allow making a Sponge server discoverable over LAN
https://github.com/zml2008/landiscovery

Last synced: 2 months ago
JSON representation

Allow making a Sponge server discoverable over LAN

Awesome Lists containing this project

README

        

# LanDiscovery

LanDiscovery is a plugin for SpongeAPI 8+ that broadcasts a dedicated server's presence for discovery in the LAN server list on clients.

The text used for the broadcast is the MOTD set in the server's `server.properties`. This is currently not configurable.

![A Sponge server displayed as a LAN world in the Minecraft client](./etc/lan-client.png)

## Commands

- `/lanmute`

**Permission**: `landiscovery.mute`

This command will toggle whether lan broadcasts are enabled, to temporarily hide the server from local clients.

## License

LanDiscovery is released under the terms of the [GNU Lesser General Public License version 3 or later](COPYING.LESSER).

## Developer resources
- https://github.com/SpoutDev/Vanilla/blob/master/src/main/java/org/spout/vanilla/protocol/LANThread.java Implementation of server broadcast

The is `[MOTD]server mothd[/MOTD][AD]port#[/AD]` -- server ip is the same as the broadcasting host.

### Building

LanDiscovery is built with Gradle, and targets Java 8. Run `./gradlew build` to compile and test the plugin. The built jar will be in `build/libs`.