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 Helptext for resources in packaged rulesets #655

Closed
jwrober opened this issue Sep 19, 2021 · 3 comments · Fixed by #2096
Closed

Add Helptext for resources in packaged rulesets #655

jwrober opened this issue Sep 19, 2021 · 3 comments · Fixed by #2096
Labels
changes-network-protocol This issue or PR changes the network protocol documentation Improvements or additions to documentation enhancement New feature or request gui This issue requires changes to the user interface

Comments

@jwrober
Copy link
Collaborator

jwrober commented Sep 19, 2021

Is your feature request related to a problem? Please describe.
We don't provide extra helptext in default packaged ruleset for tile special resources. This leaves help incomplete.

Describe the solution you'd like
Fill in the helptext field for the tile resources in terrain.ruleset for the following rulesets we package:

  • default/civ2civ3
  • classic
  • civ1
  • civ2
  • experimental

Describe alternatives you've considered
None

Additional context
Attempting to make the in game help more immersive with fully populated information on the ruleset being played

@jwrober jwrober added documentation Improvements or additions to documentation Untriaged This issue or PR needs triaging labels Sep 19, 2021
@lmoureaux lmoureaux removed the Untriaged This issue or PR needs triaging label Sep 19, 2021
@jwrober jwrober self-assigned this Nov 21, 2021
@lmoureaux
Copy link
Contributor

lmoureaux commented Dec 6, 2021

PACKET_RULESET_RESOURCE = 177; sc, lsend
UINT8 id;
UINT8 output[O_LAST];
end

@lmoureaux lmoureaux added the changes-network-protocol This issue or PR changes the network protocol label Dec 6, 2021
@jwrober jwrober added gui This issue requires changes to the user interface enhancement New feature or request labels Jan 23, 2022
@jwrober jwrober removed their assignment Aug 12, 2022
@lmoureaux
Copy link
Contributor

Steps:

  1. Add the information to one resource in your favorite ruleset. Make sure to use a _("translatable string")
  2. Add support for loading it in load_terrain_names (ruleset.cpp)
  3. Add a new network capability and a new field to PACKET_RULESET_RESOURCE controlled by this capability
  4. Update send_ruleset_extras, send_ruleset_bases, send_ruleset_roads and the receiving functions to use this information (providing a fallback when it doesn't exist)
  5. Update helpdata.cpp to display the help text

@lmoureaux
Copy link
Contributor

Here is an example commit that changes the network protocol: 76f8524

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changes-network-protocol This issue or PR changes the network protocol documentation Improvements or additions to documentation enhancement New feature or request gui This issue requires changes to the user interface
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants