OpenXRay/xray-16

Research if we can introduce ECS

Open

#1,117 opened on Oct 27, 2022

View on GitHub
 (1 comment) (1 reaction) (0 assignees)C++ (519 forks)auto 404
AICode QualityEnhancementHelp wanted

Repository metrics

Stars
 (3,524 stars)
PR merge metrics
 (PR metrics pending)

Description

Class inheritance based entities system in the engine has many problems. Entity component system may introduce benefits, but this should be researched.

Things to consider:

  1. We want to keep the compatibility with the vanilla game assets, e.g. scripts which are unaware about the ECS.
  2. We also want to provide a facility for game assets to utilize the ECS and its features, so that modders could benefit.
  3. There's so much code tied to another code, hacks, workarounds and tangles in the code, so it's a challenging task.

Contributor guide

Research direction
Study the current class inheritance based entity system, identify its problems, and research how an Entity Component System could be introduced while maintaining compatibility with vanilla game assets and providing ECS features for modders.
Tech stack
cpp
Domain
game dev
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
C++ECS basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25