https://github.com/sparcopt/odin-eye
Valheim Server plugin that provides game server data through a REST API and WebSockets.
https://github.com/sparcopt/odin-eye
plugin rest-api valheim valheim-api valheim-events valheim-game-mod valheim-mod valheim-server websockets
Last synced: 2 months ago
JSON representation
Valheim Server plugin that provides game server data through a REST API and WebSockets.
- Host: GitHub
- URL: https://github.com/sparcopt/odin-eye
- Owner: sparcopt
- License: mit
- Created: 2023-12-12T00:16:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-02T14:25:57.000Z (about 2 years ago)
- Last Synced: 2025-10-19T15:37:50.085Z (6 months ago)
- Topics: plugin, rest-api, valheim, valheim-api, valheim-events, valheim-game-mod, valheim-mod, valheim-server, websockets
- Language: C#
- Homepage: https://sparcopt.github.io/odin-eye/
- Size: 7.12 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
OdinEye
Valheim Server plugin that provides game server data through a REST API and WebSockets.
> [!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](https://sparcopt.github.io/odin-eye/docs/getting-started/installation)
## 📨 API
Learn more about the API and how to use it: [API Reference](https://sparcopt.github.io/odin-eye/docs/category/api-reference)
## ⚡ Events
Learn more about the game events and how to use them: [Events](https://sparcopt.github.io/odin-eye/docs/category/events)