Community-Mod-Framework

Framework mod to support compatibility between including GUI, Political Movements, Parties and mod detection triggers

Steam Page

https://steamcommunity.com/sharedfiles/filedetails/?id=3385002128

Setting Dependency

To set this mod as a dependency to your own mod, you will need to add this to your metadata.json file:

  "relationships" : [
    {
      "rel_type" : "dependency",
      "id" : "com.github.Victoria-3-Modding-Co-op.Community-Mod-Framework",
      "display_name" : "Community Mod Framework",
      "resource_type" : "mod",
      "version" : "1.*"
    }
  ]

Also remember to add the mod to your required items on your own mods steam page.

Political Movements

Overwrites vanilla Political Movement definitions with scripted triggers to aid in mod compatibility

Add dummy ideologies from mods into political movements, allowing them to spawn with the appropiate mod enabled:

• Add a dummy ideology with the same name as your mod ideology
• Assign the ideology to the appropiate political movements (and scripted triggers if needed)
• Load this mod below any other mod
• Your mod will overwrite the ideology definition and allow it to spawn in the specified political movements

Debug Mode

The keybinding CTRL + ALT + D toggles the global variable com_debug.

This can be used to enable or disable debug content like debug Decisions or Events.

GUI Framework

Current Scope:

1. A "sidebar" scripted widget to deconflict mods that want to add custom sidebar buttons. (Credit to Bahmut, LordR, & Alexedishi)
2. Modification to the GUI template fullscreen_hide to hide the outliner whenever a scripted widget window is open. (Credit to Bahmut & Alexedishi)
3. Modification to objective_types to add a scrollbar to the objectives screens. (Credit to Bahmut, KarafuruAmamiya, & Xier)
4. Modification to society_panel to add the ability to use custom social hierarchies. (Credit to Bahmut)
5. Integration of the "Modded DLC Framework" (Credit to 1230James)
6. Unified system for cooltip types (Credit to 1230James)
7. Modification to the outliner and journal GUIs to hide custom objectives during gameplay (Credit to Taylor)
8. Several "superevent" windows for extra flavor (Credit to Bananaman & Klein for the Newspaper window, Credit to Alexedishi for all others)
9. Modification to Journal Entry GUI to allow players to show characters (Credit to Bahmut and Mori)
10. Integration of the "Multi-line PM Framework" (Credit to 1230James)
11. Alerts can now open custom windows (Credit to Bahmut)

Alternative Event Windows

Modded event windows are available and can be used by passing this in your event:

gui_window = <event_window_key>

The following modded event windows are available: event_window_newspaper event_window_superevent event_window_struggle event_window_1char_adventure event_window_2char_adventure event_window_2char_duel event_window_highlander event_window_crisis

Usage Notes

• For ease of use, any modded windows with characters will expect a character scope for the arguments left_icon = and right_icon = just like the vanilla events do.
• event_window_duel also has an optional progress that will display below the flavor text -- this is activated by setting the variable com_event_window_2char_duel_var -- the progress bar will pull the value from this variable; it has a max of 100 and minimum of 0
• event_window_crisis uses six character scopes saved as variables; documentation is provided in the eventwindow.gui file

Hiding Objective Header

The Objective header can be hidden by setting the global variable community_gui_objective_var like this:

set_global_variable = community_gui_objective_var

Custom Social Hierarchies

To enable a custom social hierachy you have to execute this effect in a countries scope:

set_variable = {
    name = custom_social_hieracy
    value = active_law:lawgroup_of_your_hierachy
}

I recommend doing this in the history file of a country common/history/countries

Sidebar Button

Screenshot: Example

How to add a new button to the sidebar.

First create an ideology in the common/ideologies/ folder (See example_button.txt). The icon set on the ideology is the icon shown on your button. Important here is that this ideology is never triggered or shown!

Then we need a scripted gui in the common/scripted_guis/ folder corresponding to the button (See example_button_sgui.txt)

We then link those two via the localization of the ideology. Localizations can be found in localization/<language>/. Button ideologies have three localization keys: <ideology>, <ideology>_desc and <ideology>_tooltip

The key <ideology> should contain the name of your scripted_gui. And the key <ideology>_desc contains the name shown when hovering over the button. The <ideology>_tooltip is optional and will be shown as a tooltip if you hover over the button (See com_gui_l_english.yml). Good practice here is to name the ideology and the scripted gui the same so even if you do not set the localization key for a language, the correct scripted gui is triggered!

And at last we need to add the button to the sidebar. This is done via the following effect (but with your ideology):

add_to_global_variable_list = {
    name = custom_button_list
    target = ideology:gui_sidebar_example_button
}

This effect can be run wherever you want, like a journal entry or an event. One possibility is to run it in common/history/global/ (See enable_example_button.txt).

GUI Window Visibility

When a sidebar button is clicked the following GUI variable is set to your scripted gui name: com_open_window In your custom window you should check for it like this (with your scripted gui name):

visible = "[GetVariableSystem.HasValue('com_open_window', 'gui_sidebar_example_button')]"

If you want to close your window again you can do it by clearing the variable like this:

onclick = "[GetVariableSystem.Clear('com_open_window')]"

Fullscreen GUI

If your GUI is fullscreen you will also need to set and remove the following GUI variable: com_fullscreen The best solution is to use the GUI state system like this:

state = {
    name = _show
    # Toggle doesn't work here as it is still toggled on reload, so I have to set it instead
    on_finish = "[GetVariableSystem.Set('com_fullscreen', 'com_fullscreen')]" 
}
state = {
    name = _hide
    on_finish = "[GetVariableSystem.Clear('com_fullscreen')]"
}

Setting it will hide the base game GUI and removing it will show the base game GUI again.

Custom Alerts

When you create an alert, you also need to define an action in a loc key. This action string will be written into the GUI variable com_alert_action.

You can then check for this in your custom GUI like this:

visible = "[GetVariableSystem.HasValue('com_alert_action', 'Example Panel')]"

Characters in Journal Entry

Screenshots: Single Character with Opinion, Multiple Characters without Opinions

To add one or more characters to a journal entry you need to add them to a variable list called com_journal_characters in the immediate block of a journal entry.

Here is an example where a countries ruler is added to a journal entry, but theoretically you can add whoever you want:

je_example_entry = {
	...
	immediate = {
		every_scope_character = {
			limit = {
				exists = this
				is_character_alive = yes
				is_ruler = yes
			}
			save_temporary_scope_as = list_character
			scope:journal_entry = {
				add_to_variable_list = {
					name = com_journal_characters
					target = scope:list_character
				}
			}
		}
	}
	...
}

Opinions

Characters in journal entries can also have opinions. To define them, you need to set the flag variable com_opinion on the character.

set_variable = {
    name = com_opinion
    value = flag:gui_character_opinion_example
}

The text behind flag: is a localization key (See com_gui_l_english.yml).

NOTE: Only one opinion can be set on a character at a time. So if you are using a character in multiple journal entries be aware of this.

Multi-line Production Methods

MPM edits certain panels in the UI to make them display extra PM groups by wrapping them around instead of adding the extra ones on the same line and causing them to appear off the edge of the panel or under other text and buttons. MPM provides changes to the following files:

gui/building_details_panel.gui
gui/goods_state_panel.gui
gui/production_methods.gui
gui/building_browser_panel.gui

NOTE: Note that military buildings, such as barracks and naval bases, are NOT INTENDED TO BE USED WITH MPM due to the new unit graphics being displayed alongside the PMGs which now take up most of the space that the extra PMGs would overflow into.

Parties

For naming, you need to include loc keys to avoid load-up error. These can be blank and overwritten by your own mod.

Community Mod Triggers

Usage

1. Place the file 00_community_mod_compatibility_triggers.txt in the /common/scripted_triggers folder of your mod. This file will contain the scripted triggers all set to return false by default. This is intentional. YOURMODNAME_is_active_trigger = { always = no }

2. Create another file with the name zz_YOURMODNAME_compatibility_triggers.txt that contains the following: YOURMODNAME_is_active_trigger = { always = yes }

Currently Included:

• Anno 1836
• Australia & New Zealand Flavor Pack
• Basileia Romaion
• Better Decrees
• Better Politics Mod
• Community Outfit Mod
• East Asian Clothes Patch
• Gas, Guns, Garb, & Grub
• Gilded Age
• Greece, Byzantium, & the Balkans Flavor
• Grey's Little Reworks
• Hail, Columbia!
• James's Korea Flavor Pack
• James's Pop Clothing Tweaks
• Manaflow: Ankaris Arrival
• War Goal Framework
• Morgenrote: Dawn of Flavor
• Newspapers Mod
• Rally Round the King
• States That Make Sense
• Western Clothes: Redux

Keybinds

You can take a free keybind by doing this:

1. Check default.profile and see which keybind is still free. You can find free keybinds at the bottom of the file.
2. Add input_action = "input_$your_input$" to the button you want to use it for.
3. Add a localization for your button to "localization/language_x/replace" and use the name of the input_action.

Note: It is possible to add additional keybinds if there are no keybinds left.

Additional Modifier Icons

Over 100 new modifier icons for more variety. Credit to Caelreader. PSD template available in docs. Screenshot: Modifier Icons