space-engineers-iv4xr 0.0.1b0

Client for iv4XR Space Engineers plugin.

Python Client

Client for iv4XR plugin. It can be used to control the Space Engineers game. The plugin is developed by GoodAI.

As an alternative there is more advanced client in Kotlin.

Installation

The client itself doesn't have any dependencies, but some examples do:

• Maze generator example uses a great maze generator library mazelib
• Cucumber test uses behave
• PNG uses Pillow.

If you want to install those dependencies, simply install them through pip:

pip install -r requirements.txt

Basic usage

To use the client, you have to have Space Engineers game with a running iv4XR plugin.

To connect to a local game with a running plugin:

from spaceengineers.proxy import SpaceEngineersProxy
se = SpaceEngineersProxy.localhost()
# Example - go to "Load game" screen (game has to be in the main menu):
se.Screens.MainMenu.LoadGame()

For more API, take a look at api.py. Class SpaceEngineers being the root of the API tree.

See examples directory for more.

Limitations

• All API calls have to be made either with all arguments named or all arguments positional (named arguments are recommended). Mixture is not allowed and will cause an error.
• All default values have to be provided.

Background

The client is simple wrapper around JSON-RPC protocol. Files models.py and api.py are generated by kotlin client .

Cucumber implementation

The project includes a single feature file C284491.feature . This file has been copied from kotlin client. By implementing steps it showcases re-usability of gherkin

Type behave from the root of the project to run the test (behave needs to be installed, see Installation). Or you can right-click the feature file in PyCharm and select Run.

Useful links

• Kotlin client
• Basics
• Blocks
• Movement
• Screens
• Automated testing
• Multiplayer
• Ownership