rcon

README

gorcon

A Minecraft RCON client

Documentation

Overview

Package rcon extends net.Conn for RCON.

Example

A simple RCON client for Minecraft:

c, err := rcon.Dial("localhost:25575", "password")
if err != nil {
	log.Fatalf("%+v", err)
}
defer c.Close()

// Exec any commands
res, err := c.Command("/seed")
if err != nil {
	log.Fatalf("%+v", err)
}

fmt.Println(res) // Seed: [...]

Index

• type Rcon
  • func Dial(addr string, password string) (Rcon, error)
  • func DialTimeout(addr string, password string, timeout time.Duration) (Rcon, error)
  • func (c *Rcon) Command(command string) (string, error)

Examples

• Dial
• DialTimeout
• Rcon.Command

Types

type Rcon

type Rcon struct {
	net.Conn
}

func Dial

func Dial(addr string, password string) (Rcon, error)

Example

addr := "minecraft:25575"
password := "minecraft"
c, err := Dial(addr, password)
if err != nil {
	panic(err)
}
defer c.Close()

func DialTimeout

func DialTimeout(addr string, password string, timeout time.Duration) (Rcon, error)

Example

addr := "minecraft:25575"
password := "minecraft"
c, err := DialTimeout(addr, password, time.Duration(500)*time.Millisecond)
if err != nil {
	panic(err)
}
defer c.Close()

func (*Rcon) Command

func (c *Rcon) Command(command string) (string, error)

For details about commands, see the wiki https://minecraft.fandom.com/wiki/Commands.

Example

addr := "minecraft:25575"
password := "minecraft"
c, err := Dial(addr, password)
if err != nil {
	panic(err)
}
defer c.Close()

res, err := c.Command("/seed")
if err != nil {
	panic(err)
}

fmt.Println(res[:5])

Output:

Seed: