Getting Started

Purpose

This section helps you get up and running with Rcon quickly and efficiently.

Overview

Rcon is designed to be simple to use while providing robust features for production use:

  • Zero setup - Add the dependency and you’re ready to go

  • Simple API - Send commands with a single method call

  • Automatic multi-packet handling - Large responses are assembled transparently

  • Thread-safe operations - Use from multiple threads without worry

Learning Path

We recommend following these guides in order:

  1. Installation - Set up Rcon in your project

  2. Quick Start - Send your first command in 5 minutes

  3. Architecture Overview - Understand how the library works

  4. Configuration Options - Customize Rcon behavior


Table of contents


This site uses Just the Docs, a documentation theme for Jekyll.