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

Need for a dedicated coordinate system explanation #35

Open
doglman opened this issue Jul 17, 2023 · 1 comment
Open

Need for a dedicated coordinate system explanation #35

doglman opened this issue Jul 17, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@doglman
Copy link

doglman commented Jul 17, 2023

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.

@doglman doglman added the documentation Improvements or additions to documentation label Jul 17, 2023
@christopolise
Copy link
Contributor

@apal6981 Maybe we could rework this page so that we address some of these questions a little more directly?

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

No branches or pull requests

3 participants