SpaceXpanse / Metaverse

SpaceXpanse Metaverse Simulator
MIT License
0 stars 0 forks source link

SpaceXpanse logo

Build

SpaceXpanse Metaverse Simulator

SpaceXpanse is a simulator based on Newtonian mechanics. Its playground is our solar system with many of its major bodies – the sun, planets and many moons where you can take control of a spacecraft – either historic, hypothetical, or purely science fiction. SpaceXpanse is unlike most commercial computer games with a space theme – there are no exactly defined missions to complete (except the ones you set yourself), no aliens to destroy and no goods to trade. Instead, you will get a pretty good idea about what is involved in real space flight – how to plan an ascent into orbit, how to rendezvous with a space station, or how to fly to another planet. It is more difficult, but also more of a challenge. Some people get hooked, others get bored. Finding out for yourself is easy – simply give it a try. SpaceXpanse is free, so you don’t need to invest more than a bit of your spare time. Enjoy!

P.S. Everyone can create a pull request for their metaverse to be added here or they can fork it altogether to create a completely different project within the platform.

License

SpaceXpanse is published as an Open Source project under the MIT License (see LICENSE file for details).

D3D9Client graphics engine is licensed under LGPL, see LGPL

Installation

Get the SpaceXpanse source repository from github

git clone git@github.com:SpaceXpanse/Metaverse.git

or

git clone https://github.com/SpaceXpanse/Metaverse.git

To configure and generate the makefiles, you need a recent CMake.

To compile SpaceXpanse from its sources, you need Microsoft Visual Studio. SpaceXpanse has been successfully built with VS Community 2019, but other versions should also work. Note that VS2019 comes with built-in CMake support, so you don't need a separate CMake installation.

Some configuration caveats:

SpaceXpanse is a 32-bit application and uses DirectX 7 for visualizetion. Be sure to configure vspkg and CMake accordingly.

If you want to build the documentation, you need a few additional tools:

By default, the build is configured to create both graphics flavours of the SpaceXpanse executable (although this can be configured with the SPACEXPANSE_GRAPHICS CMake flag):

See README.compile for details on building SpaceXpanse.

Planet textures

The SpaceXpanse git repository does not include most of the planetary texture files required for running SpaceXpanse. You need to install those separately. The easiest way to do so is by downloading them Textures. Optionally you can also install high-resolution versions of the textures from the SpaceXpanse website later. You should keep the SpaceXpanse installation separate from your SpaceXpanse git repository.

To configure SpaceXpanse to use the texture installation, set the SPACEXPANSE_PLANET_TEXTURE_INSTALL_DIR entry in CMake. For example, if SpaceXpanse was installed in C:\SpaceXpanse, the CMake option should be set to C:/Textures. Alternatively, you can configure the texture directory after building SpaceXpanse by setting the PlanetTexDir entry in SpaceXpanse.cfg.

Help

Help files are located in the Doc subfolder (if you built them). SpaceXpanse.pdf is the main SpaceXpanse user manual. Wiki version of all the help files can be foung here: SpaceXpanse Metaverse Simulator wiki.

The in-game help system can be opened via the "Help" button on the SpaceXpanse Launchpad dialog, or with Alt-F1 while running SpaceXpanse (WIP).

Remaining questions can be posted on the SpaceXpanse user forum at SpaceXpanse discussions.