Skip to content

International Organizations

Jump to bottom
Alexedishi edited this page Jul 29, 2026 · 2 revisions

Overview

The International Organizations Framework is a feature of the Community Mod Framework that seeks to emulate the international organizations mechanic from EU5 through the use of journal entries. This takes advantage of the ability to inject widgets into journal entries as of V3 patch 1.13.

Content

Elements

This framework consists of the following features:

  • Scripted widget to display IOs which uses the CMF sidebar framework
  • Custom journal groups that use the CMF hidden journal entries feature
  • Modification to the outliner to add support for pinning IOs and situations
  • Addition of variable checks to hide various elements from journal entries
  • A custom injectable widget to provide a content baseline

Scripted widget

The IO panel is a scripted widget that displays any journal entry groups that have been added to the com_international_organization_journal_groups global list. This widget can display some basic information about the IO journal:

  • The widget will always show the name of the journal and the list of involved countries
  • The organization headquarters will be shown if the flag variable com_interorg_headquarters_var is set on the journal

Example Screenshot:

Note: The global variable com_international_organization_panel_active and global list com_international_organization_journal_groups must be present for the sidebar button to appear!

Custom journal groups

This framework provides the following custom journal groups:

  • je_group_com_supranational_organizations
  • je_group_com_regional_organizations
  • je_group_com_religious_organizations
  • je_group_com_non_governmental_organizations
  • je_group_com_sporting_organizations

These are automatically added to the com_international_organization_journal_groups global list

Other groups can be added by using the effects com_add_journal_group_to_interorg_list and com_hide_interorg_journal_entry_group

Outliner Changes

The top element of the outliner which displays pinned journal entries has been divided into three sections:

Standard Journals

This section displays any pinned journal entry groups that are in neither of the two other sections.

Situation Journals

This section displays any pinned journal entry groups that are included in the com_international_situation_journal_groups global list. The group je_group_global_international_situations is automatically added to this list.

Interorg Journals

This section displays any pinned journal entry groups that are included in the com_international_organization_journal_groups global list. The five interorg journal groups are automatically added to this list.

Hiding Journal Entry Elements

This framework includes the addition of several variable checks to hide/modify certain elements of the journal entry panel by setting variables on the journal entry scope.

  • com_header_var to replace the journal sub-header with a flag variable
  • com_hide_timeout to hide the timeout timer and effects
  • com_hide_status_desc to hide the status desc
  • com_hide_scripted_buttons to hide the scripted buttons
  • com_hide_journal_reason to hide the journal _reason
  • com_hide_involved_countries to hide the involved countries
  • com_hide_complete_triggers to the hide the journal completion triggers/effects
  • com_hide_fail_triggers to the hide the journal failure triggers/effects
  • com_hide_modifiers to the hide the journal modifiers

Custom Interorg Widget

A series of custom interorg widgets are provided for users. These can be injected like any other journal widget. You should also hide all unwanted/redundant JE elements wth the above features. The following features are available in all widgets:

  • The organization leader element will be shown if the flag variable com_interorg_leader_var is set on the journal
  • The organization headquarters element will be shown if the flag variable com_interorg_headquarters_var is set on the journal
  • Setting the variable com_interorg_chair_var will activate the character portrait to the left of the panel
  • The organization's chair can be given a custom title if the flag variable com_interorg_chair_title_var is set on the journal
  • Modifiers will appear in a custom element if added to the journal
  • Scripted buttons will appear in a custom button list similar to IOs from EU5

The parent widget widget_com_international_organization_base can also be invoked with the following features:

  • The texture for the header frame can be changed by overriding the gui block interorg_icon_frame_texture
  • The details elements to the right of the panel each have their own blocks to override visibility, text, and icons. There are a total of 5 detail entries, with the last two blank and hidden by default. All have gui blocks to override their content.

Usage

To use these widgets, you must inject them using one of the journal anchor points available since V3 patch 1.13. It is recommended to inject these widget into the custom_widget_container_je_icon anchor point. This anchor point removes the default journal icon. We also provide a scripted effect to hide all other journal elements.

Widget Setup Steps:

First, you will need to inject the widget by placing this into your journal entry script:

widget = {
		gui = "gui/com_journal_injects/interorg_widgets.gui"
		name = "widget_com_supranational_organization"
		container = "custom_widget_container_je_icon"
}

Next, you will need to run this in the immediate of your contextless journal:

immediate = {
    scope:journal_entry = {
        com_hide_all_journal_elements_for_interorg_effect = yes
	}
}

Lastly, you will also need to activate the IO sidebar item and outliner functions. This effect can be fired from anywhere, but we recommend running it from the immediate of your contextless journal:

immediate = {
    com_activate_interorg_sidebar = yes
}

Note: If you aren't sure if the sidebar will be activated for your journal, you can safely repeat this effect as needed.

Adding a custom journal entry group:

To add a custom International Organization journal, you will have to add it to the com_international_organization_journal_groups and com_hidden_journal_groups lists. The effect com_add_journal_group_to_interorg_list_and_hide_from_journal provides both of these operations in one effect. For example:

com_add_journal_group_to_interorg_list_and_hide_from_journal = {
  name = je_group_new_journal_group
}

Note: Remember to activate the sidebar, or you won't be able to access the journal!

To add a journal to the Situations section of the outliner, you will have to add the journal to the je_group_global_international_situations list. The effect com_add_journal_group_to_situations_list is provided for this operation.

	com_add_journal_group_to_situations_list = {
		name = je_group_global_international_situations
	}

Note: Do not hide your international situations from the journal! This list is solely for the outliner!

Script Docs

The following effects and triggers are available to use for managing journals with the International Organization Framework:

Effects

Details

Effect: com_activate_interorg_sidebar

Activates the sidebar for International Organizations and runs com_hide_journal_entry_group on the five custom journal groups

Parameters:

  • None

Effect: com_add_interorg_journal_entry

Activates a contextless journal entry with a custom tooltip: "The name International Organization will be created"

Parameters:

  • name script name of the contextless journal entry to be added

Effect: com_add_journal_group_to_interorg_list

Set a journal entry group as an international organization. This places its journals in international organization panel, but does not remove them from the journal entry panel.

Parameters:

  • name script name of the journal entry group to be added

Effect: com_add_journal_group_to_situations_list

Set a journal entry group as an international situation. This places its journals in the International Situations container in the outliner, and will not remove them from the journal entry panel.

Parameters:

  • name script name of the journal entry group to be added

Effect: com_add_journal_group_to_interorg_list_and_hide_from_journal

Set a journal entry group as an international organization. This places its journals in international organization panel and removes them from the journal entry panel.

Parameters:

  • name script name of the journal entry group to be added

Effect: com_set_international_organization_headquaters_effect

Sets the variable com_interorg_headquarters_var with the tooltip: "The Organization's Headquarters move to state_region"

Parameters:

  • state_region script name of the state region to be the HQ

Effect: com_hide_all_journal_elements_for_interorg_effect

Sets the following variables on the journal:

  • com_hide_scripted_buttons to hide the scripted buttons
  • com_hide_journal_reason to hide the journal _reason
  • com_hide_involved_countries to hide the involved countries
  • com_hide_complete_triggers to the hide the journal completion triggers/effects
  • com_hide_fail_triggers to the hide the journal failure triggers/effects
  • com_hide_modifiers to the hide the journal modifiers

Parameters:

  • None

Effect: com_hide_non_button_journal_elements_for_interorg_effect

Sets the following variables on the journal:

  • com_hide_journal_reason to hide the journal _reason
  • com_hide_involved_countries to hide the involved countries
  • com_hide_complete_triggers to the hide the journal completion triggers/effects
  • com_hide_fail_triggers to the hide the journal failure triggers/effects
  • com_hide_modifiers to the hide the journal modifiers

Parameters:

  • None

Clone this wiki locally