Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jjbel/samarium
2-D physics simulation and rendering engine written in modern C++.
https://github.com/jjbel/samarium
cmake conan cpp modern-cpp physics-simulation
Last synced: about 1 month ago
JSON representation
2-D physics simulation and rendering engine written in modern C++.
- Host: GitHub
- URL: https://github.com/jjbel/samarium
- Owner: jjbel
- License: mit
- Created: 2021-10-04T16:59:29.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-23T19:42:27.000Z (about 2 months ago)
- Last Synced: 2024-09-27T06:42:29.494Z (about 2 months ago)
- Topics: cmake, conan, cpp, modern-cpp, physics-simulation
- Language: C++
- Homepage: https://jjbel.github.io/samarium/
- Size: 2.26 MB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Samarium
Samarium is a 2d physics simulation library written in modern C++20.
## Contents
- [Examples](#examples)
- [Quickstart](#quickstart)
- [Prerequistes](#prerequistes)
- [Installation](#installation)
- [Example](#example)
- [Tools](#tools)
- [Documentation](#documentation)
- [License](#license)
## Examples
[](https://user-images.githubusercontent.com/83468982/178472984-8cd83808-bfb2-478b-8a5e-3d45782f2c7d.mp4)
[](https://user-images.githubusercontent.com/83468982/178473002-b7f896f6-d5ed-4cc5-be34-bcccab9ef11e.mp4)
[](https://github.com/user-attachments/assets/d870c975-44d4-4624-b122-48129506bbf6)
## Quickstart
```sh
git clone --depth 1 https://github.com/jjbel/samarium.git
python samarium/bootstrap.py
```
## Prerequistes
| Dependency | URL | Documentation |
| ---------- | ----------------------------------- | --------------------------- |
| python | | |
| git | | |
A compiler supporting C++20 is required, namely GCC-11, Clang-13, or Visual C++ 2019.
Running `boostrap.py` will install CMake and Conan, or you can do it yourself first.
## Installation
To install the library locally:
```
conan download samarium/1.1.0@
```
or for the latest version
```sh
git clone --depth 1 https://github.com/jjbel/samarium.git
conan create ./samarium/ -b missing
```
## Example
For a fully-featured and self-contained example, run:
```sh
git clone --depth 1 https://github.com/jjbel/samarium_example.git .
cmake --preset default
cmake --build --preset default
```
## Tools
For the optimal developing experience, use [VSCode](https://code.visualstudio.com) using the following extensions and tools
1. [C++ Extension Pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools-extension-pack)
2. [Clang Format](https://clang.llvm.org/docs/ClangFormat.html)
3. [CMake Format](https://github.com/cheshirekow/cmake_format) and the corresponding [extension](https://marketplace.visualstudio.com/items?itemName=cheshirekow.cmake-format)
4. [SonarLint](https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarlint-vscode)
5. [C++ Advanced Lint](https://marketplace.visualstudio.com/items?itemName=jbenden.c-cpp-flylint)
## Documentation
Documentation is located at [Github Pages](https://jjbel.github.io/samarium/)
## License
Samarium is distributed under the [MIT License](LICENSE.md).
## Libraries Used
Many thanks to the following wonderful libraries:
1. [fmtlib](https://github.com/fmtlib/fmt)
2. [range-v3](https://github.com/ericniebler/range-v3)
3. [BS::thread_pool](https://github.com/bshoshany/thread-pool)
4. [PCG RNG](https://www.pcg-random.org/)
5. [tl::function_ref](https://github.com/TartanLlama/function_ref) and [tl::expected](https://github.com/TartanLlama/expected)
6. [znone/call_thunk](https://github.com/znone/call_thunk)
7. [itlib-static-vector](https://github.com/iboB/itlib)