patchFreeciv - Patches: patch #3351, Allow rulesets to override the...

Show feedback again

patch #3351: Allow rulesets to override the default helpdata.txt?

Submitted by:  Jacob Nevins <jtn>
Submitted on:  Sun 01 Jul 2012 10:24:18 AM UTC  
Category: NonePriority: 5 - Normal
Status: Need InfoPrivacy: Public
Assigned to: NoneOpen/Closed: Open
Planned Release: 2.6.0

Add a New Comment (Rich MarkupRich Markup):

You are not logged in

Please log in, so followups can be emailed to you.


Sun 01 Jul 2012 04:17:20 PM UTC, comment #1:

> I've no evidence of demand for this feature, it's just something
> that's occurred to me while rewriting the default helpdata.txt.

I'm not as experienced in attempts to make helpdata.txt ruleset agnostic as you, but I assume that it's not the way that would ever work (give all the required information in a sensible way, yet be correct with every ruleset) no matter how much we try. So yes, something like this is needed. Details to mitigate the problems you mention have to be considered carefully, but I think this should be in 2.6 (if not 2.5) roadmap.

Marko Lindqvist <cazfi>
Project Administrator
Sun 01 Jul 2012 10:24:18 AM UTC, original submission:

An idea I've been toying with for a while. Has problems, so may end up rejected.

The supplied helpdata.txt containing help on basic Freeciv concepts -- cities, happiness, production, etc -- and the basic help structure bends over backwards to not be specific to the supplied rulesets, and yet it's still not an ideal reference for any ruleset that departs radically from the norm.

I've been wondering for a while if we should make it possible for keen ruleset authors to replace all (or part) of it with their own helpdata.txt customised to their ruleset.

I've no evidence of demand for this feature, it's just something that's occurred to me while rewriting the default helpdata.txt.

The main problem with this idea is that the ruleset is on the server but helpdata.txt is on the client. So the association would require downloading a client-side modpack (perhaps not a problem for the kind of full-service modpack we're talking about -- probably if it has its own help, it has its own tileset as well), and the server would need to at most hint at its location, similar to "preferred_tileset".

I'm nervous of sending helpdata.txt over the network from the server -- quite apart from being big, it would likely end up localised in the server language rather than the client language. Even if we supply the msgids over the network, that would lead to poor user experience in the default case where client and server versions were different and help text changed in a minor way between them -- client would see some paragraphs not localised.

Jacob Nevins <jtn>
Project Administrator


(Note: upload size limit is set to 1024 kB, after insertion of the required escape characters.)

Attach File(s):

No files currently attached


Depends on the following items: None found

Items that depend on this one: None found


Carbon-Copy List
  • -unavailable- added by cazfi (Posted a comment)
  • -unavailable- added by jtn (Submitted the item)

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.


    Please enter the title of George Orwell's famous dystopian book (it's a date):



    Follow 2 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Sun 01 Jul 2012 04:17:20 PM UTCcazfiPriority3 - Low=>5 - Normal
      Planned Release=>2.6.0
    Show feedback again

    Back to the top

    Powered by Savane 3.1-cleanup