Page MenuHomeWildfire Games

Adding cheat codes to the manual
AbandonedPublic

Authored by Langbart on Feb 20 2021, 2:56 PM.

Details

Reviewers
None
Group Reviewers
Restricted Owners Package(Owns No Changed Paths)
Trac Tickets
#4918
Summary

This diff has the intention to add the content of the wiki article Manual_Cheats to the game manual. So it can be accessed even if someone is playing offline.

Possible problem(s):
I'm worried about translation problems, for example if someone translates "i want pizza" into Italian, the generated translation has no effect when entering the cheat code in the chat menu.

Test Plan
  1. Approve the layout.
  2. Check for completeness. You will notice that the link from the wiki article for "retro me" is not included in this diff. I wasn't sure if I should include it or not, so I left it out. Its this link https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/audio/music

Diff Detail

Repository
rP 0 A.D. Public Repository
Branch
/ps/trunk
Lint
Lint OK
Unit
No Unit Test Coverage
Build Status
Buildable 15749
Build 34753: arc lint + arc unit

Event Timeline

Langbart created this revision.Feb 20 2021, 2:56 PM
Owners added a subscriber: Restricted Owners Package.Feb 20 2021, 2:56 PM
Langbart requested review of this revision.Feb 20 2021, 2:56 PM
Silier added a reviewer: Restricted Owners Package.Feb 20 2021, 3:14 PM
Langbart edited the summary of this revision. (Show Details)Feb 21 2021, 4:15 AM
Langbart edited the test plan for this revision. (Show Details)
Langbart updated this revision to Diff 16056.Feb 23 2021, 9:02 PM
Langbart edited the summary of this revision. (Show Details)

Fixed small bug with double-named subject and revised layout to better match the manual

Freagarach added inline comments.
binaries/data/mods/public/gui/manual/intro.txt
159

Perhaps exaples for these?

Wouldn't it be better to load them directly from the simulation/data/cheats/*.json files? Like what @s0600204 did for the civilization bonuses etc. in the civilization overviews?

Sounds like a globalscript, the cheats (and their actions) in JSON/JS files in data. Nice, doable, but out of scope for this patch, IMHO.

@Nescio I created a ticket for it: #6083.

Nescio added a comment.Mar 2 2021, 9:08 PM

While it would be nice to list the cheats and their descriptions somewhere in game, I'm not sure this patch is the best approach. They're listed in yet another location, making things harder to maintain. Moreover, it means more work for translators (especially if this is only a temporary solution). And as you already pointed out in the summary, the cheats themselves shouldn't be prompted for translation, only their descriptions. Also, I'm not sure how many players would expect to find the cheats listed in the manual?
Perhaps you could try adding a separate page for cheats (cf. Catafalques), and do it with JavaScript, JSON, or XML, to allow limiting what gets translated and what not?
(The entire intro.txt ought to be replaced, but that aside.)

Langbart abandoned this revision.Mar 21 2022, 12:23 AM