Rust+.py Docs
  • Getting Started
    • Welcome to the Rust+.py Docs!
    • Quick Start
    • Getting Player Details
      • FCM Listener
      • Getting Entity ID's
    • RustSocket
      • Rate Limiting
  • API methods
    • Removing Listeners
    • Getting Team Info
    • Getting Team Chat
    • Getting Server Info
    • Getting the Map
    • Sending Messages
    • Getting the Time
    • Getting Entity Information
    • Getting Map Markers
    • Getting Contents of Monitors
    • Promoting Players to Team Leader
  • Command System
    • Commands Overview
    • Command Options
    • Command Decorator
    • Hanging The Socket
  • Event System
    • Events Overview
  • Cameras
    • Camera Managers
Powered by GitBook
On this page

Was this helpful?

  1. Getting Started

RustSocket

The RustSocket is where everything happens in Rust+.py. Constructing one is super easy. There are only 4 required arguments, the Ip, Port, SteamId and Token. But that doesn't mean that's all!

from rustplus import RustSocket

socket = RustSocket(ip, port, steam_id, player_token, 
                    command_options, raise_ratelimit_exception, ratelimit_limit, 
                    ratelimit_refill, use_proxy)
Name
Type
What it is

ip

str

The Ip of the Server

port

str

The port of the server

steam_id

int

Your SteamID

player_token

int

Your player token

command_options

CommandOptions

The Command Options

raise_ratelimit_exception

bool

Whether to raise an exception if you run into the ratelimit. Set to false to automatically wait until you can afford the request

ratelimit_limit

int

The upper limit of the TokenBucket

ratelimit_refill

int

The refill rate of the TokenBucket

use_proxy

bool

Whether to use the Facepunch Proxy. False by default

PreviousGetting Entity ID'sNextRate Limiting

Last updated 2 years ago

Was this helpful?