Simulant Documentation

Reference

• Generated Docs: Doxygen

First Steps

• Installation: Fedora | Ubuntu / Linux Mint | Windows - WSL2
• IDE Setup: IDE Setup
• Tutorial: 1. Basic Application
• Platforms: Platform Notes
• Licensing: FAQ
• Contributing: Compile on Fedora | C++ Guidelines

Architecture

Basic Concepts

This section covers the base subsystems and usages of Simulant.

• Overview: Engine Structure | Asset Management
• Managing objects: Stage Node Managers | Asset Managers
• Core systems: The Window

Using Simulant

• Application: The Application
• Scene Management: The Scene | Managing Scenes
• Stage Heirarchy: Stage Nodes | Actors | MeshInstancers | Cameras: Cameras
• The rendering process: The Render Sequence | Pipelines | Viewports
• Partitioning: Overview | Spatial Hash Partitioner | The Null Partitioner
• Behaviours: Organisms and Behaviours
• Helpers: 3D Math | Threads | JSON Parser | Environment Variables | Coroutines
• Scripting: Particle System File Format
• Supported File Formats: Mesh Formats | Image Formats
• Assets: Textures | Meshes | Materials
• Audio: Audio
• Debugging: Debugging | Logging
• Profiling: Profiling
• Devices: Screens
• User interfaces: Widgets | Localisation
• Utilities: Random | Command Line Args