Pages

• Getting started How to download, build and run the engine and where to go from there.
• Feature Guide
  • ECS What is an ECS and how it's used in Cubos
  • Plugins What are plugins and how they can be used to organize your code.
  • Queries In-depth guide on writing queries.
  • Quadrados How to use the Quadrados CLI tool.
• Examples Contains examples of specific features of the libraries.
  • Core Showcases features of the Core library.
    • Telemetry Using the Core-tel module.
      • Logging Using the logging system.
      • Metrics Using the metrics system.
      • Tracing Using the tracing system.
    • Reflection Using the Reflection module.
      • Basic Usage Defining and using reflectable types.
      • Constructible Trait Exposing the destructor and constructors of a type.
      • Fields Trait Exposing the fields of a type.
      • Array Trait Exposing and using array functionality of a type.
      • Dictionary Trait Exposing and using dictionary functionality of a type.
      • String Conversion Trait Exposing string conversion functions of a type.
      • Enum Trait Exposing an enumeration with variants.
      • Mask Trait Exposing a bit mask type.
      • Nullable Trait Handling null type representation.
      • Inherits Trait Exposing the inheritance relationship between types.
    • Data Using the Data module.
      • Serialization Using the Serialization module.
        • Custom Serializer Implementing your own Serializer.
        • JSON Serializer Implementing JSONSerializer.
      • Deserialization Using the Deserialization module.
        • Custom Deserializer Implementing your own Deserializer.
    • Networking Using the core-net module.
      • Udp Sockets Using UDP sockets for communication between a server and a client.
      • Tcp Sockets Using TCP sockets for communication between a server and a client.
  • Engine Showcases features of the Engine library.
    • Hello Cubos Using Cubos to create a simple program.
    • Settings Using the Settings plugin.
    • Gizmos Using the Gizmos plugin.
    • UI Using the Canvas plugin.
    • Scene Using the Scene plugin.
    • Input Using the Input plugin.
    • Assets How to use the Assets plugin.
      • Introduction and Custom Bridges Basic Assets plugin features and creating your own bridges.
      • Loading Reflectable Assets Loading reflectable assets from JSON.
      • Creating and Saving Creating and saving assets.
    • Events Using the EventReader and EventWriter.
    • Voxels Using the Voxels plugin.
    • ImGui Using the ImGui integration plugin and cubos::engine::DataInspector resource.
• Exercises
• Contribution guidelines Guide on the project's conventions and code style.