Skip to content

Valheim Server plugin that provides game server data through a REST API and WebSockets.

License

Notifications You must be signed in to change notification settings

sparcopt/odin-eye

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

72 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OdinEye

Valheim Server plugin that provides game server data through a REST API and WebSockets.

GitHub Workflow Status (with event) GitHub Workflow Status (with event)

Important

This project is currently under development. Beta versions are accessible and ready for use, but please note that breaking changes may be implemented without prior notice.

ℹ️ Overview

OdinEye is a free, open-source Valheim server plugin that exposes server and gameplay data. The plugin provides a public REST API, enabling consumers to access relevant information about the dedicated server instance, including details like current online players and boss progression. In addition to this, in-game events like player actions or raids, and periodic data such as player stats, are also accessible as a stream of events through WebSockets.

✨ Features

  • Seamless integration
    • Install the plugin and extend your server's capabilities in just a few minutes. Unlock new integration possibilities
  • Game server API
    • Use the provided REST API to query game server data such as player info, boss progression and game world details
  • Game events
    • Stay updated with live, in-game events as they occur. Build interactive client applications that mirror the game actions

📦 Getting started

Installation instructions are available at: Installation

📨 API

Learn more about the API and how to use it: API Reference

⚡ Events

Learn more about the game events and how to use them: Events