Make some hardcoded terms customizable #414

ghost · 2021-03-03T17:06:28Z

This PR adds the following database settings:

Term 200: Item number separator
Term 201: Skill cost separator
Term 202: Equipment window arrow
Term 203: Status scene Name
Term 204: Status scene Class
Term 205: Status scene Title
Term 206: Status scene Condition
Term 207: Status scene Front
Term 208: Status scene Back
Term 209: Order scene Confirm
Term 210: Order scene Redo
Term 211: RPG Maker 2003 battle monster Double Attack notification
Term 212: RPG Maker 2003 battle monster Defend notification
Term 213: RPG Maker 2003 battle monster Observe notification
Term 214: RPG Maker 2003 battle monster Charge notification
Term 215: RPG Maker 2003 battle monster Self-Destruct notification
Term 216: RPG Maker 2003 battle monster Escape notification
Term 217: Message for back and pincer attack

Ghabry · 2021-03-03T17:17:03Z

Thanks for the PR :).

Some minor changes I ask for:

The hex numbers in the CSV should be lower case for consistency reasons
screen should be scene as we call them this way
frnt should be imo front (the original name is just bad ^^')

What is special_combat_back?

This is not mandatory but in some cases it makes your life easier (simpler rebasing, you can just nuke the 2nd commit) when contributing to liblcf when you make two commits:
First commit has the csv change, second commit has the auto-generated stuff.

Ghabry · 2021-03-03T17:23:37Z

There is one problem with that non-printable sentinel value that doesn't matter for savegames but for other files:

Due to our ForEachString code that sentinel value will be seen by lcftrans and written into the po-translation files. I don't really want to add special handling everywhere because of this.
Maybe a more "print-friendly" sentinel can be picked here?

For the translation code we also use some "in-band signalling" stuff that has the structure <easyrpg:some_text> so one could use something like <easyrpg:default_term> maybe?

ghost · 2021-03-03T17:34:06Z

special_combat_back is a new feature: A message which appears on battle start in back and pincer attack battles.

ghost · 2021-03-03T17:40:40Z

Well, while the first hex value in the fields_easyrpg.csv file is lowercase, in the fields.csv file the hex values are written uppercase. Would it make sense to write all hex values uppercase then?

Ghabry · 2021-03-03T17:42:56Z

right. Make all upper case instead. 😅

ghost · 2021-03-03T17:51:27Z

Addressed the issues in the first comment now.

ghost · 2021-03-03T18:01:08Z

Unfortunately I'm lost on your second comment due to my lack of knowledge about lcftrans. I don't understand this "in-band signaling stuff". And I take any suggestion for a "print-friendly" sentinel, because I haven't got any good ideas for a "print-friendly" sentinel value.

Ghabry · 2021-03-03T18:16:50Z

lcftrans creates translation files. They are basicly a mapping of source to target string, e.g.

msgctx "terms"
msgid "Source string"
msgstr "your translation here"

So the "Source string" must be something that is printable. But yeah lets wait for other suggestions.

In-Band-Signalling means that e.g. in a protocol when transfering text you have special text strings that indicate commands that shall be executed. We use something like this in lcftrans, e.g. when you translate a page with "easyrpg:delete_page" the message box is deleted completely.

ghost · 2021-03-04T18:36:49Z

Maybe we can use default_term as "print-friendly" sentinel. I don't think anyone is going to name a game term "default_term".

Ghabry · 2021-03-04T18:44:38Z

Or <default_term> is even more unlikely :D. I'm okay with this

ghost · 2021-03-04T19:02:14Z

I went with default_term (without angle brackets) now. Adding the angle brackets is a good idea in general but I see conflict potential in connection with XML.

Ghabry · 2021-03-04T19:27:28Z

Sorry now I got one more idea 😅. You have these nice descriptions of the fields in your pr message. You could put them in the CSV as last argument (instead of "String")

Anyway you get my approval now

The following database settings have been added: - Term 200: Item number separator - Term 201: Skill cost separator - Term 202: Equipment window arrow - Term 203: Status scene Name - Term 204: Status scene Class - Term 205: Status scene Title - Term 206: Status scene Condition - Term 207: Status scene Front - Term 208: Status scene Back - Term 209: Order scene Confirm - Term 210: Order scene Redo - Term 211: RPG Maker 2003 battle monster Double Attack notification - Term 212: RPG Maker 2003 battle monster Defend notification - Term 213: RPG Maker 2003 battle monster Observe notification - Term 214: RPG Maker 2003 battle monster Charge notification - Term 215: RPG Maker 2003 battle monster Self-Destruct notification - Term 216: RPG Maker 2003 battle monster Escape notification - Term 217: Message for back and pincer attack

ghost · 2021-03-04T19:52:41Z

Your proposal is a good one, this makes understanding some settings easier. I have updated this PR accordingly.

Ghabry · 2021-03-05T00:50:38Z

jenkins: test this please

Ghabry · 2021-03-08T16:57:50Z

@rueter37
Could you prepare a Player patch in a branch that implements the terms that DONT conflict with matthews battle PR? (want to avoid rebase chaos here)

ghost · 2021-03-08T17:58:18Z

@Ghabry here you go: https://github.com/rueter37/player/tree/custom-terms-1. It contains the non-battle related terms.

Ghabry · 2021-03-08T18:22:22Z

This doesnt look very invasive. Nice!
I'm not a fan of the ternarys though (hard to read here). Let me think about a better way.

Ghabry · 2021-03-08T23:28:47Z

Here is a patch that adds a new function to lcf::rpg::Terms (TermOrDefault):

https://gist.githubusercontent.com/Ghabry/e3350f25fbc8ae6a3e977c9a1e34749f/raw/c2e0365fa6547b415a3278691c51dd24ffa38c11/0001-Add-Terms-TermOrDefault.patch

You can apply the patch in the liblcf dir with git am < 0001-Add-Terms-TermOrDefault.patch

Example Usage in the Player:

lcf::rpg::Terms::TermOrDefault(lcf::Data::terms.easyrpg_order_scene_confirm, "Confirm")

Generator: Support static functions

ghost · 2021-03-09T16:38:22Z

I have added your patch now and updated https://github.com/rueter37/player/tree/custom-terms-1 using the new TermOrDefault function now.

Ghabry · 2021-03-09T18:01:27Z

Jenkins: test this please. This is still some damage from the server error ... -_-

Ghabry · 2021-03-09T18:11:43Z

Thanks. You can file the PR against Player now.
Have to think now how to integrate this into the editor 😅

This pull requests add some EasyRPG-customizable terms. They will only work in EasyRPG, and will be overriden if someone attemps to edit the project in RPG Maker 2000/2003. Some allow to replace hardcoded things (like terms in the Status scene), while others allow to customise messages per item or per skill. * Introduced in [liblcf#419](EasyRPG/liblcf#419) * `@easyrpg_using_message` in `RPG::Item`: per-item custom message about using the item, * `@easyrpg_battle_message_2k3` in `RPG::Skill`: per-skill custom message about using the skill, * `easyrpgAnnBattleItem2k3` term: generic message before using a skill (allows %S, %O placeholders) * `easyrpgAnnBattleSkill2k3` term: generic message before using an item (allows %S, %O, %U placeholders) * Introduced in [liblcf#414](EasyRPG/liblcf#414): * ``easyrpgItemNumberSeparator`` term: Item number separator * ``easyrpgSkillCostSeparator`` term: Skill cost separator * ``easyrpgEquipmentArrow`` term: Equipment window arrow * ``easyrpgStatusSceneName`` term: Status scene Name * ``easyrpgStatusSceneClass`` term: Status scene Class * ``easyrpgStatusSceneTitle`` term: Status scene Title * ``easyrpgStatusSceneCondition`` term: Status scene Condition * ``easyrpgStatusSceneFront`` term: Status scene Front * ``easyrpgStatusSceneBack`` term: Status scene Back * ``easyrpgOrderSceneConfirm`` term: Order scene Confirm * ``easyrpgOrderSceneRedo`` term: Order scene Redo * ``easyrpgAnnBattleDoubleAttack2k3`` term: RPG Maker 2003 battle monster Double Attack notification * ``easyrpgAnnBattleDefend2k3`` term: RPG Maker 2003 battle monster Defend notification * ``easyrpgAnnBattleObserve2k3`` term: RPG Maker 2003 battle monster Observe notification * ``easyrpgAnnBattleCharge2k3`` term: RPG Maker 2003 battle monster Charge notification * ``easyrpgAnnBattleSelfdestruct2k3`` term: RPG Maker 2003 battle monster Self-Destruct notification * ``easyrpgAnnBattleEscape2k3`` term: RPG Maker 2003 battle monster Escape notification * ``easyrpgAnnBattleSpecialCombatBack2k3`` term: Message for back and pincer attack

This pull requests add some EasyRPG-customizable terms. To allow making optional terms, Terms is rewritten from an array into a normal object. The newly-added terms will only work in EasyRPG, and will be overriden if someone attemps to edit the project in RPG Maker 2000/2003. Some allow to replace hardcoded things (like terms in the Status scene), while others allow to customise messages per item or per skill. * Introduced in [liblcf#419](EasyRPG/liblcf#419) * `@easyrpg_using_message` in `RPG::Item`: per-item custom message about using the item, * `@easyrpg_battle_message_2k3` in `RPG::Skill`: per-skill custom message about using the skill, * `easyrpgAnnBattleItem2k3` term: generic message before using a skill (allows %S, %O placeholders) * `easyrpgAnnBattleSkill2k3` term: generic message before using an item (allows %S, %O, %U placeholders) * Introduced in [liblcf#414](EasyRPG/liblcf#414): * ``easyrpgItemNumberSeparator`` term: Item number separator * ``easyrpgSkillCostSeparator`` term: Skill cost separator * ``easyrpgEquipmentArrow`` term: Equipment window arrow * ``easyrpgStatusSceneName`` term: Status scene Name * ``easyrpgStatusSceneClass`` term: Status scene Class * ``easyrpgStatusSceneTitle`` term: Status scene Title * ``easyrpgStatusSceneCondition`` term: Status scene Condition * ``easyrpgStatusSceneFront`` term: Status scene Front * ``easyrpgStatusSceneBack`` term: Status scene Back * ``easyrpgOrderSceneConfirm`` term: Order scene Confirm * ``easyrpgOrderSceneRedo`` term: Order scene Redo * ``easyrpgAnnBattleDoubleAttack2k3`` term: RPG Maker 2003 battle monster Double Attack notification * ``easyrpgAnnBattleDefend2k3`` term: RPG Maker 2003 battle monster Defend notification * ``easyrpgAnnBattleObserve2k3`` term: RPG Maker 2003 battle monster Observe notification * ``easyrpgAnnBattleCharge2k3`` term: RPG Maker 2003 battle monster Charge notification * ``easyrpgAnnBattleSelfdestruct2k3`` term: RPG Maker 2003 battle monster Self-Destruct notification * ``easyrpgAnnBattleEscape2k3`` term: RPG Maker 2003 battle monster Escape notification * ``easyrpgAnnBattleSpecialCombatBack2k3`` term: Message for back and pincer attack

ghost mentioned this pull request Mar 3, 2021

List of custom EasyRPG terms EasyRPG/Player#2362

Closed

15 tasks

Ghabry approved these changes Mar 4, 2021

View reviewed changes

Ghabry requested review from fmatthew5876, carstene1ns and fdelapena March 5, 2021 14:17

carstene1ns approved these changes Mar 5, 2021

View reviewed changes

fdelapena approved these changes Mar 5, 2021

View reviewed changes

Add Terms::TermOrDefault

702b5c4

Generator: Support static functions

Ghabry added the Chunks label Mar 9, 2021

Ghabry added the Enhancement label Mar 9, 2021

Ghabry added this to the 0.6.3 milestone Mar 9, 2021

Ghabry merged commit cd7710d into EasyRPG:master Mar 9, 2021

ghost deleted the custom-terms branch March 9, 2021 18:35

rohkea mentioned this pull request Jun 12, 2021

Add new EasyRPG strings (terms and skill/item usage messages) 20kdc/gabien-app-r48#54

Merged

Make some hardcoded terms customizable #414

Make some hardcoded terms customizable #414

ghost commented Mar 3, 2021 •

edited by ghost

Ghabry commented Mar 3, 2021

Ghabry commented Mar 3, 2021 •

edited

ghost commented Mar 3, 2021

ghost commented Mar 3, 2021

Ghabry commented Mar 3, 2021

ghost commented Mar 3, 2021

ghost commented Mar 3, 2021

Ghabry commented Mar 3, 2021

ghost commented Mar 4, 2021

Ghabry commented Mar 4, 2021

ghost commented Mar 4, 2021

Ghabry commented Mar 4, 2021

ghost commented Mar 4, 2021

Ghabry commented Mar 5, 2021

Ghabry commented Mar 8, 2021

ghost commented Mar 8, 2021

Ghabry commented Mar 8, 2021

Ghabry commented Mar 8, 2021

ghost commented Mar 9, 2021

Ghabry commented Mar 9, 2021

Ghabry commented Mar 9, 2021

Make some hardcoded terms customizable #414

Make some hardcoded terms customizable #414

Conversation

ghost commented Mar 3, 2021 • edited by ghost

Ghabry commented Mar 3, 2021

Ghabry commented Mar 3, 2021 • edited

ghost commented Mar 3, 2021

ghost commented Mar 3, 2021

Ghabry commented Mar 3, 2021

ghost commented Mar 3, 2021

ghost commented Mar 3, 2021

Ghabry commented Mar 3, 2021

ghost commented Mar 4, 2021

Ghabry commented Mar 4, 2021

ghost commented Mar 4, 2021

Ghabry commented Mar 4, 2021

ghost commented Mar 4, 2021

Ghabry commented Mar 5, 2021

Ghabry commented Mar 8, 2021

ghost commented Mar 8, 2021

Ghabry commented Mar 8, 2021

Ghabry commented Mar 8, 2021

ghost commented Mar 9, 2021

Ghabry commented Mar 9, 2021

Ghabry commented Mar 9, 2021

ghost commented Mar 3, 2021 •

edited by ghost

Ghabry commented Mar 3, 2021 •

edited