Alpine Faction Mod Development

Collapse

EXPLORE

Red Faction Modding

EXPLORE

Documentation

EXPLORE

Tutorials

EXPLORE

Developer Resources

This page lists all new and improved capabilities when designing mods for Alpine Faction.

General

RedFaction\client_mods\ - The "client_mods" folder should be used for all clientside mods in Alpine Faction, rather than the traditional RF method of dropping them into "user_maps\multi\" or "user_maps\single\"

Packfiles are loaded alphabetically from the below locations. Assets loaded by the game from packfiles can be overridden/modified by including a file with the same filename in a packfile loaded later (either alphabetically or in a later loaded location).

Packfile location loading order:

Standard VPPs in root RF directory
alpinefaction.vpp
VPPs in user_maps\projects *
VPPs in user_maps\multi *
VPPs in user_maps\single *
VPPs in client_mods
VPPs in TC mod folder (if TC mod is loaded)

* - All packfiles are loaded from user_maps folders, but assets in these packfiles will NOT override assets from root RF directory vpps or alpinefaction.vpp unless the "Allow clientside mods in legacy directories" option is turned on in the Alpine Faction Launcher.

Level Info Tables

In Alpine Faction, whenever a map is loaded (multi or single), the client attempts to load a file named "MAPNAME_info.tbl", where MAPNAME is the level's filename (e.g. "dm02_info.tbl" is loaded when "dm02.rfl" is loaded). This file can be loaded from anywhere - user_maps\projects, user_maps\multi, user_maps\single, client_mods, or the TC mod's folder (if a TC mod is loaded).

The below options can be specified in this file, and apply as long as that map is loaded.

MAPNAME_info.tbl File

#Start

// This is a comment
$Ideal Player Count: 8
$Author Contact: "example@factionfiles.com"
$Author Website: "https://factionfiles.com"
$Description: "This is a description of the map."
$Lightmap Clamp Floor: {32,32,32}
$Lightmap Clamp Ceiling: {255,255,255}
$Player Headlamp Color: {32,32,32}
$Player Headlamp Range: 3.5
$Player Headlamp Radius: 20.0
$Chat Menu 1: 
$Chat Menu 2: 
$Chat Menu 3: 
$Chat Menu 4: 
$Chat Menu 5: 
$Chat Menu 6: 
$Chat Menu 7: 
$Chat Menu 8: 
$Chat Menu 9: 
$Crater Texture PPM: 32.0

#End

Explanation

The below options work. The other options listed above are loaded by the game but currently have no effect.

$Lightmap Clamp Floor - Set the minimum values per channel for clamping to be applied when lightmaps are loaded from the level file. If this option is specified for a given map, the "Full Range Lighting" option in the launcher is ignored and these values are used instead.
$Lightmap Clamp Ceiling - Set the maximum values per channel for clamping to be applied when lightmaps are loaded from the level file.

Alpine Options Tables

Alpine Faction exposes many previously hardcoded and inaccessible options and variables to customization by mod developers via Alpine Options table files loaded from the TC mod's directory. Each Alpine Options table file has different options that can be specified as listed below.

The available Alpine Options table files are:

af_game.tbl
af_ui.tbl
af_client.tbl *

* af_client.tbl is also loaded from client_mods and can be used to set values in clientside mods. See the heading for this file below to better understand how this file works.

af_game.tbl File

#Start

// This is a comment
$Default Geomod Smoke Emitter: "emitter name"
$Driller Geomod Smoke Emitter: "emitter name"
$Ice Geomod Texture: "texture.tga"
$First Level Filename: "mapname.rfl"
$Training Level Filename: "mapname.rfl"
$Use Base Game Players Config: false
$Ignore Swap Assault Rifle Controls: false
$Ignore Swap Grenade Controls: false
$Player Entity Type: 
$Player Undercover Suit Entity Type: 
$Player Undercover Scientist Entity Type: 
$Fall Damage Land Multiplier: 
$Fall Damage Slam Multiplier:
$Multiplayer Walk Speed: 
$Multiplayer Crouch Walk Speed: 
$Walkable Slope Threshold: 
$Player Headlamp Color:
$Player Headlamp Intensity:
$Player Headlamp Range:
$Player Headlamp Radius: 
$Default Third Person:

#End

Explanation

$Default Geomod Smoke Emitter -

af_ui.tbl File

#Start

// This is a comment
$Disable Multiplayer Button: false
$Disable Singleplayer Buttons: false
$Summoner Trailer Button Action: 
 +Summoner Trailer Button URL: 
 +Summoner Trailer Button Bink Filename: 
 +Summoner Trailer Button Level Filename: 

#End

Explanation

$Disable Multiplayer Button -

af_client.tbl File

#Start

// This is a comment
$Assault Rifle Ammo Counter Color: DEADBEEF
$Precision Rifle Scope Color: DEADBEEF
$Sniper Rifle Scope Color: DEADBEEF
$Rail Driver Fire Glow Color: DEADBEEF
$Rail Driver Fire Flash Color: DEADBEEF
$Rail Driver Scanner Color: 
$Multi Timer X Offset: 
$Multi Timer Y Offset: 
$Multi Timer Color: 

#End

af_client.tbl contains settings that are "safe" to modify in clientside mods, and there are some unique aspects of how this file can be used which you should understand:

af_client.tbl can be included in TC mods just like the other Alpine Options table files, and applies to that TC mod.
af_client_VARIABLE.tbl is also loaded from client_mods - where "VARIABLE" can be anything. This is to allow users to have multiple Alpine Options client table files loaded at once which adjust different values. For example, if you were making a mod that changed the sniper and precision rifle scope colours to pink, you might name your tbl file af_client_pinkscopes.tbl and put it in a vpp in client_mods
When a TC mod is loaded, settings configured in that mod's af_client.tbl file take precedence over the same settings configured in a Alpine Options client table file from client_mods
If the same setting is configured in multiple Alpine Options client table files (with different variable names) in client_mods, the setting loaded from the last such file, in alphabetical order, will take precedence

Explanation

$Assault Rifle Ammo Counter Color -