Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/im-rises/particlesimulator

10 000 000 particles simulation made in C++ with OpenGL
https://github.com/im-rises/particlesimulator

cplusplus cpp engine imgui opengl particle-simulation particles simulation

Last synced: about 2 months ago
JSON representation

10 000 000 particles simulation made in C++ with OpenGL

Awesome Lists containing this project

README 

        
# ParticleSimulator





      cmakeLogo

      cppLogo

      openglLogo

      glfwLogo




## Description



This is a simple particle simulator made with OpenGL and C++ with the help of the ImGui library for the UI.



## 🚀🚀[you can try the webgl build online by clicking here](https://im-rises.github.io/particle-simulator-webgl/) 🚀🚀



The source code of the WebGL can be found at the following link:  



> **Note:**   

> The tests are running at 144Hz with 10 000 000 particles on a Windows 11 machine with an Nvidia RTX 2070 6GB.



## Images



[//]: # (![screenshot1](https://user-images.githubusercontent.com/59691442/221967878-52c06fd3-2de1-4362-873a-5ae69c62d618.png))



[//]: # (![screenshot2](https://user-images.githubusercontent.com/59691442/221967884-f74d32e2-1bf2-4382-839b-83b85433e7a8.png))



[//]: # (![screenshot4](https://user-images.githubusercontent.com/59691442/222615096-59948508-7a2e-408f-9d6a-62cbcd5f7e43.png))



[//]: # (![screenshot3](https://user-images.githubusercontent.com/59691442/221970097-cbd13fe8-dfe2-4a5a-9c8b-e7723349f232.png))



[//]: # (![screenshot5](https://user-images.githubusercontent.com/59691442/221975698-54e0e84e-602b-404a-b481-a5562f69dde1.png))



[//]: # (![screenshot (2)](https://user-images.githubusercontent.com/59691442/220508256-11312315-eb2d-4101-8086-cda5ede960fe.png))



[//]: # (![screenshot (3)](https://user-images.githubusercontent.com/59691442/220508258-c45c4877-e884-4ad7-b544-3a22945e0e0e.png))



[//]: # (## Video)



[//]: # (https://user-images.githubusercontent.com/59691442/221977239-01ca5be8-0c4e-4a83-98c0-533cbf30c083.mp4)



![Screenshot 1](https://user-images.githubusercontent.com/59691442/225486502-770ec82b-562a-452b-9ef2-f2a68c6fef18.png)

![Screenshot 2](https://user-images.githubusercontent.com/59691442/225486505-e8ccd756-056a-4507-917a-6be6bd8decb9.png)



## Videos



https://user-images.githubusercontent.com/59691442/225486109-9fb793d5-878f-430b-b418-938535038aed.mp4



## Features



- [x] ImGui UI

- [x] Camera movement

- [x] Camera settings

- [x] Mouse drag of the particles

- [x] Fullscreen toggle

- [x] Pause simulation

- [x] Change the number of particles



## Dependencies



- OpenGL version: 4.6.0

- GLSL version: 4.60

- GLFW version: 3.3.8

- Glad version: 0.1.36

- ImGui version: 1.89.6 WIP

- GLM version: 0.9.8

- Emscripten: 3.1.37



## Quickstart



To download the app, you can click one of the icons below (depending on your operating system). You can also click the

release section of the GitHub page.



Depending on you `operating system` you will need to install some libs, they are installed differently depending on your

system, please follow one of the section below `Windows` or `Linux` or `MacOs`.



For the compilation, follow the section `Compilation`.



The controls are described in the section `Controls`.



> **Warning**

> Be sure to put the `imgui.ini` file in the same folder as the executable.

> You can find it in the `root` of the project. If you don't do this, the UI will not be displayed correctly.



### Windows



cmakeLogo



For Windows users you don't need to install the libs. You can just download the app and run it.



```bash

.\ParticleSimulator.exe

```



### Linux



cmakeLogo



For Linux users, you need to install the GLFW lib, to do so type one of the following commands:



```bash

sudo apt-get install libglfw3

```



or if you're a developer and want to compile the app, please install this version of GLFW:



```bash

sudo apt-get install libglfw3-dev

```



Then you can start by double-clicking the executable of typing the following command next to it:



```bash

./ParticleSimulatorLauncher

```



### MacOs



cmakeLogo



For macOS users you will need to install Brew, please follow the instruction in the link below:  



Once it is installed, you can type the following command to install GLFW.



```bash

brew install glfw

```



Then you can start by double-clicking the executable of typing the following command next to it:



```bash

./ParticleSimulatorLauncher

```



## Controls



The speed and some parameters can be modified directly in the ImGui windows.



| Action                   | Key                                 |

|--------------------------|-------------------------------------|

| Translate camera         | WASD (← → ↑ ↓)                      |

| Pause/Resume             | P                                   |

| Move up/down camera      | SPACE/SHIFT                         |

| Rotate camera            | Right Mouse Button + Mouse movement |

| Toggle UI visible/hidden | U                                   |

| Fullscreen               | F11                                 |

| Exit app                 | ESC                                 |

| Drag particles           | Left Mouse Button + Mouse movement  |



> **Note**

> You can the inputs by changing their attribution in the `InputManager.cpp` file,

> if so you'll need to compile the project.



## Compilation



To compile the app, the first thing you need to do is install a C++ compiler:



- Visual Studio (MSVC)

- Mingw

- ...



You also need to install Cmake:  



Once your environment is set up, depending on your operating system you'll need to install some libs before compiling

the project. Refer to the section below `Windows` or `Linux` or `MacOs`.



### Windows



Windows users can directly compile the project by typing the following command at the project root folder:



```bash

cmake -B . -DCMAKE_BUILD_TYPE=Release

```



then



```bash

cmake --build . --config Release

```



> **Note**  

> If you're using Visual Studio, you can install CMake directly from the IDE (Visual Studio Installer).

> Then you need to open the Project as a CMake Project, not a Visual Studio Project!



> **Warning**  

> The project is set up to be built using CMake and vc2019 for Windows. If you want to modify the

> compiler for vc2022 or other you will need to change the CMakeLists.txt .lib linking file accordingly to your vc20**

> version.



### Linux



Linux's users need to install some libs before compiling the project:



First thing to do is to install CMake, type the following command to install it.



```bash

sudo apt-get install cmake

```



You also need to install the GLFW lib. Type the following command at the project root.



```bash

sudo apt-get install libglfw3-dev

```



You are now able to compile the project. Go to the project root and type the following command:



```bash

cmake -B . -DCMAKE_BUILD_TYPE=Release

```



then



```bash

cmake --build . --config Release

```



### MacOs



For macOS user, you should install brew package manager by following the instructions in the link below:  



Then type the following command to install cmake:



```bash

brew install cmake

```



and this one to install GLFW



```bash

brew install glfw

```



You are now able to compile the project. Go to the project root and type the following command:



```bash

cmake -B . -DCMAKE_BUILD_TYPE=Release

```



then



```bash

cmake --build . --config Release

```



## Github-Actions



[![CodeQL](https://github.com/Im-Rises/ParticleSimulator/actions/workflows/codeql.yml/badge.svg?branch=main)](https://github.com/Im-Rises/ParticleSimulator/actions/workflows/codeql.yml)

[![CMake](https://github.com/Im-Rises/ParticleSimulator/actions/workflows/cmake.yml/badge.svg?branch=main)](https://github.com/Im-Rises/ParticleSimulator/actions/workflows/cmake.yml)

[![Cpp Cmake Publish](https://github.com/Im-Rises/ParticleSimulator/actions/workflows/cpp-cmake-publish.yml/badge.svg?branch=main)](https://github.com/Im-Rises/ParticleSimulator/actions/workflows/cpp-cmake-publish.yml)

[![flawfinder](https://github.com/Im-Rises/ParticleSimulator/actions/workflows/flawfinder.yml/badge.svg?branch=main)](https://github.com/Im-Rises/ParticleSimulator/actions/workflows/flawfinder.yml)

[![Microsoft C++ Code Analysis](https://github.com/Im-Rises/ParticleSimulator/actions/workflows/msvc.yml/badge.svg?branch=main)](https://github.com/Im-Rises/ParticleSimulator/actions/workflows/msvc.yml)

[![cpp-linter](https://github.com/Im-Rises/ParticleSimulator/actions/workflows/cpp-linter.yml/badge.svg?branch=main)](https://github.com/Im-Rises/ParticleSimulator/actions/workflows/cpp-linter.yml)



The project is set with a set of different scripts:



- CodeQL: This script is used to check the code for security issues.

- CMake: This script is used to build the project.

- Cpp Cmake Publish: This script is used to publish the project on GitHub.

- Flawfinder: This script is used to check the code for security issues.

- Microsoft C++ Code Analysis: This script is used to check the code for security issues.

- Cpp Linter: This script is used to check the code for security issues.



## Libraries



glfw:  



glm:  



glad:  



stb (stb_image):  



Dear ImGui:  



OpenGL:  



## Documentation



learnopengl (OpenGL tutorial):  



unrealistic.dev (Change CMake working directory):  



BobBaykiller (Newtonian Particle Simulator):  



## Contributors



Quentin MOREL:



- @Im-Rises

- 



[![GitHub contributors](https://contrib.rocks/image?repo=Im-Rises/ParticleSimulator)](https://github.com/Im-Rises/ParticleSimulator/graphs/contributors)