https://github.com/avitex/elixir-rcon

Source compatible RCON implementation in Elixir
https://github.com/avitex/elixir-rcon

elixir-lang rcon

Last synced: 2 months ago
JSON representation

Source compatible RCON implementation in Elixir

• Host: GitHub
• URL: https://github.com/avitex/elixir-rcon
• Owner: avitex
• License: mit
• Created: 2016-11-21T05:34:25.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-08-20T13:31:42.000Z (almost 2 years ago)
• Last Synced: 2025-03-26T13:11:21.058Z (3 months ago)
• Topics: elixir-lang, rcon
• Language: Elixir
• Homepage:
• Size: 40 KB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.com/avitex/elixir-rcon.svg?branch=master)](https://travis-ci.com/avitex/elixir-rcon)

[![Hex.pm](https://img.shields.io/hexpm/v/rcon.svg)](https://hex.pm/packages/rcon)

[![Hex Docs](https://img.shields.io/badge/hex-docs-blue.svg)](https://hexdocs.pm/rcon)

# RCON

**Implementation of the [Source RCON Protocol](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol).**  

Documentation hosted on [hexdocs](https://hexdocs.pm/rcon).

## Installation

  Add `rcon` to your list of dependencies in `mix.exs`:

  ```elixir

  def deps do

    [{:rcon, "~> 0.4.0"}]

  end

  ```

## Features

  - Source compatible *(should work with CS:GO, Minecraft, etc)*

  - Supports multi-packet responses

  - Handles messages with ID counter

  - Shouldn't blow up in your face

## Usage

  ```elixir

  {:ok, conn} = RCON.Client.connect("127.0.0.1", 27084)

  {:ok, conn, true} = RCON.Client.authenticate(conn, "password")

  {:ok, _conn, result} = RCON.Client.exec(conn, "status")

  

  IO.inspect result

  ```