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

Update game ids to follow a standard #374

Closed
CosminPerRam opened this issue Oct 7, 2023 · 5 comments
Closed

Update game ids to follow a standard #374

CosminPerRam opened this issue Oct 7, 2023 · 5 comments

Comments

@CosminPerRam
Copy link
Member

CosminPerRam commented Oct 7, 2023

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 id ase, 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.

@dgibbs64
Copy link
Contributor

dgibbs64 commented Oct 8, 2023

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 americasarmy3 however you also run into issues such as csgo which would be too long e.g counterstrikeglobaloffensive.

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.

@podrivo
Copy link
Contributor

podrivo commented Jan 15, 2024

Was this issue addressed with this pull (#415)?

@CosminPerRam
Copy link
Member Author

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).

@podrivo
Copy link
Contributor

podrivo commented Jan 23, 2024

PR with new ids and translation layer merged #496
ID testing issue over at gamedig/rust-gamedig#184

@CosminPerRam
Copy link
Member Author

Fully compliant as per 331d7bb.

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

No branches or pull requests

3 participants