ThePhrozenKeep/D2MOO

Document and chose naming convention for coordinates

Open

#107 opened on Apr 10, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (48 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (159 stars)
PR merge metrics
 (PR metrics pending)

Description

There are many types of coordinates systems with various granularity.

  • Cartesion Vs Iso
  • Room, Tile, Subtile, World position, Path
  • GUI coordinates
  • Render data coordinates
  • ...

It would be great to have a clear and concise documentation of what those are, what functions let us convert from one to another, and chose a naming convention for variables / struct members so that we can easily identify what type of coordinates we are talking about.

It might even be interesting to use typedefs (or even strongly typed structs?) to replace the plain int / D2CoordStrc.

A first draft of the documentation is available here https://github.com/ThePhrozenKeep/D2MOO/blob/master/doc/Coordinates.md.

Contributor guide

Research direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.