Skip to content

CodeGuide.md

Latest commit

 

History

History
48 lines (38 loc) · 4.02 KB

CodeGuide.md

File metadata and controls

48 lines (38 loc) · 4.02 KB

Code Quick Guide

This is a quick guide for modding or contributing to the development of Galaxy Engine. Please try to follow this guide as much as possible.

Before starting to mod or contribute to Galaxy Engine, please check the roadmap.

If you want to contribute or mod Galaxy Engine and have any questions, consider joining our Discord Community.

General

  • Galaxy Engine's code uses camelCase for everything except classes. Classes and structs use PascalCase.
  • The code must be compatible with Windows and Linux before being added to the main branch.
  • The code must be compatible with the MIT license.
  • Various classes for different purposes can be added to the "UpdateParameters" struct in "parameters.h". This is not necessary for important or complex classes like "SPH", "Physics", or "UI".
  • Global variables go to the "UpdateVariables" struct in "parameters.h".
  • Try to use the "UI::buttonHelper()" and "UI::sliderHelper()" functions when adding UI elements.
  • When you pass the "UpdateParameters" or "UpdateVariables" structs to a function, ALWAYS name them "myParam" and "myVar".
  • saveSystem.h is meant for parameters that change how the simulation looks or behaves. For example, threads amount is not saved because it doesn't affect the physics or the visuals of the simulation, while trails length is saved because it affects how the simulation might look like with trails enabled.
  • Keep physics and similar features inside "updateScene();".
  • Keep visual features (like UI, particle visuals, etc.) inside "drawScene();".
  • For now, the current vector struct used in Galaxy Engine is "glm::vec2".
  • Colors currently use Raylib's "Color" struct.
  • The current physics are built on top of a base framerate of 144 FPS.
  • Try to use float instead of double. There can be exceptions if needed like the "G" constant.
  • When asking for user keyboard input, use the custom IO::shortcut(key) from the io.h file instead of raylib's keyboard input.
  • Stuff from files like images, fonts, etc., that are loaded into memory must be unloaded when the program closes.
  • Before doing a pull request, you must check that your code runs both on Windows and Linux first. Please try to solve any warnings you might have before doing a pull request too.

Particles

  • Particles are composed of 2 structs.
  • "ParticlePhysics()" is used for physics calculations only.
  • "ParticleRendering()" is used for particle visuals like "color" or "size", and distinctive attributes like "isDarkMatter" or "canBeResized".
  • There is one std::vector for each struct. They are named "pParticles" and "rParticles".
  • These std::vectors must always be synchronized, meaning that the position of a particle's pParticle at index N, must be the same number as its rParticle.
  • All particles are sorted spatially with Z-Curves. This means that particles' index inside a vector or array changes constantly between frames.
  • All particle struct changes must work with all the existing features. For example, make sure that the copy-paste or subdivision features works as intended with the new particle struct changes you make.

UI

  • The Galaxy Engine UI is made entirely using the Dear ImGui library. Please check their documentation.
  • All ImGui UI elements must go after "rlImGuiBegin();" and before "rlImGuiEnd();", which can be found in the main while loop.
  • Please try to keep all UI elements inside the "uiLogic()" function. There can be exceptions for certain features.
  • For most UI elements just keep the default ImGui font. For bigger text, please use the "Roboto-Medium" font. This can be found inside "UpdateVariables".
  • Keep global buttons in the menu on the right.
  • To use Roboto-Medium or change font size for a window, you can do it like this:

image