Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

Community Pause Menu

Add a configurable Community Hub to the Arma Reforger pause menu. Use it to give players a clear, controller-friendly place for server rules, onboarding, support links, notices, and actions supplied by your other mods.

Use it on your server

  1. Add this mod to the scenario or addon package that owns your server setup.
  2. Make a CommunityPauseMenuConfig resource in your own addon. Do not edit the shipped default config.
  3. Configure the hub title, entries, pages, and visibility rules in Workbench Config Editor.
  4. Point the Community Hub at your resource when your addon initializes.
  5. Test the finished hub with mouse, keyboard, and controller before publishing.
CommunityPauseMenuAPI.SetConfigResource(
	"{YOUR_RESOURCE_GUID}Configs/MyCommunityPauseMenuConfig.conf"
);

The shipped default config is a working reference. Replace its sample content before using it on a live server.

Build your Community Hub

Create entries in the Entries section and page content in the Pages section of your config. Each entry has an ID, a label, a description, an action, an action target, and optional availability, confirmation, and cooldown settings.

  • Use content pages for rules, guides, FAQs, and server information.
  • Use registered actions to open UI or perform client-side work supplied by another addon.
  • Use dialogs for a short notice or confirmation.
  • Keep unavailable entries visible only when an explanatory disabled state is useful to players.

Read Configuring a Community Hub for the action types, field reference, and a release checklist.

Connect another addon

An addon can provide an action for the hub, then your configuration can expose it to players. Register an action target during the integration addon's initialization and use that exact target in an INVOKE_REGISTERED_ACTION entry.

CommunityPauseMenuAPI.RegisterHandler("my_server_support", handler);

This lets you keep server content in configuration while keeping custom behavior in the addon that owns it. See Integrating with the Community Hub.

Dialogs and controller support

The default dialog resource is:

{C3B1A8F03E01D1A0}Configs/CommunityPauseMenuDialogPresets.conf

You can supply your own resource with CommunityPauseMenuAPI.SetDialogPresetsResource(...). Every dialog you provide must retain a working Back/Cancel route so controller players can close it. Details are in Configuration.

Localization

Use localization keys for hub labels, descriptions, pages, unavailable reasons, and dialog text. The included English strings are in CommunityPauseMenuButtons.en_us.conf, with the imported String Table at CommunityPauseMenuButtons.st.

See Localizing your Hub when adding or translating content.

Compatibility

This mod overrides the pause-menu layout to add CommunityHubButton. Test it alongside every other pause-menu or UI mod in your server stack, especially after game or addon updates.

License

See LICENSE.

About

Add a configurable Community Hub to the Arma Reforger pause menu. Use it to give players a clear, controller-friendly place for server rules, onboarding, support links, notices, and actions supplied by your other mods.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Contributors

Languages