Move configs to new Unit Parameters DB and Max HP limits by guilherme-gm · Pull Request #3214 · HerculesWS/Hercules

guilherme-gm · 2023-06-08T15:13:33Z

Pull Request Prelude

I have followed proper Hercules code styling.
I have read and understood the contribution guidelines before making this PR.
I am aware that this PR may be closed if the above-mentioned criteria are not fulfilled.

Changes Proposed

This PR creates a new db file called Unit Parameters DB and moves a few battle configs to it:

NaturalHealWeightRate
MaxASPD
MaxHP
MaxStats

The reason to move those settings is that:

We will need different values between RE and Pre-RE (e.g. MaxHP, NaturalHealWeightRate)
We already have more than one different setting for it due to job differencs (MaxASPD, MaxStats)

Thus having this new file allows us to link jobs to parameter groups for each server type.

Finally, a small change but an actual new content: This PR also adds the maximum HP based on users level. A change introduced in kRO's episode 15.1

Huge thanks to Haru and 4144 for the discussions on this :)

Issues addressed: MaxHP limits item from #243

For users upgrading their Hercules copy

(I plan to also post this on herc board once the PR gets in a release)

There are 3 changes introduced in this PR that may affect you.

1. job_db.conf update

If you are using Hercules' default db folder (db/pre-re/job_db.conf or db/re/job_db.conf) this should get merged automatically.

For custom folders, please check the original Hercules' job_db.conf and replicate the ParametersGroup of each job. Using the same values as in Hercules' original file will make the other 2 changes easier to migrate.

2. You must have the new `unit_parameters_db.conf` db file

If you are using Hercules' default db folder (db/pre-re/ or db/re/) this should get merged automatically.

For custom folders, please copy db/(pre-re|re)/unit_parameters_db.conf to your own db folder (based on your server type).

Those will already come with the default configs and groups that you needed in step 1.

3. Migrate configs from `conf/battle/player.conf`

If you have customized any of the configs changed in this PR, you may have to update your unit_parameters_db.conf with the new values. Below you will find each battle config and how they map to the new unit_parameters_db.conf.

the first column mentions the existing battle conf name
the second column mentions the field in unit parameters db equivalent to this config (Note: Also look the 3rd column)
the third column mentions for which group(s) this config applies (for example: a 3rd job-only config will affect only 3rd job groups)
the fourth column gives you some notes, like whether you can remove or not this config and why.

player.conf	Parameter Field	Parameter Group	Notes
`natural_heal_weight_rate`	`NaturalHealWeightRate`	`Base`	This config may be removed from your player.conf, it is no longer used.
`max_aspd`	`MaxASPD`	`Base`	This config should be kept in your player.conf, since it is still used for homunculus and as fallback for players
`max_third_aspd`	`MaxASPD`	`ThirdClasses` `SuperNovice`	This config may be removed from your player.conf, it is no longer used.
`max_hp`	`MaxHP`	`Base`	This config may be removed from your player.conf, it is no longer used. You may be interested in the level grouping (check docs)
`max_parameter`	`MaxStats`	`Base`	This config should be kept in your player.conf, since it is still used for some skills/npc logic
`max_third_parameter`	`MaxStats`	`ThirdClasses`	This config should be kept in your player.conf, since it is still used for some skills/npc logic
`max_extended_parameter`	`MaxStats`	`ExtendedClasses`	This config may be removed from your player.conf, it is no longer used.
`max_summoner_parameter`	`MaxStats`	`Summoner`	This config may be removed from your player.conf, it is no longer used.
`max_baby_parameter`	`MaxStats`	`BabyBase`	This config may be removed from your player.conf, it is no longer used.
`max_baby_third_parameter`	`MaxStats`	`BabyThirdClasses`	This config may be removed from your player.conf, it is no longer used.

src/map/battle.c

this will make it easier to extend with new deprecations/removals

this new db will allow splitting certain battle configs into pre-re/re versions and fine tune them in configuration groups associated to each job. this commit only contains the base file reading. fields will come in follow up commits

src/map/pc.h

- this removed max_hp battle config - it is now possible to create different MaxHP values depending on the player's level

From Episode 15.1 update - from Lvl 1 to Lvl 99: 330,000 - from Lvl 100 to Lvl 150: 660,000 - from LVl 151 to Lvl 175: 1,100,000

max_third_aspd battle conf is also removed because it can be set using unit parameters

- pc_maxparemeter macro is also renamed to pc_maxstats - some max_parameter configs are kept because they are required for other logics

this prepares the code for future renewal update where natural heal weight has changed. - pc_is50overweight macro is now called pc_isoverhealweight to avoid confusion

Asheraf reviewed Jun 8, 2023

View reviewed changes

src/map/battle.c Show resolved Hide resolved

guilherme-gm added 2 commits June 8, 2023 19:08

move battle config deprecation checks to a separate function

ba3b614

this will make it easier to extend with new deprecations/removals

implements unit parameters db loading and job link

ae63871

this new db will allow splitting certain battle configs into pre-re/re versions and fine tune them in configuration groups associated to each job. this commit only contains the base file reading. fields will come in follow up commits

guilherme-gm force-pushed the parameters-db branch 2 times, most recently from 09b1837 to 6fec984 Compare June 8, 2023 23:03

MishimaHaruna added this to the Release v2023.06.14 milestone Jun 14, 2023

MishimaHaruna requested changes Jun 14, 2023

View reviewed changes

src/map/pc.h Outdated Show resolved Hide resolved

src/map/pc.h Outdated Show resolved Hide resolved

guilherme-gm added 6 commits June 14, 2023 20:00

move MaxHP config to unit parameters db

cc228fc

- this removed max_hp battle config - it is now possible to create different MaxHP values depending on the player's level

update player MaxHP to cap based on level

169b2e9

From Episode 15.1 update - from Lvl 1 to Lvl 99: 330,000 - from Lvl 100 to Lvl 150: 660,000 - from LVl 151 to Lvl 175: 1,100,000

move player's MaxASPD to unit parameters db

1ab5b89

max_third_aspd battle conf is also removed because it can be set using unit parameters

move player max stats config to unit parameter db

a6ac280

- pc_maxparemeter macro is also renamed to pc_maxstats - some max_parameter configs are kept because they are required for other logics

move natural hp recovery to unit parameters db

38633f3

this prepares the code for future renewal update where natural heal weight has changed. - pc_is50overweight macro is now called pc_isoverhealweight to avoid confusion

add documentation for unit parameters db

6915e41

guilherme-gm force-pushed the parameters-db branch from 6fec984 to 6915e41 Compare June 14, 2023 23:03

MishimaHaruna approved these changes Jun 15, 2023

View reviewed changes

MishimaHaruna merged commit 93a3f4f into HerculesWS:master Jun 15, 2023

guilherme-gm deleted the parameters-db branch June 15, 2023 23:21

skyleo mentioned this pull request Sep 21, 2024

Add *getunitparam to obtain values set via unit_parameters_db.conf in scripts #3323

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move configs to new Unit Parameters DB and Max HP limits#3214

Move configs to new Unit Parameters DB and Max HP limits#3214
MishimaHaruna merged 8 commits intoHerculesWS:masterfrom
guilherme-gm:parameters-db

guilherme-gm commented Jun 8, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

guilherme-gm commented Jun 8, 2023

Pull Request Prelude

Changes Proposed

For users upgrading their Hercules copy

1. job_db.conf update

2. You must have the new unit_parameters_db.conf db file

3. Migrate configs from conf/battle/player.conf

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

2. You must have the new `unit_parameters_db.conf` db file

3. Migrate configs from `conf/battle/player.conf`