Minecraft

v0.1.0

Minecraft v0.1.0 Minecraft.Server View Source

The core Minecraft server that listens on a TCP port.

Link to this section Summary

Types

server_opt()
server_opts()

Functions

child_spec(opts \\ [])

Returns a specification to start this module under a supervisor. See Supervisor for more information

start_link(opts \\ [])

Starts the server

Link to this section Types

Link to this type server_opt() View Source 
server_opt() :: {:max_connections, non_neg_integer()} | {:port, 0..65535}
Link to this type server_opts() View Source 
server_opts() :: [server_opt()]

Link to this section Functions

Link to this function child_spec(opts \\ []) View Source 
child_spec(server_opts()) :: Supervisor.child_spec()

Returns a specification to start this module under a supervisor. See Supervisor for more information.

Valid options are:

  • :max_connections - The maximum number of connections this server can handle. Default is 100.
  • :port - Which port to start the server on. Default is 25565.
Link to this function start_link(opts \\ []) View Source 
start_link(server_opts()) :: {:ok, pid()} | {:error, term()}

Starts the server.