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

Proposal to Refactor Examples for Better Learning Accessibility #213

Open
guiseek opened this issue Jan 10, 2025 · 0 comments
Open

Proposal to Refactor Examples for Better Learning Accessibility #213

guiseek opened this issue Jan 10, 2025 · 0 comments

Comments

@guiseek
Copy link

guiseek commented Jan 10, 2025

Hello maintainers!

First of all, I want to thank you for this incredible project! Cannon-ES has been instrumental in helping many developers, including myself, integrate physics into our 3D applications.

While exploring the examples provided in the repository, I noticed that many of them rely heavily on the Demo class. While I understand that this abstraction likely simplifies the process of writing and maintaining demos from a maintainers' perspective, it makes it significantly harder for users—especially beginners—to learn from these examples.

The main challenges include:

  • The Demo class encapsulates most of the logic, creating an abstract and "magical" experience.
  • Users struggle to understand the individual steps and components necessary to replicate the examples without relying on the Demo class.
  • This approach hinders the community from reusing the examples directly in their projects, as the logic is tightly coupled to this specific class.

Would it be possible to refactor the examples to make them more standalone? Ideally, each example could focus on explicitly showing the initialization and configuration steps for Cannon-ES, without relying on custom abstractions. This would greatly benefit the community by:

  • Allowing developers to better understand the core concepts of Cannon-ES.
  • Making it easier to adapt the examples to their own projects.
  • Fostering a deeper understanding of how Cannon-ES works under the hood.

I believe such a change would make Cannon-ES even more accessible and appealing to the community, particularly for those just starting out with physics engines.

Thank you for considering this suggestion!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant