MCPing

This is a simple library that you can use to ping Minecraft: Java Edition servers using Elixir. It's built primarily on Erlang's gen_tcp support, and the response JSON is deserialized automatically with Jason.

How to Use It

It's pretty easy. Here's how you might use it:

{:ok, response} = MCPing.get_info("mc.hypixel.net")

get_info takes three parameters, of which only the address is required. The return value is a tuple:

• {:ok, status} - we were able to contact the server successfully.
• {:error, reason} - we were unable to contact the server (the reason is usually from the underlying gen_tcp client).

Installation

If available in Hex, the package can be installed by adding mcping to your list of dependencies in mix.exs:

def deps do
  [
    {:mcping, "~> 0.1.0"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/mcping.