# endstonemc/endstone architecture

> Architecture diagram of the GitHub repository endstonemc/endstone, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/endstonemc/endstone
- Repository: https://github.com/endstonemc/endstone

## Overview

A continuación se detalla una guía para separar y agrupar las carpetas y componentes del proyecto Endstone según sus funcionalidades principales, lo cual ayudará a construir un diagrama de arquitectura detallado y preciso:

##### Identificar las áreas principales del proyecto
- Infraestructura y Configuración: incluye archivos y carpetas que se ocupan de la construcción, pruebas, despliegue y documentación.
- Documentación y Recursos: todo el material relacionado con las guías, documentación y tutoriales.
- Núcleo del Motor y API de Plugins: el corazón del proyecto, donde se implementa el sistema de plugins y la lógica principal.
- Integración C++/Python y Capas de Abstracción: separa claramente el código que permite la extensión vía Python y la base de código en C++.
- Plataforma Bedrock y Funcionalidades de Juego: módulos orientados a la gestión de actores, comandos, eventos, red y otros aspectos propios del servidor BDS.
- Pruebas y Validación: conjunto de pruebas unitarias y de integración.
- Dependencias Externas y Terceros: librerías y código externo que se integran al proyecto.

##### Separar las carpetas según su funcionalidad más relevante

a. Infraestructura y Configuración:
- Archivos radiculares del build y configuración:
- CMakeLists.txt, conanfile.py, pyproject.toml, Dockerfile, docker-compose.yml, .clang-format, .clang-tidy, .dockerignore, .gitignore, etc.
- Automatización y CI/CD:
- Carpeta .github (workflows, templates, dependabot, etc.).
- Scripts de instalación y utilidades:
- Carpeta scripts (autoinstall.sh, start.sh, etc.).

b. Documentación y Recursos:
- Documentación:
- docs/ (incluye guías de inicio, tutoriales, referencias, configuración de estilos y plantillas).
- mkdocs.yml, readthedocs.yaml.
- Otros recursos:
- README.md, CHANGELOG.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, LICENSE.

c. Núcleo del Motor y API de Plugins:
- Capa en Python (API alta para plugins):
- Carpeta endstone (archivos como __init__.py, actor.py, ban.py, command.py, etc.) que definen la API disponible para los plugins en Python.
- Capa en C++ (interfaz y soporte nativo):
- Carpeta include/endstone (muchos headers organizados por funcionalidad: actor, ban, block, command, event, plugin, etc.).
- Implementación central y lógica:
- Carpeta src/endstone/core (que contiene la lógica central del motor en C++: gestor de comandos, carga de plugins, red, etc.).
- Integración de Plugins nativos:
- src/endstone/plugin, src/endstone/python – se encargan de cargar y gestionar plugins escritos en C++ y Python respectivamente.

d. Plataforma Bedrock y Funcionalidades de Juego:
- Soporte para el servidor Bedrock y funcionalidades específicas de Minecraft:
- Carpeta src/bedrock/ (estructura extensa que incluye módulos para manejar: red (src/bedrock/network), eventos, comandos (src/bedrock/server/commands), gameplayhandlers, niveles (level), recursos, entidades (actor, player), y más).
- Funciones específicas de juego:
- Módulos relacionados con actores, niveles, bloques, inventarios y otros aspectos de la dinámica del juego se encuentran distribuidos en subcarpetas dentro de src/bedrock y en la carpeta endstone (en un estilo más orientado a la API).

e. Pruebas y Validación:
- Tests:
- Carpeta tests/ (contiene pruebas de las funcionalidades del motor, el sistema de plugins, casos específicos en C++ y Python).

f. Dependencias Externas y Terceros:
- Dependencias:
- Carpeta third_party/ (para integraciones y librerías externas), además de los submódulos de git.

##### Construir el diagrama del sistema

a. Dibuje nodos separados para cada uno de los grupos funcionales definidos:
- Infraestructura / Configuración (conectado a CI/CD y despliegue).
- Documentación y Recursos.
- Núcleo del Motor y API de Plugins (dividir en subnodos para la capa Python, la capa C++ y la integración de plugins).
- Plataforma Bedrock / Funcionalidades de Juego (subdivida en módulos de red, eventos, comandos, gameplay, etc.).
- Pruebas.
- Dependencias Externas.

b. Establezca relaciones y flujos de datos entre estos componentes:
- Conexión entre la infraestructura (scripts, CI/CD, build) y el núcleo del motor.
- Flujos de comunicación entre la API de plugins (Python/C++) y la plataforma Bedrock para invocar comandos, procesar eventos, etc.
- Apunte cómo el sistema de plugins se integra desde capas bajas (C++/Bedrock) y se expone para extensiones en Python.
- Indique que las pruebas actúan sobre el núcleo de la aplicación y la plataforma de juego.

c. Utilice elementos visuales para representar patrones y dependencias:
- Etiquetas claras para cada componente y grupo.
- Flechas direccionales que indiquen dependencias (por ejemplo, del motor central hacia la capa de red y de comandos).
- Recursos o cajas con colores distintos para distinguir capas de abstracción (por ejemplo, capas de API vs. implementación nativa, etc.).

##### Recomendaciones generales para el diagrama
- Incluir leyendas, etiquetas y claves para identificar claramente cada grupo funcional.
- Mantener el diagrama lo más detallado posible, separando cada carpeta/grupo en nodos específicos para reflejar la organización del código.
- Indique las integraciones externas (PyPI, Docker, etc.) y cómo se despliega el sistema.

Esta separación basada en las funcionalidades extraídas directamente del árbol del proyecto y las indicaciones del README permite al diagrama reflejar de forma muy precisa la arquitectura de Endstone, destacando tanto la plataforma para plugins (en Python y C++) como la infraestructura necesaria para un servidor Bedrock robusto y modular.

Al seguir estas pautas, el diagrama resultante mostrará de forma clara la interconexión entre los componentes estructurales del proyecto y facilitará el entendimiento global para la ingeniería de software del sistema.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Infraestructura y Configuración
    subgraph "Infraestructura y Configuración"
        cmake["CMakeLists.txt"] 
        conan["conanfile.py"]
        pyproject["pyproject.toml"]
        docker["Dockerfile"]
        dockerCompose["docker-compose.yml"]
        clangFormat[".clang-format"]
        clangTidy[".clang-tidy"]
        dockerignore[".dockerignore"]
        gitignore[".gitignore"]
        github["CI/CD (.github)"]
        scripts["Scripts (scripts)"]
    end

    %% Documentación y Recursos
    subgraph "Documentación y Recursos"
        docs["Documentation (docs/)"]
        mkdocs["mkdocs.yml"]
        readthedocs["readthedocs.yaml"]
        readme["README.md"]
        changelog["CHANGELOG.md"]
        codeOfConduct["CODE_OF_CONDUCT.md"]
        contributing["CONTRIBUTING.md"]
        license["LICENSE"]
    end

    %% Núcleo del Motor y API de Plugins
    subgraph "Núcleo del Motor y API de Plugins"
        pythonAPI["API de Plugins (Python)"]
        cppHeaders["C++ Headers (include/endstone)"]
        coreEngine["Core Engine (src/endstone/core)"]
        pluginCpp["Plugin Integration (C++)"]
        pluginPython["Plugin Integration (Python)"]
    end

    %% Plataforma Bedrock y Funcionalidades de Juego
    subgraph "Plataforma Bedrock y Funcionalidades de Juego"
        bedrock["Bedrock Server (src/bedrock)"]
        network["Network (src/bedrock/network)"]
        serverCommands["Server Commands (src/bedrock/server/commands)"]
        events["Events (src/bedrock/events)"]
        gameplay["Gameplay Handlers (src/bedrock/gameplayhandlers)"]
    end

    %% Pruebas y Validación
    subgraph "Pruebas y Validación"
        tests["Tests (tests/)"]
    end

    %% Dependencias Externas y Terceros
    subgraph "Dependencias Externas y Terceros"
        thirdParty["Third Party (third_party/)"]
    end

    %% Relaciones entre los grupos
    cmake -->|"builds"| coreEngine
    pythonAPI -->|"invokes"| bedrock
    coreEngine -->|"integrates"| bedrock
    tests -->|"tests"| coreEngine
    tests -->|"tests"| bedrock
    thirdParty -->|"supports"| coreEngine

    %% Relaciones internas del grupo Plataforma Bedrock
    bedrock --> network
    bedrock --> serverCommands
    bedrock --> events
    bedrock --> gameplay

    %% Estilos de colores
    class cmake,conan,pyproject,docker,dockerCompose,clangFormat,clangTidy,dockerignore,gitignore,github,scripts infra
    class docs,mkdocs,readthedocs,readme,changelog,codeOfConduct,contributing,license docs
    class pythonAPI,cppHeaders,coreEngine,pluginCpp,pluginPython nucleo
    class bedrock,network,serverCommands,events,gameplay bedrock
    class tests tests
    class thirdParty thirdparty

    %% Click Events for Infraestructura y Configuración
    click cmake "https://github.com/endstonemc/endstone/blob/main/CMakeLists.txt"
    click conan "https://github.com/endstonemc/endstone/blob/main/conanfile.py"
    click pyproject "https://github.com/endstonemc/endstone/blob/main/pyproject.toml"
    click docker "https://github.com/endstonemc/endstone/tree/main/Dockerfile"
    click dockerCompose "https://github.com/endstonemc/endstone/blob/main/docker-compose.yml"
    click clangFormat "https://github.com/endstonemc/endstone/blob/main/.clang-format"
    click clangTidy "https://github.com/endstonemc/endstone/blob/main/.clang-tidy"
    click dockerignore "https://github.com/endstonemc/endstone/blob/main/.dockerignore"
    click gitignore "https://github.com/endstonemc/endstone/blob/main/.gitignore"
    click github "https://github.com/endstonemc/endstone/blob/main/.github"
    click scripts "https://github.com/endstonemc/endstone/tree/main/scripts"

    %% Click Events for Documentación y Recursos
    click docs "https://github.com/endstonemc/endstone/tree/main/docs/"
    click mkdocs "https://github.com/endstonemc/endstone/blob/main/mkdocs.yml"
    click readthedocs "https://github.com/endstonemc/endstone/blob/main/readthedocs.yaml"
    click readme "https://github.com/endstonemc/endstone/blob/main/README.md"
    click changelog "https://github.com/endstonemc/endstone/blob/main/CHANGELOG.md"
    click codeOfConduct "https://github.com/endstonemc/endstone/blob/main/CODE_OF_CONDUCT.md"
    click contributing "https://github.com/endstonemc/endstone/blob/main/CONTRIBUTING.md"
    click license "https://github.com/endstonemc/endstone/tree/main/LICENSE"

    %% Click Events for Núcleo del Motor y API de Plugins
    click pythonAPI "https://github.com/endstonemc/endstone/tree/main/endstone/"
    click cppHeaders "https://github.com/endstonemc/endstone/tree/main/include/endstone"
    click coreEngine "https://github.com/endstonemc/endstone/tree/main/src/endstone/core"
    click pluginCpp "https://github.com/endstonemc/endstone/tree/main/src/endstone/plugin"
    click pluginPython "https://github.com/endstonemc/endstone/tree/main/src/endstone/python"

    %% Click Events for Plataforma Bedrock y Funcionalidades de Juego
    click bedrock "https://github.com/endstonemc/endstone/tree/main/src/bedrock"
    click network "https://github.com/endstonemc/endstone/tree/main/src/bedrock/network"
    click serverCommands "https://github.com/endstonemc/endstone/tree/main/src/bedrock/server/commands"
    click events "https://github.com/endstonemc/endstone/tree/main/src/bedrock/events"
    click gameplay "https://github.com/endstonemc/endstone/tree/main/src/bedrock/gameplayhandlers"

    %% Click Event for Pruebas y Validación
    click tests "https://github.com/endstonemc/endstone/tree/main/tests/"

    %% Click Event for Dependencias Externas y Terceros
    click thirdParty "https://github.com/endstonemc/endstone/tree/main/third_party/"

    %% Class Definitions for Colors
    classDef infra fill:#f9e79f,stroke:#b9770e,stroke-width:2px;
    classDef docs fill:#aed6f1,stroke:#2471a3,stroke-width:2px;
    classDef nucleo fill:#abebc6,stroke:#1e8449,stroke-width:2px;
    classDef bedrock fill:#f5b7b1,stroke:#943126,stroke-width:2px;
    classDef tests fill:#d2b4de,stroke:#6c3483,stroke-width:2px;
    classDef thirdparty fill:#f9c0c0,stroke:#cb4335,stroke-width:2px;
```
