libMcServerProxy For Android

libMcServerProxy is an Android library for brodcasting Minecraft servers to your lan without going through hassles of manually doing so! All been performed programmatically!

Why?

Imagine you want to create a server joining app, where you would let the user click on the server they would like to join and it will automatically open the game brodcasting the server in the LAN tab. All user needs is a simple click on the server to connect and it will start connecting! Easier than throwing them to inbuilt Servers tab and having them find their server in the long list(possibly if they could have) and playing on it(Such a mood kill)!!

Installation

Add to your build.gradle(root level):

allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}

Add the dependency

implementation 'com.github.hari01584:libMcServerProxy:x.x'

Usage

Simplest Code!

MConnector.with(getContext())
  .setTargetServer(<Target ServerIp>, <Target ServerPort>)
  .start();

Note: The class throws multiple exceptions so be sure to catch them! Also it needs VPN Bind permission to work, or it will throw exception!

Code it like

try {
  MConnector.with(getContext())
    .setTargetServer("play.cubecraft.net", 19132)
    .setInGameName("Player1234")
    .setGameSkin(<Image uri>.toString())
    .setSuppressStoragePermissions(false)
    .start();
} catch (NoVPNException e) {
  e.printStackTrace();
} catch (ServerNotSetException e) {
  e.printStackTrace();
} catch (MinecraftNotFoundException e) {
  e.printStackTrace();
} catch (StoragePermissionNotGiven e) {
  e.printStackTrace();
}

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Credits

libMcServerProxy would not be possible without these open source repos! Huge thanks to them :D

hexene-LocalVPN - Backbone VPN Service, Core of program!!

License

GPLv3

Copyright (C) 2021 Harishankar Kumar
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

Free Software, Hell Yeah!