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

Add interactive examples and clean up existing ones #789

Open
corwinkuiper opened this issue Oct 17, 2024 · 3 comments
Open

Add interactive examples and clean up existing ones #789

corwinkuiper opened this issue Oct 17, 2024 · 3 comments
Labels
good first issue Good for newcomers

Comments

@corwinkuiper
Copy link
Collaborator

We have an examples page on the agb website that we haven't publicised due to the examples being rather poor in this context. Ideally the examples would be interactive and visually interesting from the automatically generated screenshot.

Furthermore some examples should just be removed for a lack of anything interesting.

@corwinkuiper corwinkuiper added the good first issue Good for newcomers label Oct 17, 2024
@flydecahedron
Copy link

Happy to help out with this. Here's my thoughts on making the examples better:

  • An example game that uses a recommended workflow
    • tiled, aseprite, tracker, .wav sound effects
    • as simple as possible. Perhaps a "clicker" game?
  • Find/make an example tileset in the style of classic gba games to make the screenshots pop
  • Focus on most used features i.e. sprites & tiled backgrounds vs bitmap modes.
  • top level rustdoc comment giving a summary.
  • Include the code of the example on the published page, like how bevy does it.

@corwinkuiper
Copy link
Collaborator Author

Include the code of the example on the published page, like how bevy does it.

This is already something we do, see https://agbrs.dev/examples/chicken for example.

We also have game examples that show the workflow, I don't think the agb examples should be large enough to need to show workflows.

@flydecahedron
Copy link

Huh weird, either the code wasn't rendering on my browser or I was blind when I checked last 🤷 Cool that it's already setup like that, though!

Maybe describing the workflows would fit better in the book/tutorial, then? I think it would be nice have a singular place to show the current recommended way to make maps, write songs, etc. The workflows in the game examples seem to have evolved over time.

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

No branches or pull requests

2 participants