This Godot Editor plugin runs an orbital simulation, with content data tables and binaries representing our Solar System.
Homepage | Forum | Issues | Changelog
Functionality of this plugin can be modified extensively using external scripts and/or config files. It's best to view documentation from within the Godot Editor, but here are repository links to key document classes:
- IVUniverseTemplate for scene tree construction.
- IVCoreInitializer & IVCoreSettings for plugin init & settings.
- IVGlobal & IVStateManager for runtime state management.
- IVBody for the physical 3D world.
- IVOrbit for orbital mechanics.
- ivoyager_tables (plugin) - See repository for installation instructions.
- ivoyager_units (plugin) - See repository for installation instructions.
- ivoyager_assets (non-Git-tracked assets) - The Core plugin will download this for you! Just press "Download" at the editor prompt. Alternatively, go here.
See changelog for current version requirements.
See our Developers Page.
If you are building a new game or app, we recomend using Project Template as your starting point. See also Planetarium for a working project using this plugin.
Instructions below are for adding plugins to an existing project.
The plugin directories ivoyager_tables, ivoyager_units and ivoyager_core should be added directly to your addons directory. You can do this one of two ways:
- Download and extract the plugins, then add (in their entirety) to your addons directory, creating an 'addons' directory in your project if needed.
- (Recommended) Add as a git submodules. From your project directory, use git commands:
git submodule add https://github.com/ivoyager/ivoyager_tables addons/ivoyager_tables
git submodule add https://github.com/ivoyager/ivoyager_units addons/ivoyager_units
git submodule add https://github.com/ivoyager/ivoyager_core addons/ivoyager_core
This method will allow you to version-control the plugins from within your project rather than moving directories manually. You'll be able to pull updates, checkout any commit, or submit pull requests back to us. This does require some learning to use git submodules. (We use GitKraken to make this easier!)
Then enable "I, Voyager - Tables", "I, Voyager - Units" and "I, Voyager - Core" (Core after the other two) from editor menu Project/Project Settings/Plugins. The Core editor plugin will then prompt you to download non-Git-tracked assets.