https://github.com/iv4xr-project/iv4xr-se-plugin
Integration of Space Engineers to the iv4XR framework.
https://github.com/iv4xr-project/iv4xr-se-plugin
automation game test-automation testing-tools
Last synced: 6 months ago
JSON representation
Integration of Space Engineers to the iv4XR framework.
- Host: GitHub
- URL: https://github.com/iv4xr-project/iv4xr-se-plugin
- Owner: iv4xr-project
- License: lgpl-3.0
- Created: 2020-08-31T15:30:16.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-11-30T20:34:07.000Z (over 1 year ago)
- Last Synced: 2025-10-01T13:39:23.569Z (9 months ago)
- Topics: automation, game, test-automation, testing-tools
- Language: Kotlin
- Homepage:
- Size: 84.9 MB
- Stars: 7
- Watchers: 4
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[
](https://iv4xr-project.eu/)
# iv4XR Space Engineers Plugin
A plugin providing integration of [Space Engineers](https://www.spaceengineersgame.com/) to the [iv4XR framework](https://iv4xr-project.eu/).
The plugin is developed by [GoodAI](https://www.goodai.com/).
[
](https://www.goodai.com/)
## Introduction
Space Engineers is a sandbox game by [Keen Software House](https://www.keenswh.com/).
The plugin exposes the game structured data, functionality and allows remote control.
## How to run the game with plugin
1. Clone this repository or download as zip.
2. Install the plugin and 3rd party libraries by running [install.bat](Scripts/install.bat) file in the Scripts directory.
3. Run the game by running [start.bat](Scripts/start.bat) file in the Scripts directory. You should see Steam popup `Allow game launch?`
4. To make this permanent from Steam:
- Right-click on the game title in the Steam library list and open its `Properties`.
- Add the option `-plugin Ivxr.SePlugin.dll` to [launch options](https://help.steampowered.com/en/faqs/view/7d01-d2dd-d75e-2955).
5. Use [Kotlin](JvmClient/README.md) or [Python](PythonClient/README.md) client to communicate with the game.
To get more detailed information about these steps, check [manual installation](Docs/manual-installation.md), you can also [build manually](Docs/how-to-build.md).
## Troubleshooting
- Check Space Engineers logs first at `~\AppData\Roaming\SpaceEngineers`.
- Make sure Windows is OK to run the libraries. **Windows (10+) blocks "randomly" downloaded libraries.** Typical error in log is: `System.NotSupportedException`: *An attempt was
made to load an assembly from a network location...*. To fix them:
- Right-click each of them and open file `properties`.
- Look for Security section on the bottom part of the `General` tab.
- You might see a message: `This file came from another computer and might be blocked...`. If so, check
the `Unblock` checkbox.
- If the plugin works correctly, a TCP/IP server is listening for JSON-RPC calls on the port `3333`. (See the config file in
user's AppData folder `~\AppData\Roaming\SpaceEngineers\ivxr-plugin.config` for the current port number). You can safely delete this file if you think it's done incorrectly.
- Another sign of life is the log file `ivxr-plugin_xxxxx.log` present in the same folder.
## Game mechanics and functionality
This section links to specific, more detailed parts of the documentation which describe functionality relevant for the plugin:
- [Basic information](JvmClient/docs/Basics.MD) about Space Engineers engine for purposes of using the plugin.
- Information about [blocks](JvmClient/docs/Blocks.MD).
- Information about character/vehicle [movement](JvmClient/docs/Movement.MD).
- Controlling the game using [screens](JvmClient/docs/Screens.MD).
- Using the plugin in [multiplayer](JvmClient/docs/Multiplayer.MD).
- [Block ownership](JvmClient/docs/Ownership.MD).
- [Multiple characters](JvmClient/docs/Multiple-Characters.MD) in a single game.
- Using the plugin for [automated testing](JvmClient/docs/Automated-Testing.MD).
## Other links
- [Naming convention](Docs/naming-convention.md)
- [How to build](Docs/how-to-build.md)
- [Manual installation](Docs/manual-installation.md)
- [How to make a release](Docs/release-howto.md)
- [Protocol and API](Docs/protocol-api.md)