Giter Club home page Giter Club logo

rcon-go's Introduction

rcon-go

A simple RCON client written in Go

Note: This client doesn't yet implement the full RCON protocol spec.

Installation

go get -u github.com/sebasslash/rcon-go

Example Usage

import (
    "log"

    rcon "github.com/sebasslash/rcon-go"
)

func main() {
	config := &rcon.RCONConfig{
		Host: "my-awesome-server-ip",
		Port: 27015,
		Password: "my-awesome-server-pwd",
		MaxPayloadSize: 4096,
	}

    client := &rcon.RCONClient{
        Config: config
    }

    err := client.Open()
    if err != nil {
        log.Fatal(err)
    }
    defer client.Close()

    // Using a Mordhau specific RCON command 
    resp, err := client.SendCommand("playerlist")
    if err != nil {
        log.Fatal(err)
    }
    
    log.Printf("Server response:\n %s", resp)
}

Running Tests

In order to run the tests, a few env variables are expected:

  1. RCON_GO_HOST - The host to test against
  2. RCON_GO_PORT - The port the RCON service is listening on
  3. RCON_GO_PWD - The password used for authentication
  4. RCON_GO_TEST_COMMAND - A test command to send to the server

rcon-go's People

Contributors

sebasslash avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.