A plugin providing integration of Space Engineers to the iv4XR framework.
The plugin is developed by GoodAI.
Space Engineers is a sandbox game by Keen Software House.
The plugin exposes the game structured data, functionality and allows remote control.
- Clone this repository or download as zip.
- Install the plugin and 3rd party libraries by running install.bat file in the Scripts directory.
- Run the game by running start.bat file in the Scripts directory. You should see Steam popup
Allow game launch? - 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.dllto launch options.
- Right-click on the game title in the Steam library list and open its
- Use Kotlin or Python client to communicate with the game.
To get more detailed information about these steps, check manual installation, you can also build manually.
-
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
Generaltab. - You might see a message:
This file came from another computer and might be blocked.... If so, check theUnblockcheckbox.
- Right-click each of them and open file
-
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.configfor 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.logpresent in the same folder.
This section links to specific, more detailed parts of the documentation which describe functionality relevant for the plugin:
- Basic information about Space Engineers engine for purposes of using the plugin.
- Information about blocks.
- Information about character/vehicle movement.
- Controlling the game using screens.
- Using the plugin in multiplayer.
- Block ownership.
- Multiple characters in a single game.
- Using the plugin for automated testing.