Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ECS Documentation #134

Open
raphaelschmitz00 opened this issue Sep 19, 2023 · 5 comments
Open

ECS Documentation #134

raphaelschmitz00 opened this issue Sep 19, 2023 · 5 comments
Labels
content Docs content manual Related to manual documentation p1 Critical, and inhibits core functionality

Comments

@raphaelschmitz00
Copy link
Contributor

First of all, I might have put the cart before the horse with this one - sorry for that!

I am interested in the ECS powering Stride, but I was unable to find some good documentation about how it works.
Most helpful was actually a forum post from 2018, but that also only discussed part of it.

So after hopping on discord and having a nice chat with some folks, I ended up with the impression "documentation about it is not great at the moment, so anything I find until I get it to work, I can just write down and it will be an improvement".
So I did that, wrote two markdown documents about it.

Then I read the contribution guidelines and the whole process.

So, again, sorry for not following the process there - but hey! Maybe you still want it, because we don't have docs about it yet. I'm gonna create a PR and link it here immediately after finishing writing this.

Notes
A) What added to my impression is a currently existing page about the subject has some outdated code - EntityManager.Entities does not exist in 4.1.0.1898.

B) I added two pages. While one is just a technical description of what there is , the other one is a write-up about ECS in general, explaining the concept aimed at an audience that doesn't know i yet.

C) I also added a quick diagram to make the decision easier for inexperienced users. I just used diagrams.net, didn't know if there's another standard for these or something.

@raphaelschmitz00
Copy link
Contributor Author

Here's the PR: #135

@Doprez
Copy link
Contributor

Doprez commented Sep 19, 2023

This is an amazing addition! Entity processors were such a struggle without docs I was trying out Svelto but Ill give this another shot with this info.

@raphaelschmitz00
Copy link
Contributor Author

Aww thank you, didn't think this would be helpful so soon! :D

@Doprez
Copy link
Contributor

Doprez commented Sep 20, 2023

Here is the result of your new docs :)
https://discord.com/channels/500285081265635328/709051146160963655/1154137116775813231
This is something that I will explore further from now on.

@VaclavElias VaclavElias added p1 Critical, and inhibits core functionality content Docs content manual Related to manual documentation labels Sep 26, 2023
@VaclavElias
Copy link
Contributor

Can I close this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Docs content manual Related to manual documentation p1 Critical, and inhibits core functionality
Projects
None yet
Development

No branches or pull requests

3 participants