Giter Club home page Giter Club logo

odin-eye's Introduction

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

odin-eye's People

Contributors

sparcopt avatar

Stargazers

avatar avatar avatar avatar avatar

Watchers

avatar

Forkers

wowcyberzone

odin-eye's Issues

Segregate disconnection events

If an attempt to join is made, and fails password verification (?) the disconnect event is triggered without any player name.

{
    "$type": "GameEvent",
    "CreatedDate": "2023-12-31T10:39:24.5387450",
    "Data": null,
    "Message": "Player disconnected: ",
    "Player": {
        "$type": "Player",
        "Health": 0,
        "Id": "0:0",
        "MaxHealth": 0,
        "Name": "",
        "Stamina": 0,
        "SteamId": "ID HERE"
    },
    "Type": "PlayerDisconnect"
}

Create a new event for this, and try to get the disconnect reason: password, version mismatch, etc
While at it, review the connect event as well.

Uft8Json server crash issues

Under some weird conditions, Uft8Json seems to crash the server. Probably when the server is not 100% started, having internet connection isssues and a GET request arrives.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.