Cleanup and document engine-sample.cars

[fallenatlas]

Blocked by #508.

• Self-review changes.
• Evaluate impact on the documentation.

[github-actions]

PR Preview Action v1.4.4
🚀 Deployed preview to https://GameDevTecnico.github.io/cubos/pr-preview/pr-503/
on branch gh-pages at 2023-09-25 21:25 UTC

[codecov]

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (fcc4fef) 26.95% compared to head (061b663) 26.95%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #503   +/-   ##
=======================================
  Coverage   26.95%   26.95%           
=======================================
  Files          89       89           
  Lines        6800     6800           
=======================================
  Hits         1833     1833           
  Misses       4967     4967           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[RiscadoA]

Thanks for working on this @fallenatlas! Added some suggestions

[RiscadoA]

Also, I just realized that perhaps we could call this sample engine-sample.voxels. It basically demonstrates how the voxelsPlugin can be used, right?

[fallenatlas]

We could do that but maybe the movement part wouldn't really be needed if we were to rename it, because it doesn't really have to do with voxels or rendering, I think. The name cars suggests that it demonstrates that but not exclusively

[RiscadoA]

Yeah you're right. Unsure if we should simplify this or keep it.
One point in favor of removing the movement would be to have a 'go to' sample for loading voxel models.

Still, I guess it can be nice to have a sample which does more than one thing.
Eventually we'll definitely want to have more complete samples which are playable, a bit like our demo.

What do you think? @fallenatlas @luishfonseca @DiogoMendonc-a

[fallenatlas]

I think it makes sense to have samples that don't focus only on one thing, but yeah, I don't know if at this stage it's better to just simplify or if something more "normal" like this is actually useful.

[RiscadoA]

Well lets simplify it then. Its easier to maintain, and probably more helpful this way - assuming its goal is teaching how to use grid and palette assets.

Maybe the sample should be just a car, without any floor, floating.

[RiscadoA]

We discussed this in the face to face meeting and decided that the engine samples should all be 'plugin specific', thus we should remove the movement part and leave only the loading a grid and palette part.