Convars: Difference between revisions

From Rust Server Wiki
Jump to navigation Jump to search
[unchecked revision][unchecked revision]
(Created page with "In Rust, a "'''convar'''" (short for "console variable") is a variable that can be set and adjusted using the in-game console. Convars allow players and server administrators to change various settings and configurations in the game. Convars can be used to adjust a wide range of game settings, including player movement speed, resource spawn rates, time of day, and many other settings. They can also be used to enable or disable certain features, such as player collision...")
 
No edit summary
 
Line 1: Line 1:
In Rust, a "'''convar'''" (short for "console variable") is a variable that can be set and adjusted using the in-game console. Convars allow players and server administrators to change various settings and configurations in the game.
=== Server ConVars: A Deep Dive into Rust's Console Variables ===
The term 'ConVar' is an abbreviation for "Console Variable." These are settings within Rust's server and client that are adjustable via the console, allowing for server administrators and players to modify their Rust experience. For Rust server owners, understanding and managing ConVars is essential for tailoring server behavior and game settings.


Convars can be used to adjust a wide range of game settings, including player movement speed, resource spawn rates, time of day, and many other settings. They can also be used to enable or disable certain features, such as player collision or the ability to build in certain areas.
==== What are ConVars? ====
ConVars are dynamic settings and parameters that influence game mechanics in Rust. They are set within the game's console, either via the client for players or on the server side for administrators. By modifying these ConVars, one can adjust various aspects of the game, from server tick rate to loot spawns, and much more.


Convars can be adjusted by entering the appropriate command in the console, typically in the format of "convar_name value", for example "server.hostname MyRustServer". Some convars have predefined values, such as "0" or "1" for off and on respectively, while others can accept a range of values.
==== Types of ConVars: ====
While there are numerous ConVars in Rust, they can be broadly categorized into:


Some examples of convars are:
# Server-side ConVars: These affect server-wide settings. For instance, settings related to spawn rates, night duration, or server name fall under this category.
# Client-side ConVars: Players use these to adjust personal settings that don't affect other players. Examples include graphic settings, input configurations, and more.


* server.hostname: allows the server administrator to set the server's name
==== How to Access and Modify ConVars: ====
* server.seed: allows the server administrator to set the map seed
* server.maxplayers: allows the server administrator to set the maximum number of players that can join the server
* server.tickrate: allows the server administrator to set the tick rate of the server


It's worth noting that some convars are only available to server administrators, and some can only be executed on servers that have the appropriate plugins installed. Also, some convars can only be set at server startup and cannot be changed during runtime.
# Accessing the Console:
#* For server administrators, access to the console is typically through the hosting platform or directly via command-line interfaces, depending on the server setup.
#* For players, the console can usually be opened in-game using a specific key, often the F1 key.
# Modifying a ConVar:
#* To change a ConVar, simply type the ConVar name followed by the desired value. For instance: <code>server.tickrate 30</code> would set the server's tick rate to 30.
#* Some ConVars might require a server restart to take effect, while others will apply immediately.
# Finding Current ConVar Settings:
#* To view the current value of a ConVar, simply type the ConVar's name into the console.
# List All ConVars:
#* Typing <code>find *</code> in the console will display a list of all available ConVars and their current settings.
 
==== Commonly Used ConVars in Rust: ====
 
# server.hostname: This determines the server's name as displayed in the server list.
# server.description: Sets a brief description for the server, visible to players.
# server.maxplayers: Defines the maximum number of players that can join the server.
# server.worldsize: Sets the size of the map.
# server.seed: Determines the procedural generation seed for the map.
# server.saveinterval: Defines how often (in minutes) the server data is saved.
 
==== Best Practices for Modifying ConVars: ====
 
# Backup First: Always ensure you have a backup of your current server settings before making significant changes.
# Test Changes: If possible, test changes in a controlled or offline environment to understand their effects.
# Stay Informed: ConVars can change with game updates. Regularly check for updated documentation or changes in ConVar behavior.
# Use Descriptions: If your hosting platform allows, add descriptions or comments next to modified ConVars to remind you of their purpose and the reasons for specific settings.

Latest revision as of 13:32, 5 September 2023

Server ConVars: A Deep Dive into Rust's Console Variables

The term 'ConVar' is an abbreviation for "Console Variable." These are settings within Rust's server and client that are adjustable via the console, allowing for server administrators and players to modify their Rust experience. For Rust server owners, understanding and managing ConVars is essential for tailoring server behavior and game settings.

What are ConVars?

ConVars are dynamic settings and parameters that influence game mechanics in Rust. They are set within the game's console, either via the client for players or on the server side for administrators. By modifying these ConVars, one can adjust various aspects of the game, from server tick rate to loot spawns, and much more.

Types of ConVars:

While there are numerous ConVars in Rust, they can be broadly categorized into:

  1. Server-side ConVars: These affect server-wide settings. For instance, settings related to spawn rates, night duration, or server name fall under this category.
  2. Client-side ConVars: Players use these to adjust personal settings that don't affect other players. Examples include graphic settings, input configurations, and more.

How to Access and Modify ConVars:

  1. Accessing the Console:
    • For server administrators, access to the console is typically through the hosting platform or directly via command-line interfaces, depending on the server setup.
    • For players, the console can usually be opened in-game using a specific key, often the F1 key.
  2. Modifying a ConVar:
    • To change a ConVar, simply type the ConVar name followed by the desired value. For instance: server.tickrate 30 would set the server's tick rate to 30.
    • Some ConVars might require a server restart to take effect, while others will apply immediately.
  3. Finding Current ConVar Settings:
    • To view the current value of a ConVar, simply type the ConVar's name into the console.
  4. List All ConVars:
    • Typing find * in the console will display a list of all available ConVars and their current settings.

Commonly Used ConVars in Rust:

  1. server.hostname: This determines the server's name as displayed in the server list.
  2. server.description: Sets a brief description for the server, visible to players.
  3. server.maxplayers: Defines the maximum number of players that can join the server.
  4. server.worldsize: Sets the size of the map.
  5. server.seed: Determines the procedural generation seed for the map.
  6. server.saveinterval: Defines how often (in minutes) the server data is saved.

Best Practices for Modifying ConVars:

  1. Backup First: Always ensure you have a backup of your current server settings before making significant changes.
  2. Test Changes: If possible, test changes in a controlled or offline environment to understand their effects.
  3. Stay Informed: ConVars can change with game updates. Regularly check for updated documentation or changes in ConVar behavior.
  4. Use Descriptions: If your hosting platform allows, add descriptions or comments next to modified ConVars to remind you of their purpose and the reasons for specific settings.
Retrieved from "https://rustserver.wiki/index.php?title=Convars&oldid=338"