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

Add changelog to ETJump menus #1532

Merged
merged 14 commits into from
Nov 14, 2024
Merged

Add changelog to ETJump menus #1532

merged 14 commits into from
Nov 14, 2024

Conversation

Aciz
Copy link
Member

@Aciz Aciz commented Nov 13, 2024

  • CMake configure step parses changelog.md and outputs separate plaintext changelog files for each version into assets/ui/changelog/ - no need to bundle the actual changelog file with the mod, or maintain 2 separate changlogs
  • Changelogs are read from these files and parsed into a std::map, so they don't eat a massive chunk of UI string pool
  • Viewable in-game from ETJump -> Changelog
  • This also fixes bunch of hardcoded constants from the initial dropdown menu implementation, which makes it usable outside of ETJump setttings menu

image
image

fixes #169

Aciz added 9 commits November 12, 2024 07:56
Doing this in CMake means we don't need to actually bundle the changelog.md with the mod
ETJump -> Changelog displays the changelog from a given version (selectable via dropdown menu) in a scrollable textbox.

This also fixes a bunch of hardcoded values from the dropdown menu implementation, making it much more portable outside of the ETJump settings menu layout.
…headers.h

The macro is not needed, initially thought I'd need the headers too but that was not the case.

Including a header guard to version_headers.h since it gets included in ui_main.cpp for reading the changelog files.
Make some of the older entries have proper indentation like newer ones.

Handle bolded text before transforming line starts from * to -, to not break lines starting with ''* **X**'
UI parsers don't support #pragma once
Replaces them with a color escape so they are displayed normally
Just having the numeric version is cleaner and enough.
@Aciz Aciz added the Feature A completely new feature. label Nov 13, 2024
Now that it's used to parse the changelog assets, it makes sense to run CI whenever it's updated.
@Aciz Aciz force-pushed the changelog-menu-ui branch from d67d4e1 to 387bcb3 Compare November 13, 2024 19:54
Use slightly brighter background color in FUI, the readability is fine without the darker background in menus.
@Aciz Aciz force-pushed the changelog-menu-ui branch from b3a5967 to 20d0ec2 Compare November 14, 2024 04:32
@Aciz Aciz force-pushed the changelog-menu-ui branch from f351527 to 98e2800 Compare November 14, 2024 04:53
Was supposed to remove changelog.md instead of .clang_format from the ignored list
@Aciz Aciz added this pull request to the merge queue Nov 14, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to a conflict with the base branch Nov 14, 2024
@Aciz Aciz added this pull request to the merge queue Nov 14, 2024
Merged via the queue into etjump:master with commit da37cc6 Nov 14, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature A completely new feature.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add changelog in ui menus
1 participant