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

Bug: Inconsistency between required fields of NetworkVersion and documented required fields in the network protocol #4339

Open
deefdragon opened this issue Dec 8, 2024 · 0 comments
Labels
is: documentation Improvements or additions to documentation.

Comments

@deefdragon
Copy link

What happened?

The currenet documentation for the network protocol fails to mention that the NetworkVersion type requires a class field. Without this field, the client will be disconnected upon sending the connect request.

The following JSON failed to connect

[
  {
    "cmd": "Connect",
    "game": "Clique",
    "items_handling": 1,
    "name": "TestClique1",
    "password": "",
    "slot_data": true,
    "tags": [],
    "uuid": "058a24c5-f42b-4076-bf1c-6726cbf38030",
    "version": {
      "build": 1,
      "major": 5,
      "minor": 0
    }
  }
]

Whereas the following JSON succeeded.

[
  {
    "cmd": "Connect",
    "game": "Clique",
    "items_handling": 1,
    "name": "TestClique1",
    "password": "",
    "slot_data": true,
    "tags": [],
    "uuid": "333ab09d-d967-45b2-9706-3bc07a71a24f",
    "version": {
      "build": 1,
      "class": "Version",
      "major": 5,
      "minor": 0
    }
  }
]

What were the expected results?

The documentation be updated to include that the class field must be set to Version, or the version data be handled in some way upon connection to no longer require setting that field.

Software

While playing

@ScipioWright ScipioWright added the is: documentation Improvements or additions to documentation. label Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
is: documentation Improvements or additions to documentation.
Projects
None yet
Development

No branches or pull requests

2 participants