Example config file

To change Hypermine's configuration, create a file called client.toml. Place this file in ~/.config/hypermine/ if you're on Linux or %APPDATA%\hypermine\config\ if you're on Windows.

The following config file contains every setting you can change. To enable config options, uncomment lines by removing the # in front before changing them.

# The `name` option affects some log entries and identifies you if you connect to a server. Defaults to "player".
#name = "player"

# Provides a way to manually specify a directory to search for assets for the game, such as the "materials" folder. Setting this is generally unnecessary.
#data_dir = "..."

# The name of your save file. Specify a full file path to put it in a non-default location. Defaults to "default.save".
#save = "default.save"

# How many chunks to generate terrain for at the same time. Reducing this can improve performance at the cost of making terrain slower to load. Changing this is generally unnecessary. Defaults to 256.
#chunk_load_parallelism = 256

# How many threads are used to load assets. Changing this is generally unnecessary. Defaults to the number of CPU cores reported by the system, up to a maximum of 16.
#asset_load_parallelism = ...

# If you set the `server` option to an IP address, Hypermine will connect to that server instead of running in single player. This guide does not cover how to configure multiplayer.
#server = "[::1]:1234"

# Options under `[local_simulation]` affect gameplay and are likely the most interesting to experiment with.
[local_simulation]

# Number of simulation steps per second. Defaults to 30.
#rate = 30

# Maximum distance at which nodes will be rendered in meters. Setting this too high relative to chunk_generation_distance will cause lag. Defaults to 75.
#view_distance = 75

# Maximum distance at which new chunks will be generated in meters. Setting this too high will cause lag and/or errors. Defaults to 60.
#chunk_generation_distance = 60

# Distance at which fog becomes completely opaque in meters. Defaults to 90.
#fog_distance = 90

# Advanced option related to netcode. It represents the amount of time after the first input in a given uninterrupted sequence of inputs the server must wait before beginning to consume inputs. Changing this is generally unnecessary. Defaults to 50.
#input_queue_size_ms = 50

# The width of a single chunk in voxels. If you decrease this, you will also need to proportionally decrease chunk_generation_distance and view_distance, as well as ensuring that block_reach is less than chunk_generation_distance, to avoid lag and/or errors. If you have an existing save file, changing this will have no effect. Defaults to 12.
#chunk_size = 12

# An approximate average size of each voxel in meters. Defaults to 1.
#voxel_size = 1

# Whether world generation should add randomly-placed horospheres into the world. Defaults to false.
#horospheres_enabled = false

# Whether there is a limited inventory or not. This option will likely be expanded in the future to toggle other gameplay-related features as well, like health. Defaults to false.
#gameplay_enabled = false

[local_simulation.character]
# Movement speed in m/s during no-clip. Defaults to 12.
#no_clip_movement_speed = 12

# Maximum movement speed while on the ground in m/s. Defaults to 4.
#max_ground_speed = 4

# Artificial speed cap in m/s to avoid overloading the server. Defaults to 30.
#speed_cap = 30

# Maximum ground slope (0=horizontal, 1=45 degrees). Defaults to 1.73 (60 degrees).
#max_ground_slope = 1.73

# Acceleration while on the ground in m/s^2. Defaults to 20.
#ground_acceleration = 20

# Acceleration while in the air in m/s^2. Defaults to 2.
#air_acceleration = 2

# Acceleration of gravity in m/s^2. Defaults to 20.
#gravity_acceleration = 20

# Air resistance in (m/s^2) per (m/s); scales linearly with respect to speed. Defaults to 0.2.
#air_resistance = 0.2

# How fast the player jumps off the ground in m/s. Defaults to 8.
#jump_speed = 8

# How far away the player needs to be from the ground in meters to be considered in the air. Defaults to 0.2.
#ground_distance_tolerance = 0.2

# Radius of the player in meters. Defaults to 0.4.
#character_radius = 0.4

# How far a player can reach in meters when placing blocks. Defaults to 10.
#block_reach = 10