Usage - thorwin99/SEWorldGenPlugin GitHub Wiki

Usage in SE and on SE server

In Space Engineers

After succesfull installation of the plugin, the main menu will contain a small message at the bottom left corner indicating the plugin version. If the plugin is outdated, you will be notified on startup of SE. On the world creation screen for custom worlds you will see a new option to enable the plugin for the world, and next to it a button, which will take you to the world specific settings for the plugin. This will also be possible to access on existing worlds, when choosing to edit the settings for existing worlds. The settings you set here will be used, the first time you load the world with the plugin enabled, to generate the star system. Further configuration is possible as documented in the configuration section.

In Dedicated Server

On Dedicated server the plugin will always be disabled by default and needs to be activated on a per world basis. To do this, please refer to the configuration section of the wiki.

Disabling the plugin

If you disable the plugin after you have generated a world, some features will not be available anymore. For your generated worlds, only the planets will stay after disabling the plugin. The following features will not work without the plugin enabled:

  • Dynamic asteroid generation

If you did not choose to use the vanilla asteroid generator, no asteroids will be generated. Your Rings, Belts and Clusters will not contain any asteroids anymore, except those already edited by a drill or voxel hand.

  • Dynamic GPS generation

Dynamic GPSs for the systems objects will no longer generate, only the ones already generated will stay.

  • Star system designer

The star system designer admin menu will only work with the plugin enabled and active.

Plugin Contents

The Plugin generates a random star system for the world. This star system can consist of various planets, moons and asteroid objects such as asteroid rings and belts. Those are called system objects. The plugin also considers modded planets for generation.

Another thing the plugin adds is an extension to the admin menu, to spawn and edit system objects.

System objects

A system object is simply put an object in the star system. It can be a planet, sun, moon, or asteroid object. Each will be explained in the following subsections. A system object can have as many child objects as it needs, for example a planet will have its moons as children.

Sun

The sun sits at the center of the star system and is the top most object of the solar sytems hierachy. They are defined as described in the global config section in the configuration section of the wiki. If no suns are defined, there wont spawn any object in the systems center. Only one sun can ever be present in one system.

Planets

Planets are the main objects in the star system. They spawn at different distances to the sun and can have moons and possibly an asteroid ring around them as children. Planets are further divided into normal planets and gas giants, where gas giants are simply double the diameter for the same surface gravity.

Moons

Moons will be spawned around planets and can never exceed the size of the planet, except for certain cases, where no possible moon exists, that would be smaller.

Asteroid objects

Asteroid objects are all objects, that provide shapes for asteroids to spawn in. Currently there are only 2 asteroid objects, that will be generated by the generator, the asteroid ring around planets, and the asteroid belt. An asteroid belt is the same as an asteroid ring, only that it goes around the system center at a much larger distance and size. There is also the hollow sphere asteroid object, which can only be spawned via the admin menu. When using the plugins asteroid generator, no asteroid will generate outside of asteroid objects. Each asteroid object will save its data in a separate file within the worlds storage folder.