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

Plugins memo for newcomers #3

Closed
Pierstoval opened this issue Apr 2, 2021 · 3 comments
Closed

Plugins memo for newcomers #3

Pierstoval opened this issue Apr 2, 2021 · 3 comments

Comments

@Pierstoval
Copy link

Hey, Rust newbie here, and I just discovered this great game template, and I think it definitely helped me a lot in understanding how Bevy works!

However, since there's a lot of code in here in the src directory, I made myself a small "memo" to list all the plugins and what they're used for.

It's there: https://github.com/Pierstoval/TestBevy/blob/main/memo.md

Do you think this could somehow be added to this project's documentation somehow, with rewrites and adaptations of course?

I think some plugins could refer to very specific documentation pages on Bevy docs, like transformations, audio, or assets.

WDYT?

@NiklasEi
Copy link
Owner

NiklasEi commented Apr 2, 2021

I like it!

The section about the Plugins defined in the example game would be a nice addition to the readme I think. If you like, you could open a PR.

I think the DefaultPlugins section could be very fitting in general Bevy documentation like the official Bevy book or the Bevy cheatbook. We could then link to it when explaining the Plugins in the example game.

The FrameTimeDiagnosticsPlugin and LogDiagnosticsPlugin are both Bevy Plugins for game diagnostics. The first gathers diagnostics on every frame (e.g. time per frame) and the second logs such info, so you can have a look at it in the console while testing your game.

@alice-i-cecile
Copy link

alice-i-cecile commented Apr 13, 2021

I think the DefaultPlugins section could be very fitting in general Bevy documentation like the official Bevy book or the Bevy cheatbook. We could then link to it when explaining the Plugins in the example game.

Very much agree; a PR for this to Bevy itself would be welcome <3

@NiklasEi
Copy link
Owner

I will close this for now. Feel free to open a PR in case you want to add the memo to the readme 🙂

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

3 participants