Skip to main content

Configuration

Pager Reborn uses convars for config values. For information on how to correctly install the config.cfg file, see here.

Value List​

NameDefault Value
ic_pr_languageen-us
ic_pr_statebagPrefix""
ic_pr_kickCheatersfalse
ic_pr_maxToneTime15
ic_pr_globalDefaultAddresses[]
ic_pr_timezoneAustralia/Melbourne
ic_pr_timezoneTagen-AU
ic_pr_inventorySupportfalse
ic_pr_playersStartWithPagertrue
ic_pr_maxAddressesPerPage25
ic_pr_maxPageBodyLength256
ic_pr_timeBetweenMessages2
ic_pr_sortMessageOrdertrue
ic_pr_suffixWithShortCodetrue
ic_pr_httpAccessToken""
ic_pr_whitelistedIpsSee Below
ic_pr_commandpager
ic_pr_debugfalse

Values Explained​

Language​

ic_pr_language​

This value is the short code for the language you'd like to use. You can check the list of available languages by viewing this page.

Statebag Prefix​

ic_pr_statebagPrefix​

This value is an optional unique prefix to separate your server's saved client-side data from other servers. If set, it must be at least four characters long and not contain any spaces. If no prefix is set, a default 'shared' prefix will be used.

Client-side saved data includes:

  • Tone/Vibration/Sound selection
  • Sound Mode selection
  • Page message history
  • NUI Position
  • NUI Volume

If you plan to make major changes to the resource's default audio, you should set a unique prefix.

Kick Cheaters​

ic_pr_kickCheaters​

If this value is true, the resource will kick any players it detects as suspicious. Even when false, suspected actions may still be logged to the server console.

Max Tone Time​

ic_pr_maxToneTime​

This value determines the maximum number of seconds a pager tone can play before it is automatically stopped.

Global Default Addresses​

ic_pr_globalDefaultAddresses​

This value is a list of addresses that all players are forced to join by default, regardless of roles or player overrides.

Example:

set ic_pr_globalDefaultAddresses [
	"emg.all"
]

Timezone​

ic_pr_timezone​

This value controls the timezone used by the resource for timestamp formatting.
A full list of timezones can be found here.

Timezone Tag​

ic_pr_timezoneTag​

This value controls the locale tag used when formatting date/time text.
A full list of timezone tags can be found here (see the tag column).

Inventory Support​

ic_pr_inventorySupport​

When this value is true, inventory support for resources such as OxInventory and QBInventory will be enabled.

note

You must also uncomment/edit the editable/client/inventory.lua and editable/server/inventory.lua files in addition to setting this value to true in order for inventory resources to work. Code inside editable/client/inventory.lua and editable/server/inventory.lua will not run unless ic_pr_inventorySupport is true.

Inside the editable/client/inventory.lua and editable/server/inventory.lua files, server owners/developers can either uncomment the code for OxInventory or QBInventory, or add their own inventory code as required. Reach out in Discord if you need help adding other resources.

tip

The "items.lua" entry for both Ox and QB are located at the top of editables/server/inventory.lua, and 100x100 png images are located in the download root directory.

Players Start with Pager​

ic_pr_playersStartWithPager​

If true, players join the server already having a pager. If false, pagers will need to be manually provided via exports.

warning

This value is superseded by the UsePager permission. Even if ic_pr_playersStartWithPager is true, players without the UsePager permission will not be able to open the Pager UI.

Max Addresses Per Page​

ic_pr_maxAddressesPerPage​

This value sets the maximum number of addresses that can be attached to a single page message.

Max Page Body Length​

ic_pr_maxPageBodyLength​

This value sets the maximum character length of a page's body text.

Time Between Messages​

ic_pr_timeBetweenMessages​

This value sets the seconds between sending page messages. This value is primarily for roleplaying purposes and can be set to any value.

tip

This value effects each address of a page. For example, if a page targets 3 capcodes and this value is set to 2, it would take 6 seconds for all addresses to be sent.

Sort Message Order​

ic_pr_sortMessageOrder​

If true, newer emergency pages will be prioritized ahead of older non-emergency/administrative pages.

tip

This value is useful if ic_pr_timeBetweenMessages is set to a high value.

For example, if a non-emergency page that targets 10 capcodes is sent and ic_pr_timeBetweenMessages is 2, it would take 20 seconds for all addresses to be sent. If ic_pr_sortMessageOrder is true, and halfway through the prior non-emergency page an emergency page is sent, the emergency page would be bumped to the top of the queue and sent first; then the remaining non-emergency page messages would be sent.

Suffix with Short Code​

ic_pr_suffixWithShortCode​

If true, page messages will include a short code suffix. This shortcode can either be defined in the Pager Network Designer, or if not provided, will be automatically generated.

HTTP Access Token​

ic_pr_httpAccessToken​

This is an optional config value that is required if server owners wish to use the included API.
This value is blank by default, and while blank, the API will reject all HTTP requests.
To enable the API you must provide a value to be used as a token.

API Whitelist​

ic_pr_whitelistedIps​

This is an optional config value that allows server owners to only allow HTTP requests from specific IP addresses.

To allow requests from any IP address, set this value to [].
The default value, 127.0.0.1, should allow access from the local machine only on most systems.

warning

Regardless of this config option, ic_pr_httpAccessToken is required.

Alias Command​

ic_pr_command​

When this value is anything other than pager, the value will be used to register an alias command. For example, setting it to pr would allow /pr.

Debug​

ic_pr_debug​

If this value is true, extra debug logs are written to both client and server consoles. Not suggested at all for production use.

Sound Configuration​

Pager Reborn uses a sounds.json file to define alert tone names and file paths.

Alert Tones​

There are two types of alert tones:

  • General
  • Escalating

For both types, the name (e.g., General #1) can be anything (and in any language), but the object names (General and Escalating) must not be changed.

General Tones​

General Tones are sounds that loop continuously while playing. For example, an activation might look something like this:

Activation -> Play Sound -> Play Sound -> Play Sound -> Page Acknowledged

While these sounds can be anything, because they loop, we suggest using sounds that loop properly.

Escalating Tones​

Escalating Tones are a set of two sounds: the first sound plays, then the second sound loops continuously. For example, an activation might look something like this:

Activation -> Play Sound A -> Play Sound B -> Play Sound B -> Play Sound B -> Page Acknowledged

Escalating tone file names must contain a *, which will be replaced with either a or b depending on what stage of the sound is being played. This means you must have both an a and b sound file. If you only have one sound file, you should add it as a General Tone instead.

Default Alert Tones​

The tones defined in defaultAlertTones determine the default tone used for each Page Nature, until a player overrides it.
The values should match a tone name defined in alertTones.

note

Even if you have renamed the page natures in your language file, you must not change them here.
I.e., do not rename Emergency, NonEmergency, and Administrative.

Vibrations​

There are two types of vibrations:

  • One-Shots
  • Looping

For both types, the name (e.g., General #1) can be anything (and in any language), but the object names (OneShot and Looping) must not be changed.

One-Shots​

One-Shot Vibrations are sounds that play once and then stop.

Looping​

Looping Vibrations are sounds that loop continuously while playing.

Default sounds.json​

Below is the default sounds.json file, loaded in the resource's root directory.

sounds.json
{
  "alertTones": {
    "General": {
      "General #1": "audio/pager/general/general-1.mp3",
      "General #2": "audio/pager/general/general-2.mp3",
      "General #3": "audio/pager/general/general-3.mp3",
      "General #4": "audio/pager/general/general-4.mp3",
      "General #5": "audio/pager/general/general-5.mp3",
      "General #6": "audio/pager/general/general-6.mp3",
      "General #7": "audio/pager/general/general-7.mp3",
      "General #8": "audio/pager/general/general-8.mp3",
      "General #9": "audio/pager/general/general-9.mp3",
      "General #10": "audio/pager/general/general-10.mp3",
      "General #11": "audio/pager/general/general-11.mp3",
      "General #12": "audio/pager/general/general-12.mp3",
      "General #13": "audio/pager/general/general-13.mp3",
      "General #14": "audio/pager/general/general-14.mp3",
      "General #15": "audio/pager/general/general-15.mp3",
      "General #16": "audio/pager/general/general-16.mp3"
    },

    "Escalating": {
      "Escalating #1": "audio/pager/escalating/escalating-1*.mp3",
      "Escalating #2": "audio/pager/escalating/escalating-2*.mp3",
      "Escalating #3": "audio/pager/escalating/escalating-3*.mp3",
      "Escalating #4": "audio/pager/escalating/escalating-4*.mp3",
      "Escalating #5": "audio/pager/escalating/escalating-5*.mp3",
      "Escalating #6": "audio/pager/escalating/escalating-6*.mp3",
      "Escalating #7": "audio/pager/escalating/escalating-7*.mp3",
      "Escalating #8": "audio/pager/escalating/escalating-8*.mp3",
      "Escalating #9": "audio/pager/escalating/escalating-9*.mp3",
      "Escalating #10": "audio/pager/escalating/escalating-10*.mp3",
      "Escalating #11": "audio/pager/escalating/escalating-11*.mp3",
      "Escalating #12": "audio/pager/escalating/escalating-12*.mp3",
      "Escalating #13": "audio/pager/escalating/escalating-13*.mp3",
      "Escalating #14": "audio/pager/escalating/escalating-14*.mp3",
      "Escalating #15": "audio/pager/escalating/escalating-15*.mp3",
      "Escalating #16": "audio/pager/escalating/escalating-16*.mp3"
    }
  },

  "defaultAlertTones": {
    "Emergency": "Escalating #12",
    "NonEmergency": "General #5",
    "Administrative": "General #8"
  },

  "vibrations": {
    "OneShot": {
      "Long": "audio/pager/vibrate/long-vibrate.mp3",
      "Short": "audio/pager/vibrate/short-vibrate.mp3"
    },

    "Looping": {
      "Loop": "audio/pager/vibrate/vibrate.mp3"
    }
  }
}

Permissions​

Pager Reborn uses Ace permissions.

Use Pager​

InfernoPagerReborn.UsePager​

Allows users to open the Pager UI.

warning

This permission supersedes ic_pr_playersStartWithPager. If players lack this permission, regardless of ic_pr_playersStartWithPager, they will not be able to open the Pager UI.

Page Emergency​

InfernoPagerReborn.PageEmergency​

Allows users to send emergency page messages.

Page Non-Emergency​

InfernoPagerReborn.PageNonEmergency​

Allows users to send non-emergency page messages.

Page Administrative​

InfernoPagerReborn.PageAdministrative​

Allows users to send administrative page messages.

Page Any Address​

InfernoPagerReborn.PageAnyAddress​

Allows users to page any address.
By default, this permission is only granted to admins (group.admin).

note

Even with InfernoPagerReborn.PageAnyAddress, users will still need to be granted access to one or more of the three page types above.

Page Any Player​

InfernoPagerReborn.PageAnyPlayer​

Allows users to page any player (bypass capcodes).
By default, this permission is only granted to admins (group.admin).

note

Even with InfernoPagerReborn.PageAnyPlayer, users will still need to be granted access to one or more of the three page types above.

Default Config File​

config.cfg
# Inferno Collection Pager Reborn
#
# Copyright (c) 2019-2026, Christopher M, Inferno Collection. All rights reserved.

######################################################################################
###                                     NOTICE                                     ###
###        Be sure to check the documentation before changing these values.        ###
###    https://docs.inferno-collection.com/resources/pager-reborn/configuration/   ###
######################################################################################

#####################
### Configuration ###
#####################

### General ###
###############

# Select language
setr ic_pr_language "en-us"

# A unique string to identify your community
setr ic_pr_statebagPrefix ""

# Kick suspected cheaters
set ic_pr_kickCheaters "false"

# Max seconds before pager sound stops
setr ic_pr_maxToneTime 15

# Addresses that *all* players will be forced to join
set ic_pr_globalDefaultAddresses []

# Timezone for pager - see docs for more info
setr ic_pr_timezone "Australia/Melbourne"

# Timezone Tag for pager - see docs for more info
setr ic_pr_timezoneTag "en-AU"

# Enables inventory support
setr ic_pr_inventorySupport "false"

### Advanced ###
################

# All players join the server with a pager
setr ic_pr_playersStartWithPager "true"

# Max number of addresses per page message
setr ic_pr_maxAddressesPerPage 25

# Max length of body text per page message
setr ic_pr_maxPageBodyLength 256

# Time in seconds between page messages being sent
set ic_pr_timeBetweenMessages 2

# Sort messages so new Emergency Pages get sent before older Non-Emg/Admin Pages
set ic_pr_sortMessageOrder "true"

# Place shortcodes at the end of page messages
set ic_pr_suffixWithShortCode "true"

# HTTP Access Token
set ic_pr_httpAccessToken ""

# List of whitelisted IPs to allow HTTP requests from
set ic_pr_whitelistedIps [
	"127.0.0.1"
]

# Change command name
set ic_pr_command "pager"

# If the resource should run in debug mode
setr ic_pr_debug "false"

###################
### Permissions ###
###################

add_ace builtin.everyone "InfernoPagerReborn.UsePager" allow

add_ace builtin.everyone "InfernoPagerReborn.PageEmergency" allow
add_ace builtin.everyone "InfernoPagerReborn.PageNonEmergency" allow
add_ace builtin.everyone "InfernoPagerReborn.PageAdministrative" allow

add_ace group.admin "InfernoPagerReborn.PageAnyPlayer" allow
add_ace group.admin "InfernoPagerReborn.PageAnyAddress" allow

##########################
### ConVar Permissions ###
##########################

# Prevents other resources from reading these private values
add_convar_permission inferno-pager-reborn read ic_pr_httpAccessToken
add_convar_permission inferno-pager-reborn read ic_pr_whitelistedIps