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

added globalEvents flags json and documentation md file #45

Closed
wants to merge 10 commits into from

Conversation

DetKewlDog
Copy link

@DetKewlDog DetKewlDog commented Jun 5, 2024

Figured this out using @jgaribsin 's globalEvents historical dump a while ago but I've noticed it's still not in this repo. Thought I might as well add it myself :)

// status endpoint
{
  // ...
  "globalEvents": [
    {
      "eventId": 1499087,
      "id32": 0,
      "portraitId32": 0,
      "title": "BRIEFING",
      "titleId32": 2908633975,
      "message": "...",
      "messageId32": 46181626,
      "race": 1,
      "flag": 1, // <-- This is the flag value i documented
      "assignmentId32": 2311178494,
      "effectIds": [],
      "planetIndices": []
    }
  ],
  // ...
}

@chatterchats
Copy link
Collaborator

Please modify jrd.tree to include the update file. I also recommend adding pages to your fork repo to test your changes to the documentation

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not entirely a fan of the name 'blank' for the workflow file, not particularly descriptive.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah i was trying to figure out gh pages, I'll delete it

Writerside/topics/globalEvents_flags.md Show resolved Hide resolved
## dictionary
This json contains a dictionary of key: value pairs, representing the globalEvent flag (which correlates to its type) returned from the Helldivers 2 Status API endpoint.

```json
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would avoid copying the contents of globalEvents_flags here as any update to that file would also need to be made here.
Preferably link to the file itself to make maintenance easier

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall documentation could use work, it reads a little choppy still.
Try moving away from the 'dictionary' style of documentation and describe what global events are, point out which property indicates the global event, and in the example I'm missing what JSON you're showing (is this a planet, dispatch, ...)

@DetKewlDog DetKewlDog closed this Aug 6, 2024
@dealloc
Copy link
Member

dealloc commented Aug 7, 2024

@DetKewlDog how comes we closed this PR?
some small changes and I feel this could've been ready to merge

@DetKewlDog
Copy link
Author

Couldn't find the time to work on it and I didn't want it to stay open for no reason :(

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

Successfully merging this pull request may close these issues.

4 participants