Skip to main content

Introduction

The OdinEye events capture a variety of in-game actions and activities initiated by players and the game world. These events are then enriched with data and delivered as a continuous stream. For example, the event stream can be used to track players joining the server, when the day changes or when the game is saved.
The event stream is provided through a WebSocket connection and event payloads are serialized with protobuf.

Base URL​

ws://localhost:3000/activity
Important

The activity path (/activity) must be included.

When establishing a WebSocket connection, the base URL (including the port) should be changed accordingly, matching the domain that is being used for the game server and the port where OdinEye is running.

Authentication​

note

Authentication has not been implemented at this time.

Upon implementation, the event stream will utilize API Keys as the default authentication method. Subsequently, this documentation will be revised to include the necessary instructions.