rustplus Python Library

The Rust+ library uses a decorator-based event system to listen for specific socket events. When an event occurs on the server, the corresponding decorated asynchronous function is called by the socket.

There are four primary event types you can listen for:

1. Chat Event: Triggered when a message is sent to team chat.
2. Entity Event: Triggered when an entity (like an alarm or door) changes state.
3. Team Event: Triggered when team information changes (e.g., players joining or leaving).
4. Protobuf Event: Triggered when raw protobuf data is received over the websocket (intended for monitoring only).

Important Requirement for Entity Events: You must call get_entity_info(eid) for a specific entity ID before an EntityEvent listener will receive any data. This action effectively "subscribes" your client to that entity.

from rustplus import EntityEventPayload, TeamEventPayload, ChatEventPayload, ProtobufEvent, ChatEvent, EntityEvent, TeamEvent

# Example of subscribing to an Entity Event
@EntityEvent(server_details, 25743493)
async def alarm(event: EntityEventPayload):
    value = "On" if event.value else "Off"
    print(f"Entity has been turned {value}")

# Example of subscribing to a Team Event
@TeamEvent(server_details)
async def team(event: TeamEventPayload):
    print(f"The team leader's steamId is: {event.team_info.leader_steam_id}")

# Example of subscribing to a Chat Event
@ChatEvent(server_details)
async def chat(event: ChatEventPayload):
    print(f"{event.message.name}: {event.message.message}")

# Example of subscribing to a Protobuf Event
@ProtobufEvent(server_details)
async def proto(data: bytes):
    print(data)

To listen for real-time messages from the Rust+ game server (such as pairing requests), extend the FCMListener class and override the on_notification method.

1. Load your FCM configuration from the rustplus.py.config.json file (generated by the RustCli during registration).
2. Create a subclass of FCMListener.
3. Implement on_notification(self, obj, notification, data_message) to handle incoming messages.
4. Instantiate your class with the configuration details and call .start() to begin listening.

from rustplus import FCMListener
import json

# Load configuration generated by RustCli
with open("rustplus.py.config.json", "r") as input_file:
    fcm_details = json.load(input_file)

class FCM(FCMListener):
    def on_notification(self, obj, notification, data_message):
        # This method is called every time a message is received
        print(notification)
        
FCM(fcm_details).start()

Movement and actions can be sent to a camera using several methods. Before sending actions, it is recommended to verify capability using camera_manager.can_move(option).

Important: You must call camera_manager.clear_movement() after performing movements. If you do not clear the movement, the server will treat the mouse as being continuously clicked or moving.

# Check capabilities
if camera_manager.can_move(CameraMovementOptions.FIRE) and \
        camera_manager.can_move(CameraMovementOptions.MOUSE):
    
    # Send specific actions
    await camera_manager.send_actions([MovementControls.FIRE_PRIMARY])
    
    # Send mouse movement only
    await camera_manager.send_mouse_movement(Vector(1, 1))
    
    # Send combined actions and mouse movement
    await camera_manager.send_combined_movement(
        [MovementControls.FIRE_PRIMARY], Vector(1, 1))

    await asyncio.sleep(1)
    
    # CRITICAL: Clear movement to prevent continuous input
    await camera_manager.clear_movement()