This repository holds the 3rd Year Physics Project of Bruhmao and myself, containing development history and the final submitted code.
By the time of presentation, the Unity Assets folder should contain all that is required to load up the project using the Unity Editor. On top of this, there should also be a Builds folder containing the executable files that allow the simulation to be run independently of Unity. There is a build for non-VR use, with less of the intended features as this was used for development, and another to be loaded using a connected VR device for full features. An additional optimised build has been uploaded for demonstrations purposes of a more stable performance by changing Time.deltaFixedTime upon input, which was originally avoided due to potential unstableness in physics.
Note: Commits beyond date of 21st April 2022 were done after official project submission, and were for demonstration purposes only to show working features (as some were not working 100% on submission)
For the best VR experience, follow the path VR-SolarSystem-UNITY/Builds/Fixed VRSS/ and run the Solar System Simulator.exe file from this folder once you have a VR device set up. This is the best working build that was created shortly after the deadline used in live demos and contains the least number of bugs.
For a non-VR experience, follow the path VR-SolarSystem-UNITY/Builds/Solar System Simulator/ and run the .exe file there. This will not contain as many features as in the VR version as this had more of a testing purpose
The other build folders contain incomplete/broken builds that were made during the project time period or shortly before submission deadline however all submitted documentation (i.e. reports) show how the above 2 builds were assembled.
Using Newtonian Gravity and scaling methods, a model Solar System was built inside the Unity Engine so that the orbits of celestial bodies could be simulated. Starting from initially set conditions, the orbits evolve naturally with time and can easily be disrupted by changing properties of the celestial or by placing another massive body beside it (see below).
Scripts required for any scene to work are:
SimulationScript.csBodyProperties.csPlanetRingMeshGenerator.csUpdateTimeScale.cs
Both simulators feature a method to explore the Solar System model through free movement or focused perspectives of a celestial. In the non-VR simulator, the user can use the WASD keys + RMB input to move freely in the 'Free Cam' mode. Alternatively they can use the 'Focus Cam' mode to bring a celestial body into view via UI or switching through the list by using the Ctrl + < or > keys.
Scripts specific to this simulator version are:
Camera/CameraFocus.csCamera/FreeCam.csCelestialSelector.csDistanceDisplay.csPlanetProperties.csKeyPadScript.cs
In the scene migration to a VR compatible scene, the 'Free Cam' mode was replaced with the use of an XR Rig which the user takes control of via the Oculus Rift CV1 Device. Movement is controller using the left joystick whilst rotation can be controlled using the right joystick, note that this is relative to the direction you are looking. Speed is decreased with the left trigger and increased with the right trigger. Interactable objects are grabbed the usual way, pressing the grip button on either controller. The User Interface is interacted via raycast interactions using the right controller and selected using the primary button, which is the A button on the Oculus controller.
Scripts specific to the VR version are:
VR/SphereGrabbableSpawner.csVR/VRCamSwitch.csVR/VRCelestialSelector.csVR/ContinuousMovement.csVR/DistanceDisplay.csVR/PlanetProperties.csVR/VRKeypadScript.cs
Linked below will be a YouTube playlist showcasing development and previews of the project and any particular sources of information used in the project
YouTube Playlist: VRSS Project Update Playlist
Excel Workbook: Planetary Datasheet (Read Only)
Wherever possible, we try to cite tutorials/sources used when creating or taking from (open source) scripts. Below are links/references used in creating the project.
Coderious's Solar System Example: Unity Tutorial - Solar System with Unity Physics
This was used to template custom gravity and velocity calculations in
SimulationScript.cs. Due to incompleteness in the video, a unique solution was implemented to initialise starting velocities, and hence dependency onBodyProperties.cs.
Board To Bits Games Planet Ring Mesh Tutorial: || Part 1 || Part 2 ||
Used to create planetary rings in the simulation for visual effects, see
PlanetRingMeshGenerator.cs.
mrwasd's Particle Sun Tutorial: Unity3D Particle Sun Tutorial
Used to recreate a basic corona effect around the Sun using Unity's Particle Systems.
Ashley Davis' Free Camera Script: GitHub Repository
Used as a template for the Free Cam script in the non-VR scene.
Emma Prats' Camera Rotation Tutorial: || Video Tutorial || Blog Tutorial ||
Used to allow camera rotation around a celestial body in 'Focus Mode' for the non-VR scene.
Jason Wiemann's Spawning Tutorial: Unity3D 101: Spawning Objects from prefabs...
Used to script
VR/SphereGrabbableSpawner.csto allow creation of VR interactable celestials.
Brackey's Minimap Tutorial: How to make a Minimap in Unity
This was used during scene migration to VR, allowing one camera to render to the UI allowing the user to focus on a celestial body whilst flying through the simulation.
Valem's Unity XR Toolkit Tutorial Playlist: Introduction to VR in Unity - UNITY XR TOOLKIT
This was most used during VR implementation, specifically parts 1 to 6.
Valem's Oculus Integration Tutorial Playlist: How to make a VR game - OCULUS INTEGRATION
This was used to help with using Oculus Integration Assets provided by Oculus themselves.
Jayanam's UI Dropdown Tutorial: Unity UI Tutorial Dropdown C# Scripting
This tutorial was used to aid the creation of the Celestial Selector menu seen in the top left of the UI.
Coco Code's UI Scaling Tutorial: How to scale Unity UI objects for every screen - Unity UI tutorial
This was used to allow basic support for different screen sizes, so that UI would correctly display on-screen regardless of window size.
SolarSystemScope Textures: Free High Res Solar System Textures
These textures are open for public use, and applied to our Celestial GameObjects. Saturn's Ring Texture can also be found here, which was reused for other planetary rings.
Smoke Effect Texture: Smoke Texture + Basic Tutorial
Used in Sun's corona effect using mrwasd's Particle Sun tutorial.
Keypad Texture Asset Package: Unity Asset Store: Keypad
Free Asset from Unity Asset Store by Robotparts for a Virtual UI Keypad
Oculus Integration Package: Unity Asset Store: Oculus Integration
Free Asset from Unity Asset Store by Oculus for easy Oculus integration in development.