Skip to content

feat : update the documentation with latets feature#344

Merged
romain1717 merged 4 commits into
mainfrom
343-add-documentation-for-all-new-features-in-client
Jan 18, 2026
Merged

feat : update the documentation with latets feature#344
romain1717 merged 4 commits into
mainfrom
343-add-documentation-for-all-new-features-in-client

Conversation

@Rosh7887epitech

Copy link
Copy Markdown
Collaborator

This pull request introduces a new background wall asset to the client, updates the rendering system to support it, and significantly expands and clarifies the technical documentation for both the client asset pipeline and the server's ECS engine. The documentation now provides thorough details about ECS components, systems, and the execution order, improving clarity for future development and onboarding.

Client Asset Integration:

  • Added a new JSON definition for the background_wall sprite, including animation and texture references (client/assets/json/background_wall.json).
  • Registered the new background wall PNG asset in the embedded resource manager and ensured it is loaded at startup (EmbeddedResourceManager.cpp, AssetLoader.cpp). [1] [2] [3]
  • Updated the rendering system to include the new sprite ID range, allowing the new background wall to render correctly (RenderSystem.cpp).

Documentation Improvements:

Client Asset Pipeline:

  • Added a comprehensive section to the client asset documentation explaining the asset embedding process, supported asset types, generated code structure, usage patterns, and build integration. Also clarified the use of JSON for defining animations, backgrounds, and entities (assets.md).

Server ECS Engine:

  • Added a new in-depth document outlining all ECS components (core, combat, AI, power-up, boss, physics, rendering, scoring, input, background) and their roles in the server engine (engine.md).
  • Expanded the ECS component list in the server documentation to provide a complete, categorized overview (ecs.md).
  • Detailed the implemented ECS systems, their execution order, and individual responsibilities, including a sample update loop and system descriptions (systems.md). [1] [2]
  • Clarified the server's approach to rendering and audio: the server prepares rendering and audio data for clients, rather than performing these tasks directly. Updated documentation to reflect this architecture (rendering.md, audio.md). [1] [2]

@Rosh7887epitech Rosh7887epitech self-assigned this Jan 18, 2026
@Rosh7887epitech Rosh7887epitech added the documentation Improvements or additions to documentation label Jan 18, 2026
@Rosh7887epitech Rosh7887epitech linked an issue Jan 18, 2026 that may be closed by this pull request
4 tasks
@Rosh7887epitech Rosh7887epitech changed the title feat : update the documentation with lastets feature feat : update the documentation with latets feature Jan 18, 2026
romain1717
romain1717 previously approved these changes Jan 18, 2026
EvannBloutin
EvannBloutin previously approved these changes Jan 18, 2026
@EvannBloutin EvannBloutin self-requested a review January 18, 2026 21:51

@EvannBloutin EvannBloutin left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image

@romain1717 romain1717 merged commit 0d84e20 into main Jan 18, 2026
10 checks passed
@romain1717 romain1717 deleted the 343-add-documentation-for-all-new-features-in-client branch January 18, 2026 21:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add documentation for all new features in client

3 participants