theolomeubraga / ecs_test Goto Github PK

This README provides documentation to an test library called ecs_test, a C++ library designed for creating and managing entities with associated components. The library allows you to define and manipulate entities and their components dynamically.

To use this library, follow these steps:

1. Include the Library: Include the necessary headers at the beginning of your C++ files where you plan to use the ECS system.

   #include "ecs.h"
   #include "ecs_name.h"

2. Register Components: Register any custom components you want to use with the ECS system by calling their respective registration functions. For example:

   // Example registration of a 'name' component
   register_name_component();

3. Register Components: Register any custom components you want to use with the ECS system by calling the new_entity functions. For example:

   entity entity = new_entity();

   Adding Components: Add components to entities using the add_component function. Provide the entity's ID, the component's name, and the component's data.

   add_component(entity, "name", std::string("theo"));

4. Removing Components: Remove components from entities using the remove_component function:

   remove_component(entity, "name");

5. Checking Component Existence: You can check if an entity has a specific component using the have_component function:

   bool hasName = have_component(entity, "name");

6. Running Components: Use the run_components function to run all registered components:

   run_components();

7. Cleaning Up Entities: To delete entities and their associated components, use the delete_entity function. It will remove all components associated with the entity and free its ID.

   delete_entity(entity);

To create custom components, follow these steps:

1. Define the component structure with the necessary functions. For example:

   struct ecs_system
   {
       void (*add)(entity, std::any);
       bool (*have)(entity);
       void (*run)(entity);
       void (*run_components)();
       void (*remove)(entity);
   };

2. Implement the component functions. These functions should manipulate the component's data associated with entities.

3. Register the custom component using the ecs_systems_registerd map and the register_name_component function as an example.

#pragma once 

#include "ecs.h"
#include <vector>
#include <string>
#include <map>
#include <set>

std::map<entity,std::string> names_map;

void add_name(entity id,std::any data){
    names_map.insert(std::pair<entity,std::string>(id,std::any_cast<std::string>(data)));
}

bool have_name(entity id){
    if(names_map.find(id) != names_map.end()){
        return true;
    }
    return false;
}

void run_name(entity id){}

void run_names(){}

void remove_name (entity id){
    names_map.erase(id);
}

void register_name_component(){
    ecs_systems_registerd.insert(std::pair<std::string,struct ecs_system>("name",{add_name,have_name,run_name,run_names,remove_name}));
}

entity search_entity_by_name(std::string name){
    for(std::pair<entity,std::string> p : names_map){
        if(p.second == name){
            return p.first;
        }
    }
    return 0;
}

#include <iostream>
#include "ecs.h"
#include "ecs_name.h"

int main() {

    //register components
    register_name_component();

    //create entity
    entity ent = new_entity();
    std::cout << "entity id " << ent << std::endl;

    //add name
    add_component(ent,"name",std::string("theo"));
    std::cout << "entity name " << *get_name(ent) << std::endl;
    std::cout << "entity have name " << have_component(ent,"name") << std::endl;

    //change name
    names_map[ent] = "ricardo";
    std::cout << "entity name " << *get_name(ent) << std::endl;

    //remove name
    remove_component(ent,"name");
    std::cout << "entity have name " << have_component(ent,"name") << std::endl;

    delete_entity(ent);

    return 0;
}

compile comand

g++ ecs_test.cpp -o ecs_test -I./ecs -I./ecs/ecs_systems
./ecs_test

or

g++ ecs_test.cpp -o ecs_test -I./ecs -I./ecs/ecs_systems ; ./ecs_test