Skip to content

Need for a dedicated coordinate system explanation #35

@doglman

Description

@doglman

As a new user, it was difficult to understand exactly how the X-Y coordinate system worked. It would have been helpful to have a dedicated explanation typed up in a separate page.

The documentation I could find for this were:

  • The opening paragraph of the Game Display page mentions that "x" and "y" parameters are self-explanatory... before explaining that the origin is on the top-left of the screen (important detail for newbies) and that there is are x_width and y_height properties that can be accessed.
  • Later on in that same page it describes "pixels" as an individual segment of a seven-segment digit.

This leaves some ambiguity that was confusing for a beginner. For example, it was unclear: Does incrementing the value of "x" or "y" by one move an entire seven-segment digit over, or just one segment/pixel?

Experimentation revealed the answer, but a high-level explanation of how the system has been designed would have been a helpful introduction, especially a mention of the default y_height and x_width of the system.

Suggestion: Create a dedicated page explaining the coordinate system being used. This will make it easier to find, instead of forcing users to stumble upon it themselves. Much of the content from the above link can be moved there instead.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions