Website Content Update (Tour, and Updating some Tutorials)

[NicholasDewberryOfficial]

I was looking through the documentation of a lot of tutorials and examples, and I thought we could improve a lot of them.

The tours, for example - are simply not finished. We could just add some more stuff.

I also want to prioritize readability and grokability for some of the examples.

Take this one for instance:
https://ebitengine.org/en/examples/infinitescroll.html

• random number constants (the * 16 and / 32, when they should really be called "pixelSize" and "scrollSpeed")
• drawing the image 3 times on the screen (without explaining why)
• using offsets without explaining why

Now, it's good for me as someone more experienced in gamedev because I can repeatedly tweak values to find out what they all mean - but if I was experienced in Go but new to gamedev or vice-versa, I might struggle.

Some examples of good Go tutorials (imo):
https://gobyexample.com/

• Paragraphs are easy to parse, code is simplistic and commented

• The two column view may be hard to implement

https://github.com/charmbracelet/bubbletea/tree/main/examples/credit-card-form

• Variables are named simply
• Goes along with best practices

https://pkg.go.dev/github.com/charmbracelet/bubbletea#Tick

• Lots of code examples of how you would use the functions

https://ebitengine.org/en/documents/cheatsheet.html

• Easy to see basic features at a glance, reference functions

I'll get started on this tonight, hopefully I can PR with some tour stuff soon.

[hajimehoshi]

I also want to prioritize readability and grokability for some of the examples.

If you are talking about the code, send a PR to the ebitengine repository, not here.

I'll get started on this tonight, hopefully I can PR with some tour stuff soon.

Let me hear your plan. Also, do you plan to update the Japanese version?

Thanks,

[NicholasDewberryOfficial]

Hello! Sorry for taking so long to respond.

If you are talking about the code, send a PR to the ebitengine repository, not here.If you are talking about the code, send a PR to the ebitengine repository, not here.

Okay, I'll keep that in mind. I was mostly looking to add/modify some stuff in the _ebitengine.org/site/go/ folder - so ideally none of the core code or functions would be changed.

Let me hear your plan.
The list of my priorities are as follows:

1. adding some more in the Tour of ebiten section (https://ebitengine.org/en/tour/)
2. updating a few of the examples like (https://ebitengine.org/en/examples/infinitescroll.

In terms of timing, It'll hopefully be done in a few weeks. I unfortunately can't devote as much time as I want to this, but I can take some initiative on updating these two things. Again, I want to update the tour first and then some examples later.

Do you plan to update the Japanese version?

😅 Sorry, I don't know Japanese, but I know that Ebiten being in multiple languages is important. I don't think I can help much in that aspect.

[hajimehoshi]

adding some more in the Tour of ebiten section (https://ebitengine.org/en/tour/)

Sure, I'm looking forward to it :-)

updating a few of the examples like (https://ebitengine.org/en/examples/infinitescroll.

I think you have to update github.com/hajimehoshi/ebiten, not here.

😅 Sorry, I don't know Japanese, but I know that Ebiten being in multiple languages is important. I don't think I can help much in that aspect.

Sure, I'll take care of it then.