/proxy

A Minecraft Pi Proxy to allow players to connect to remote servers.

Primary LanguagePythonGNU General Public License v2.0GPL-2.0

Proxy

A Minecraft Pi Proxy that allow to players to connect to remote servers.

Getting started

Prerequisites

To use the proxy you need to have Python >= 3.7.x pre-installed.

Installation

Download and install the proxy from from the Packagecloud Debian repository:

# If you didn't add the repository yet
curl -s https://packagecloud.io/install/repositories/Alvarito050506/mcpi-devs/script.deb.sh | sudo bash

# Now the actual installation
sudo apt-get install mcpi-proxy

Usage

Run the mcpip command as:

mcpip src_addr [src_port [dst_port]]

Where src_addr is a valid internet address and src_port and dst_port are valid internet ports.

API

The proxy exposes the following methods through the Proxy class in the mcpip Python 3 module:

def __init__()

Initializes the class.

set_option(name, value):

Sets the name option to value. Avaiable options:

  • "src_addr": The source address. "src_port": The source port.
  • "dst_port": The destination port.

def get_options()

Returns the options as a dictionary.

def run()

Runs the proxy.

def stop()

Stops the proxy.

Licensing

All the code of this project is licensed under the GNU General Public License version 2.0 (GPL-2.0).

All the documentation of this project is licensed under the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

CC BY-SA 4.0