View source for Dash Faction Enhanced Dedicated Server Config

This page lists example server templates you can use and customize to your liking when hosting a [[RF Clients#Dash Faction|Dash Faction]] dedicated server. You'll find config options for most common use cases, but if you're running into issues customizing your server to your liking, please join the [https://discord.gg/fRrUzuV Red Faction Community Discord] and we'll help you out.


==Available Custom Options==
===Full List of Options===
This is a complete list of all new custom options available in [[RF Clients#Dash Faction|Dash Faction]] dedicated servers.

'''NOTE: All custom Dash Faction options (<nowiki>$DF options</nowiki>) need to be inserted in [[dedicated_server.txt]] ''after'' the <nowiki>$Map</nowiki> lines.'''
*Custom options must appear in the order provided below. You do '''not''' have to specify all (or any) custom options, but if you specify any of them, they '''must''' be in this order.
*Options are indicated by a preceding '''$''' and optional parameters are indicated with a preceding '''+'''. You can specify options without optional parameters, but if you wish to use any optional parameters, you '''must''' also include the corresponding option.
 <nowiki>
$DF Vote Kick: true|false
$DF Vote Level: true|false
$DF Vote Extend: true|false
$DF Vote Restart: true|false
$DF Vote Next: true|false
$DF Vote Previous: true|false
$DF Spawn Protection Duration: TIME_IN_MILLISECONDS
$DF Hitsounds: true|false
$DF Item Replacement: "ITEM_NAME" "ITEM_NAME"
$DF Weapon Items Give Full Ammo: true|false
$DF Default Player Weapon: "WEAPON_NAME"
$DF Anticheat Level: 0|1|2|3
$DF Require Client Mod: true|false
$DF Player Damage Modifier: MULTIPLIER
$DF Saving Enabled: true|false
$DF UPnP Enabled: true|false
$DF Force Player Character: "CHARACTER_NAME"
$DF Max FOV: VALUE_IN_DEGREES
$DF Send Player Stats Message: true|false
$DF Welcome Message: "STRING"
 </nowiki>

===Voting===
*The following options can be used to allow players to vote to perform actions like changing the map or kicking a player. See [[Red Faction Multiplayer Guide#Voting|voting in Dash Faction]] for instructions on how to cast votes as a player.
*Each vote option has an optional time limit parameters available. If no time limit is specified for a specific vote type, the vote will last for 60 seconds.

 <nowiki>
$DF Vote Kick: true|false
    +Time Limit: TIME_IN_SECONDS </nowiki>
*If true, players can vote to kick a player from the game. 
 <nowiki>
$DF Vote Level: true|false
    +Time Limit: TIME_IN_SECONDS </nowiki>
*If true, players can vote to change to a specific level (by [[.rfl]] filename).
 <nowiki>
$DF Vote Extend: true|false
    +Time Limit: TIME_IN_SECONDS </nowiki>
*If true, players can vote to extend the current round by 5 minutes.
 <nowiki>
$DF Vote Restart: true|false
    +Time Limit: TIME_IN_SECONDS </nowiki>
*If true, players can vote to restart the current map.
 <nowiki>
$DF Vote Next: true|false
    +Time Limit: TIME_IN_SECONDS </nowiki>
*If true, players can vote to immediately switch to the next map in the server's map rotation.
 <nowiki>
$DF Vote Previous: true|false
    +Time Limit: TIME_IN_SECONDS </nowiki>
*If true, players can vote to immediately switch to the previous map in the server's map rotation.

===Spawn Protection===
*Allows the server to specify the length of time (in milliseconds) players are invulnerable after respawning. If not specified, defaults to 1500ms (1.5 seconds).
*To disable spawn protection entirely, specify 0 milliseconds.
 <nowiki>
$DF Spawn Protection Duration: TIME_IN_MILLISECONDS </nowiki>

===Hitsounds===
*If used, players hear a sound when they deal damage to another player.
*Has optional parameters to specify the sound players hear (ID from [[sounds.tbl]]) and the maximum number of sounds played per second. Keeping the rate limit low is ideal to avoid bandwidth concerns - if you're unsure of potential impact, it's probably best to leave the rate limit option alone.
 <nowiki>
$DF Hitsounds: true|false 
    +Sound ID: SOUND_ID
    +Rate Limit: PACKETS_PER_SECOND </nowiki>

===Item Replacement===
*Allows the server to replace items (pickups) with other items, or disable specific items entirely.
*You can include as many item replacement lines as you wish, in any order.
*Item names are from [[items.tbl]]. To disable an item, include a replacement line specifying the item to disable in the first field and nothing in the second field. For an example, reference '''Config Templates''' below.  
 <nowiki>
$DF Item Replacement: "ITEM_NAME" "ITEM_NAME" </nowiki>

===Weapons Give Full Ammo===
*When players get a new weapon pickup, if this option is enabled, they also get full ammo for that weapon rather than the default of just getting 1 magazine.
*If not specified, defaults to false.
*Fusion Rocket Launcher pickup is exempt from this option.
 <nowiki>
$DF Weapon Items Give Full Ammo: true|false </nowiki>

===Player Spawn Weapon===
*Allows the server to spawn all players with a specific weapon. If not specified, players spawn with a [[12mm Pistol]].
*Weapon names are from [[weapons.tbl]]. Optionally, you can also specify the amount of ammo players spawn with for that weapon. If not specified, players spawn with an amount of ammo equal to 3x the weapon's clip size (as specified in [[weapons.tbl]]).
 <nowiki>
$DF Default Player Weapon: "WEAPON_NAME"
    +Initial Ammo: AMMO_COUNT </nowiki>

===Anticheat Enforcement===
*Allows the server to control anticheat enforcement level for connected clients. If a player fails the anticheat check as configured by the server, they will be unable to spawn, and will instead be presented with a message advising them that they've failed the anticheat check. Anticheat enforcement levels each include all checks from lower levels.
*Available anticheat levels:
**'''0''' = Everyone can play. (no enforcement)
**'''1''' = Player must be using either Pure Faction, or an official build of Dash Faction v1.7.0 or higher.
**'''2''' = Player must pass basic anticheat checks for core game parameters. (equal to "blue P" in PF)
**'''3''' = Player must pass strict anticheat checks such as not using clientside mods. (equal to "gold P" in PF)
*If not specified, defaults to 0 (allow everyone - no enforcement).
 <nowiki>
$DF Anticheat Level: 0|1|2|3 </nowiki>

===Require Client Mods===
*If disabled, allows the server to run a conversion mod (via '''-mod''') without requiring clients to run the same mod to join the server.
*If not specified, defaults to true (stock game behaviour).
 <nowiki>
$DF Require Client Mod: true|false </nowiki>

===Player Damage Modifier===
*Global damage multiplier for damage dealt to players. If set to 0, players are invulnerable.
*If not specified, defaults to 1.0.
 <nowiki>
$DF Player Damage Modifier: MULTIPLIER </nowiki>

===Multiplayer Quicksave/Quickload===
*Designed with run maps in mind. If enabled, allows Dash Faction 1.5.0+ clients to use quicksave and quickload binds to save/load position in multiplayer maps. Clients not running Dash Faction 1.5.0+ can still use <nowiki>/save</nowiki> and <nowiki>/load</nowiki> chat commands.
*If not specified, defaults false.
 <nowiki>
$DF Saving Enabled: true|false </nowiki>

===Universal Plug and Play (UPnP)===
*Controls whether the server attempts to use UPnP to allow you to host servers without forwarding specific ports.
*If not specified, defaults true.
*You can read more about how UPnP works on [https://en.wikipedia.org/wiki/Universal_Plug_and_Play Wikipedia].
 <nowiki>
$DF UPnP Enabled: true|false </nowiki>

===Force Player Character/Skin===
*Allows the server to specify a character type which all clients will be forced to use. Character names are from [[pc_multi.tbl]]. 
*This option is similar to the [[RF Clients#Pure Faction|Pure Faction]] "Force Skin" option, though [[RF Clients#Dash Faction|Dash Faction]] allows you to force whichever character type you want, rather than ''only'' the [[Elite Guard]]. 
 <nowiki>
$DF Force Player Character: "CHARACTER_NAME" </nowiki>

===Maximum Camera Field of View===
*Allows the server to specify a maximum horizontal field of view (hFOV) value which clients in the server will be allowed to use (via the <nowiki>fov</nowiki> [[Red Faction Console Commands|console command]]).
*If not specified, defaults to no limit.
 <nowiki>
$DF Max FOV: VALUE_IN_DEGREES </nowiki>

===Player Statistics===
*If enabled, the server will send a private message to each player at the end of each map with their statistics for that round, including accuracy, damage dealt, etc.
*If not specified, defaults to true.
 <nowiki>
$DF Send Player Stats Message: true|false </nowiki>

===Welcome Message===
*If specified, the server will send a customized private welcome message to each player when they join the game. This functionality is referred to as MOTD (message of the day) in some other games.
*"$PLAYER" is replaced with the name of the player receiving the message.
*If not specified, defaults to sending no welcome message.
 <nowiki>
$DF Welcome Message: "Hello $PLAYER!" </nowiki>

==Config Templates==
===Enable Voting===
*Turns on all types of voting - kicking players, changing levels, extending the current level, restarting the current level, changing to the next level in the rotation, and changing to the last level in the rotation.
*See [[Red Faction Multiplayer Guide#Voting|voting in Dash Faction]] for instructions on how to vote in-game.
 <nowiki>
$DF Vote Kick: true
$DF Vote Level: true
$DF Vote Extend: true
$DF Vote Restart: true
$DF Vote Next: true </nowiki>
===Enable Hitsounds===
*Turns on hitsounds, sets the sound to use to sound id 29 (a beep), and sets a hitsound rate limit of 10 packets per second to save bandwidth.
 <nowiki>
$DF Hitsounds: true
+Sound ID: 29
+Rate Limit: 10
</nowiki>

===Make Players Spawn with [[Submachine Gun|SMG]]===
*Makes players spawn with an [[Submachine Gun|SMG]] instead of a [[12mm Pistol]] and (optionally) sets the reserve ammo for the spawn weapon to 128. 
 <nowiki>
$DF Default Player Weapon: "Machine Pistol"
+Initial Ammo: 128
</nowiki>

===Run Mods Without Players Needing Them===
*While you could always use the -mod command line option to run RF servers with mods, Dash Faction gives you the option to do so without requiring players to be running the same mod to join your server.
 <nowiki>
    $DF Require Client Mod: false
</nowiki>

===Disable Super Powerups===
*This will remove the Damage Amplifier, Invulnerability, Super Health, and Super Armor pickups from maps on your server.
 <nowiki>
$DF Item Replacement: "Multi Super Health" ""
$DF Item Replacement: "Multi Super Armor" ""
$DF Item Replacement: "Multi Invulnerability" ""
$DF Item Replacement: "Multi Damage Amplifier" ""
</nowiki>

===Rail-Only (Instagib) Mode===
*This will remove all pickups, set the player spawn weapon to the [[Rail Driver]], and give the player 1000 ammo for it.
 <nowiki>
$DF Item Replacement:  "Remote Charge" ""
$DF Item Replacement:  "Remote Charges" ""
$DF Item Replacement:  "Riot Stick" ""
$DF Item Replacement:  "Handgun" ""
$DF Item Replacement:  "Silenced 12mm Handgun" ""
$DF Item Replacement:  "Shotgun" ""
$DF Item Replacement:  "Sniper Rifle" ""
$DF Item Replacement:  "rocket launcher" ""
$DF Item Replacement:  "Assault Rifle" ""
$DF Item Replacement:  "Machine Pistol" ""
$DF Item Replacement:  "grenades" ""
$DF Item Replacement:  "flamethrower" ""
$DF Item Replacement:  "riot shield" ""
$DF Item Replacement:  "rail gun" ""
$DF Item Replacement:  "heavy machine gun" ""
$DF Item Replacement:  "scope assault rifle" ""
$DF Item Replacement:  "shoulder cannon" ""
$DF Item Replacement:  "12mm_ammo" ""
$DF Item Replacement:  "5.56mm_ammo" ""
$DF Item Replacement:  "7.62mm_ammo" ""
$DF Item Replacement:  "explosive 5.56mm rounds" ""
$DF Item Replacement:  "10gauge_ammo" ""
$DF Item Replacement:  ".50cal_ammo" ""
$DF Item Replacement:  "Napalm" ""
$DF Item Replacement:  "rocket_launcher_ammo" ""
$DF Item Replacement:  "railgun_bolts" ""
$DF Item Replacement:  "riot_stick_battery" ""
$DF Item Replacement:  "Suit Repair" ""
$DF Item Replacement:  "Medical Kit" ""
$DF Item Replacement:  "First Aid Kit" ""
$DF Default Player Weapon: "rail_gun"
+Initial Ammo: 1000
</nowiki>

===Rail-Only (Traditional) Mode===
*This will set the player spawn weapon to the [[Control Baton]], disable the [[12mm Pistol]], and set all weapon and ammo pickups to [[Rail Driver|Rail Drivers]] and rail ammo.
 <nowiki>
$DF Item Replacement:  "Riot Stick" "rail gun"
$DF Item Replacement:  "Handgun" "rail gun"
$DF Item Replacement:  "Silenced 12mm Handgun" "rail gun"
$DF Item Replacement:  "Shotgun" "rail gun"
$DF Item Replacement:  "Sniper Rifle" "rail gun"
$DF Item Replacement:  "rocket launcher" "rail gun"
$DF Item Replacement:  "Assault Rifle" "rail gun"
$DF Item Replacement:  "Machine Pistol" "rail gun"
$DF Item Replacement:  "flamethrower" "rail gun"
$DF Item Replacement:  "heavy machine gun" "rail gun"
$DF Item Replacement:  "scope assault rifle" "rail gun"
$DF Item Replacement:  "shoulder cannon" "rail gun"
$DF Item Replacement:  "12mm_ammo" "railgun_bolts"
$DF Item Replacement:  "5.56mm_ammo" "railgun_bolts"
$DF Item Replacement:  "7.62mm_ammo" "railgun_bolts"
$DF Item Replacement:  "explosive 5.56mm rounds" "railgun_bolts"
$DF Item Replacement:  "10gauge_ammo" "railgun_bolts"
$DF Item Replacement:  ".50cal_ammo" "railgun_bolts"
$DF Item Replacement:  "Napalm" "railgun_bolts"
$DF Item Replacement:  "rocket_launcher_ammo" "railgun_bolts"
$DF Item Replacement:  "riot_stick_battery" "railgun_bolts"
$DF Item Replacement:  "Suit Repair" ""
$DF Item Replacement:  "Medical Kit" ""
$DF Item Replacement:  "First Aid Kit" ""
$DF Default Player Weapon: "Riot Stick"
</nowiki>

===Force All Players to Elite Guard Skin (Bald Guy)===
*This will force all multiplayer clients to the [[Elite Guard]] skin when they spawn in your server. This is effectively the same as the [[RF Clients#Pure Faction|Pure Faction]] "Force Skin" option, though [[RF Clients#Dash Faction|Dash Faction]] allows you to force whichever skin you want, rather than ''only'' the [[Elite Guard]].
 <nowiki>
$DF Force Player Character: "elite"
</nowiki>

===Restrict Player Camera FOV===
*This will restrict the field of view for all players in your server to a maximum of 106.26 degrees, which is the properly scaled default for the 16:9 aspect ratio.
*Players will not be able to use a higher camera FOV (configured via the <nowiki>fov</nowiki> [[Red Faction Console Commands|console command]])
 <nowiki>
$DF Max FOV: 106.26
</nowiki>

===Invite New Players to the Community Discord===
*This will send a private welcome message to players when they join your server inviting them to join the [https://discord.gg/fRrUzuV community Discord server.]
 <nowiki>
$DF Welcome Message: "Welcome $PLAYER! Join the community on Discord by visiting http://RFChat.com"
</nowiki>

===Ensure Players use Pure or Dash Faction===
*This will set your server to require either players to be using either Pure Faction or an official version of Dash Faction v.1.7.0+ to play. If players are not running Pure or Dash Faction, when they click to spawn, they will instead receive a private message instructing them on how to get Dash Faction.
 <nowiki>
$DF Anticheat Level: 1
</nowiki>