Skip to content

Repository files navigation

go-vrage

license version go reference GitHub

go-vrage is a Go client for the VRage Remote API, which is used by Space Engineers 1 Dedicated Servers to expose server management functionality over HTTP.

Warning

This project is in an early development stage. Breaking changes may be introduced without prior notice. Use in production environments is strongly discouraged. When the first stable release is published, this notice will be removed.

Compatibility with Space Engineers

Hotfix 1.210.013

API Coverage

Root Endpoint Coverage
/v1/server 100%
/v1/admin 100%
/v1/session 0%
Click to see an image of all endpoints

This is a copy of an image provided at https://www.spaceengineersgame.com/dedicated-servers.

./assets/endpoints.png

Features

  • Request authentication (nonce + HMAC-SHA1 signature).
  • Flexible usage styles:
    • High-level typed clients via Client.Server, Client.Session, Client.Admin.
    • Low-level response access via HTTPClient methods (like HTTPClient.GetV1ServerPing) when you need more control.
  • Sentinel error types for better error handling.

Installation

To install the package to your Go module, run the following command:

go get github.com/space-engineers-tools/go-vrage

Usage

Please check out the examples directory for usage examples.

Contributing

We welcome contributions! Please read our contributing guidelines for details on how to get started.

Links

Disclaimer

This project is not affiliated with Keen Software House or the Space Engineers game.

About

A Go client for the VRage Remote API of Space Engineers 1

Topics

Resources

Contributing

Security policy

Stars

3 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages