-
Notifications
You must be signed in to change notification settings - Fork 145
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
Update game ids to follow a standard #374
Comments
Totally agree with this. Setting a standardised naming convention and documenting it will be massively helpful. To reduce possible conflict longer names might be best e.g with LinuxGSM I use shortnames https://github.com/GameServerManagers/LinuxGSM/blob/master/lgsm/data/serverlist.csv and havnt had too many issues. The longest shortname used is 8 characters. |
Was this issue addressed with this pull (#415)? |
Not entirely, there are a few that fails (see CI) and I was thinking on providing a 'translation layer' between the old and new ids (#435 helps a lot regarding this, but I just didn't had the time lately). |
PR with new ids and translation layer merged #496 |
Fully compliant as per 331d7bb. |
What are game ids
Game ids are important lowercase alphanumeric string that we use when specifying a Game.
Currently, there is no standard on how an ID is made.
In #371 I said "lets dont make 2-characters ids anymore" because I didn't thought that id represented the game name, and in other pr's for adding games support, the author decided the game id however they wanted (because there are no rules for this).
What could be done
This issue suggests applying rust-GameDig's id system added in the contributing pr.
Problems
Although it is stated (at the time of making this issue) in the rust-GameDig's readme that "Warning: This project goes through frequent API breaking changes [...]" this is not done so here, the new ID system will break a bunch of ids and although the next release is a major one, breaking changes could be done, but are not preferred.
One solution for this would be to keep the old ids and add the new ones (until another major version comes), but I haven't verified yet if there are any new-old colliding ones (for example, a new game's id would be
ase
but there is already an old idase
, so we cant have both), if this would be possible, I guess its the way to go.This issue keeps track on deciding what to do about this manner.
The text was updated successfully, but these errors were encountered: