https://github.com/kaiser-chris/war-goal-framework
A framework designed to add new War Goals to Victoria 3
https://github.com/kaiser-chris/war-goal-framework
framework mod utility victoria3
Last synced: 5 months ago
JSON representation
A framework designed to add new War Goals to Victoria 3
- Host: GitHub
- URL: https://github.com/kaiser-chris/war-goal-framework
- Owner: kaiser-chris
- Created: 2024-12-25T15:06:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-25T15:11:55.000Z (over 1 year ago)
- Last Synced: 2024-12-25T16:19:20.089Z (over 1 year ago)
- Topics: framework, mod, utility, victoria3
- Homepage:
- Size: 979 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Overview
**War Goal Framework** is a mod for Victoria 3.
**THIS MOD IS FEATURE COMPLETE BUT UNTESTED!**
## Caveats / Limitations
- You cannot add War Goals to an existing category.
- Custom Diplomatic Plays need to have a base game War Goal attached, and custom War Goals can only be added additionally. I recommend using War Reparations as a base War Goal and then attaching your custom War Goal to that.
- It is not possible for a custom war goal to modify peace acceptance since the game does not expose peace acceptance as a number but only as a string.
## Add a War Goal Category
**Custom War Goals need to be part of a custom category.**
To create a custom War Goal Category, you will need to create
a new building type that represents the category (See [wgf_example_war_goals.txt](mod/common/buildings/wgf_example_war_goals.txt)):
- The building icon will be the icon used in the War Goal list
- Make sure the building is not shown to the user (potential trigger)
There are a few localization keys needed to make the category show up correctly (See [wgf_example_war_goal_l_english.yml](mod/localization/english/wgf_example_war_goal_l_english.yml)):
- \: Category name shown in the War Goal list
- \_type_name: Internal category name used to connect the category with a War Goal
- \_tooltip: Tooltip shown when hovering over the category in the War Goal list
Also, there needs to be a corresponding Scripted GUI that determines whether to show or hide the category (See [wgf_example_war_goal_sguis.txt](mod/common/scripted_guis/wgf_example_war_goal_sguis.txt))
- The name of the scripted gui needs to be the same as the corresponding building type
- Scope needs to be diplomatic_play
- The is_shown trigger will decide whether to show or hide the category
- The following scopes are available for use in the trigger:
- scope:war_goal = building type that represents the war goal
- scope:target = diplomatic play target
- scope:initiator = diplomatic play initiator
Finally, we need to add the category to the global list of custom War Goal Categories `wgf_custom_war_goals_types`:
```
add_to_global_variable_list = {
name = wgf_custom_war_goals_types
target = bt:wgf_example_war_goal_category
}
```
**NOTE: I recommend doing this in the global history file** (See [00_activate_example_war_goal.txt](mod/common/history/global/00_activate_example_war_goal.txt)).
## Add a War Goal
**Custom War Goals need to be part of a custom category.**
To create a custom War Goal, you will need to create
a new building type that represents the War Goal (See [wgf_example_war_goals.txt](mod/common/buildings/wgf_example_war_goals.txt)):
- The building icon will be the icon used in the War Goal list
- Make sure the building is not shown to the user (potential trigger)
There are a few localization keys needed to make the category show up correctly (See [wgf_example_war_goal_l_english.yml](mod/localization/english/wgf_example_war_goal_l_english.yml)):
- \: War Goal name shown in the War Goal list
- \_type_name: Internal category name used to connect the category with a War Goal
- \_tooltip: Tooltip shown when hovering over the category in the War Goal list
- \_effects_desc: Effect shown in the Diplomatic Play panel when hovering the War Goal
Also, there needs to be a corresponding Scripted GUI that determines whether to show or hide the War Goal (See [wgf_example_war_goal_sguis.txt](mod/common/scripted_guis/wgf_example_war_goal_sguis.txt))
- The name of the scripted gui needs to be the same as the corresponding building type
- Scope needs to be diplomatic_play
- The is_shown trigger will decide whether to show or hide the category
- The following scopes are available for use in the trigger:
- scope:war_goal = building type that represents the war goal
- scope:target = diplomatic play target
- scope:initiator = diplomatic play initiator
Since War Goals cost maneuvers and infamy, we also need to add a few scripted values (See [wgf_example_war_goals.txt](mod/common/script_values/wgf_example_war_goals.txt)):
- \_cost: Maneuver cost to add the War Goal to a Diplomatic Play
- \_infamy: Infamy cost to add the War Goal to a Diplomatic Play
- \_cost_primary: Maneuver cost to make the War Goal a primary demand in the Diplomatic Play
- \_infamy_primary: Infamy cost to make the War Goal a primary demand in the Diplomatic Play
**NOTE: These scripted values can be as simple or complex as you want. They are scoped to the diplomatic play.**
Finally, we need to add the War Goal to the global list of custom War Goals `wgf_custom_war_goals`:
```
add_to_global_variable_list = {
name = wgf_custom_war_goals
target = bt:wgf_example_war_goal
}
```
**NOTE: I recommend doing this in the global history file** (See [00_activate_example_war_goal.txt](mod/common/history/global/00_activate_example_war_goal.txt)).
## War Goal Effects
To have your War Goal actually affect the game, you will need to define a few on_actions (See [wgf_example_war_goal_enforcement.txt](mod/common/on_actions/wgf_example_war_goal_enforcement.txt)):
- `on_diplo_play_back_down` to enforce our war goal if it was a primary demand
- `on_war_end` to enforce our war goal at the end of a war
## Using War Goal in custom Diplomatic Play
War Goals and their maneuver cost are saved in the following variables and lists on the diplomatic play:
- `wgf_active_war_goals` all custom War Goals are added here
- `wgf_active_war_goals_primary` all primary demands are **ALSO** added here
- `wgf_cost` current maneuver cost of all custom war goals in the diplomatic play
To have your War Goal added to a custom (or any) diplomatic play automatically,
you will need to create an `on_action` for it
(See [wgf_example_diplomatic_play.txt](mod/common/on_actions/wgf_example_diplomatic_play.txt)):
- `on_diplomatic_play_started` there we check whether the diplomatic play is of the wanted type and then add our custom War Goal
## Example Screenshots
