Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guillaume-haerinck/met-ecs
🛠️ A simple ECS library made for learning purposes (header-only)
https://github.com/guillaume-haerinck/met-ecs
cpp cpp17 ecs ecs-library entity-component-system entt header-only library met-ecs template-metaprogramming templates
Last synced: 24 days ago
JSON representation
🛠️ A simple ECS library made for learning purposes (header-only)
- Host: GitHub
- URL: https://github.com/guillaume-haerinck/met-ecs
- Owner: guillaume-haerinck
- License: mit
- Created: 2019-11-17T22:17:26.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-03-10T15:59:28.000Z (almost 4 years ago)
- Last Synced: 2024-11-14T23:34:09.776Z (2 months ago)
- Topics: cpp, cpp17, ecs, ecs-library, entity-component-system, entt, header-only, library, met-ecs, template-metaprogramming, templates
- Language: C++
- Homepage:
- Size: 1.11 MB
- Stars: 16
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- AwesomeCppGameDev - met-ecs - only) (GameProgramming)
README
[](https://github.com/guillaume-haerinck/met-ecs/actions)
[](https://opensource.org/licenses/MIT)
# Met ECS
A simple [Entity Component System](#what-is-ecs-) library made for learning purposes. It is **header-only**, so just have to copy the content of the `src` folder and include `` to check it out. It does require a C++ 17 version of your compiler though.
---
Made by students, the project purposes are to be easy to understand and thoroughly documented. It is seen as an **entry point for users and developers**. We provide both a [post-mortem](docs/README.md) to explain the inner-working of the library, and many [exercices](learn/README.md) to get started with ECS.
The API is heavly based on [ENTT](https://github.com/skypjack/entt) by skypjack, you should check it out if you're looking for a highly performant and production-ready library.
> Violets are blue, roses are red, and when I met ecs, my world rebooted 🌐
## Table of Contents
* [Introduction](#introduction)
* [What is ECS ?](#what-is-ecs-)
* [Code Example](#code-example)
* [Learn](#learn)
* [Use an ECS library](#use-an-ecs-library)
* [Create an ECS library](#create-an-ecs-library)
* [Build unit tests](#build-unit-tests)
* [External links](#external-links)
* [FAQs](#faqs)
* [Videos](#videos)
* [Articles](#articles)
* [Libraries](#libraries)
## Introduction
### What is ECS ?
ECS (Entity Component System) is way to organize your data and your logic which radicaly changes from traditional Object-Oriented Programming. It is seen as both a way to improve performance and to ease maintenance. Well-suited for games, it is designed to handle operations on large groups.
ECS is made out of 3 pieces that can be summarized with these simple rules :
- Entities are unique identifiers
- Components are plain datatypes (Positions, Colors, etc...)
- Entities can possess zero or more components
- Systems are logic executed on entities with matching component sets
### Code Example
```C++
#include
struct Position {
float x;
float y;
};
struct Velocity {
float dx;
float dy;
};
int main() {
met::registry registry;
auto entity = registry.create();
Position pos = { 2, 3 };
registry.assign(entity, pos);
Velocity vel = { 5, 8 };
registry.assign(entity, vel);
registry.view().each([](met::entity id, Position& pos, Velocity& vel) {
pos.x += 2;
std::cout << "pos " << pos.x << " " << pos.y << std::endl;
std::cout << "vel " << vel.dx << " " << vel.dy << std::endl;
});
// ...
}
```
## Learn
### Use an ECS library
Some [exercices](learn/README.md) has been created to use ECS step by step.
### Create an ECS library
The [post-mortem](docs/README.md) offers a view on ECS possible implementations and explain everything there is to know about this library.
## Build unit tests
### Prerequisites
You need to have CMake and a C++ compiler which handles C++ 17.
#### Linux
```bash
sudo apt-get install build-essential cmake
```
#### Windows
You can install Visual Studio to get the MSVC compiler, and you can download CMake from their website.
## External links
### FAQs
- [SanderMertens ECS](https://github.com/SanderMertens/ecs-faq)
- [Awesome list ECS by jslee02](https://github.com/jslee02/awesome-entity-component-system)
### Videos
### Articles
### Libraries
- [ENTT](https://github.com/skypjack/entt)
- [ECS by redxdev](https://github.com/redxdev/ECS)