games/vcmi
1
0
Fork 0
mirror of https://github.com/vcmi/vcmi.git synced 2024-12-22 22:13:35 +02:00
Code Issues Releases Activity
edbf555695
vcmi/docs/modders/Bonus_Format.md

94 lines
2.2 KiB
Markdown
Raw Normal View History

fix headings of md files
2024-07-16 20:29:20 +02:00
# Bonus Format
Modders docs update iteration
2023-09-01 11:11:35 +02:00
## Full format
First part of documentation import
2023-08-12 11:39:44 +02:00
All parameters but type are optional.
Use json instead of json5 for syntax highlight in docs Looks like website only recognizes javascript & json, and is not aware of jsonc or json5. Will result in small regression on Github web view - comments will show up as red (since comments are not part of json format), but syntax highlight would work both on website and on Github. Alternative is using javascript for syntax highlight, however syntax highlighter for json looks better on both website and Github (since it uses separate highlighting for json keys, separate from strings in values)
2024-12-04 18:50:01 +02:00
```json
First part of documentation import
2023-08-12 11:39:44 +02:00
{
Update bonuses docs
2023-09-23 18:24:20 +02:00
// Type of the bonus. See Bonus Types for full list
Updated modders docs
2023-09-01 00:30:26 +02:00
"type": "BONUS_TYPE",
Update bonuses docs
2023-09-23 18:24:20 +02:00
// Subtype of the bonus. Function depends on bonus type.
Updated modders docs
2023-09-01 00:30:26 +02:00
"subtype": 0,
Update bonuses docs
2023-09-23 18:24:20 +02:00
// Value of the bonus. Function depends on bonus type.
Updated modders docs
2023-09-01 00:30:26 +02:00
"val" : 0,
Update bonuses docs
2023-09-23 18:24:20 +02:00
// Describes how this bonus is accumulated with other bonuses of the same type
Updated modders docs
2023-09-01 00:30:26 +02:00
"valueType": "VALUE_TYPE",
Update bonuses docs
2023-09-23 18:24:20 +02:00
// Additional info that bonus might need. Function depends on bonus type.
Updated modders docs
2023-09-01 00:30:26 +02:00
"addInfo" : 0, // or [1, 2, ...]
First part of documentation import
2023-08-12 11:39:44 +02:00
Update bonuses docs
2023-09-23 18:24:20 +02:00
// How long this bonus should be active until removal.
// May use multiple triggers, in which case first event will remove this bonus
Updated modders docs
2023-09-01 00:30:26 +02:00
"duration" : "BONUS_DURATION", //or ["BONUS_DURATION1", "BONUS_DURATION2", ...]"
Update bonuses docs
2023-09-23 18:24:20 +02:00
// How long this bonus should remain, in days or battle turns (depending on bonus duration)
Updated modders docs
2023-09-01 00:30:26 +02:00
"turns" : 0,
First part of documentation import
2023-08-12 11:39:44 +02:00
Update bonuses docs
2023-09-23 18:24:20 +02:00
// TODO
Updated map object and bonuses documentations
2023-09-12 18:58:15 +02:00
"targetSourceType" : "SOURCE_TYPE",
Update bonuses docs
2023-09-23 18:24:20 +02:00
// TODO
Updated modders docs
2023-09-01 00:30:26 +02:00
"sourceType" : "SOURCE_TYPE",
Update bonuses docs
2023-09-23 18:24:20 +02:00
// TODO
Updated modders docs
2023-09-01 00:30:26 +02:00
"sourceID" : 0,
Update bonuses docs
2023-09-23 18:24:20 +02:00
// TODO
First part of documentation import
2023-08-12 11:39:44 +02:00
"effectRange" : "EFFECT_RANGE",
Updated modders docs
2023-09-01 00:30:26 +02:00
Update bonuses docs
2023-09-23 18:24:20 +02:00
// TODO
Updated modders docs
2023-09-01 00:30:26 +02:00
"limiters" : [
"PREDEFINED_LIMITER", optional_parameters (...), //whhich one is preferred?
{"type" : LIMITER_TYPE, "parameters" : [1,2,3]}
],
Update bonuses docs
2023-09-23 18:24:20 +02:00
// TODO
First part of documentation import
2023-08-12 11:39:44 +02:00
"propagator" : ["PROPAGATOR_TYPE", optional_parameters (...)],
Update bonuses docs
2023-09-23 18:24:20 +02:00
// TODO
Updated modders docs
2023-09-01 00:30:26 +02:00
"updater" : {Bonus Updater},
Update bonuses docs
2023-09-23 18:24:20 +02:00
// TODO
First part of documentation import
2023-08-12 11:39:44 +02:00
"propagationUpdater" : {Bonus Updater, but works during propagation},
Update bonuses docs
2023-09-23 18:24:20 +02:00
// TODO
First part of documentation import
2023-08-12 11:39:44 +02:00
"description" : "",
Update bonuses docs
2023-09-23 18:24:20 +02:00
// TODO
First part of documentation import
2023-08-12 11:39:44 +02:00
"stacking" : ""
}
```
Modders docs update iteration
2023-09-01 11:11:35 +02:00
## Supported bonus types
- [Bonus Duration Types](Bonus/Bonus_Duration_Types.md)
- [Bonus Sources](Bonus/Bonus_Sources.md)
- [Bonus Limiters](Bonus/Bonus_Limiters.md)
- [Bonus Types](Bonus/Bonus_Types.md)
- [Bonus Propagators](Bonus/Bonus_Propagators.md)
- [Bonus Updaters](Bonus/Bonus_Updaters.md)
- [Bonus Range Types](Bonus/Bonus_Range_Types.md)
- [Bonus Value Types](Bonus/Bonus_Value_Types.md)
First part of documentation import
2023-08-12 11:39:44 +02:00
## Subtype resolution
Updated map object and bonuses documentations
2023-09-12 18:58:15 +02:00
All string identifiers of items can be used in "subtype" field. This allows cross-referencing between the mods and make config file more readable.
Update bonuses docs
2023-09-23 18:24:20 +02:00
See [Game Identifiers](Game_Identifiers.md) for full list of available identifiers
Added markdownlint to Github CI - Markdown will now be validated as part of Github CI - Applied auto-fix to most common issues (mostly whitespace related) - Fixed manually some of more complex cases Some valid markdownlint rules are currently disabled, to avoid failing CI, can be enabled in future
2024-11-30 22:20:15 +02:00
First part of documentation import
2023-08-12 11:39:44 +02:00
### Example
Use json instead of json5 for syntax highlight in docs Looks like website only recognizes javascript & json, and is not aware of jsonc or json5. Will result in small regression on Github web view - comments will show up as red (since comments are not part of json format), but syntax highlight would work both on website and on Github. Alternative is using javascript for syntax highlight, however syntax highlighter for json looks better on both website and Github (since it uses separate highlighting for json keys, separate from strings in values)
2024-12-04 18:50:01 +02:00
```json
First part of documentation import
2023-08-12 11:39:44 +02:00
"bonus" :
{
"type" : "HATE",
"subtype" : "creature.enchanter",
"val" : 50
}
```
Added markdownlint to Github CI - Markdown will now be validated as part of Github CI - Applied auto-fix to most common issues (mostly whitespace related) - Fixed manually some of more complex cases Some valid markdownlint rules are currently disabled, to avoid failing CI, can be enabled in future
2024-11-30 22:20:15 +02:00
This bonus makes creature do 50% more damage to Enchanters.
Reference in New Issue Copy Permalink