Configuration ‐ Main (Common) - xBigEllx/realistic-block-physics-mirror GitHub Wiki

Summary

The main configuration file, named rbp-common, is a place for configuring the global settings of the mod, and it applies to both the client and server. This means the server-side version of this configuration will take priority over that of any clients.

Configuration Properties

This section covers each property of the main configuration file.

Ref	Key	Type	Description	Default
1	Audio	...	Properties relating to audio/sounds.
2	ChunkAnalysis	...	Properties relating to chunk analysis.
3	Defaults	...	Properties relating to any defaults that are applied to certain features of the mod, such as default physics definitions to apply to worlds without one.
4	Performance	...	Properties relating to performance to manage the impact on TPS and FPS.
5	Physics	...	Global properties relating to the overall physics of the mod.

Audio

Ref	Key	Type	Description	Default
1.1	BlockImpactVolume	Decimal	The volume at which to sound falling blocks that have impacted with the ground.	1.0

ChunkAnalysis

Ref	Key	Type	Description	Default
2.1	ActiveRange	Integer	The chunk range at which chunk analysis updates will be scheduled, based on nearby players. A value of '0' will mean chunk analysis updates will only occur within the chunk the player is in. + Reducing this value can help improve performance.	4
2.2	Enabled	Boolean	Whether chunk analysis should be enabled (full physics scans on the blocks of a chunk). If chunk analysis is disabled, all other properties of this category will have no effect. + Disabling chunk analysis can help to improve performance.	true

Defaults

Ref	Key	Type	Description	Default
3.1	DefaultWorldDefinition	String	Specifies the default world definition to give to dimensions that do not have one assigned. Leave this empty if you do not wish to apply physics to dimensions that do not have a specified world definition.	""

Performance

Ref	Key	Type	Description	Default
4.1	DetailedIntegrityScans	Boolean	Whether to perform more detailed integrity scans on blocks. When the support of a block is removed, but is not touching the block it was supporting, a scan can be performed on all potentially affected nearby blocks to recalculate physics.	true
4.2	FallingBlockRate	Integer	The maximum number of falling blocks that can be added to each loaded dimension within a single tick.	2

Physics

Ref	Key	Type	Description	Default
5.1	BlocksCanBeCrushed	Boolean	Whether blocks should be able to be crushed if the weight above them exceeds their strength. The is dependent on the physics engine being used, and whether it supports the PillarStress feature.	true
5.2	BrokenBlockItemDropChance	Decimal	The chance of blocks dropping their items when breaking due to physics. This currently applies to blocks that break upon impact after falling, and also blocks that are crushed.	1.0
5.3	DiagonalBlockConnections	Boolean	Whether blocks should be able to connect to each other diagonally. Only blocks with CanAttachDiagonally enabled will be affected.	true
5.4	FallingBlockDamageDampening	Integer	A global dampening factor to apply to the base damage of entities when struck by falling blocks. + Increase this value to reduce the damage applied to entities when struck by falling blocks. - Lower this value to increase the damage applied to entities when struck by falling blocks.	500
5.5	FallingBlockRelocation	Boolean	Whether falling blocks that fall into the same position should be relocated instead of broken.	true

[!IMPORTANT] Diagonal block connections are only currently supported along the edges of a block. Blocks that are solely connected diagonally via its corners/vertices will not be supported.

[!NOTE] The damage a falling block inflicts upon an entity can be further tweaked beyond the FallingBlockDamageDampening value, on a per-block basis, by modifying the EntityDamageScale value within a block's block definition.