Skip to content
fayer3 edited this page Oct 23, 2025 · 2 revisions

General Settings

Check for Updates

Will check for new mod versions when an OP logs into the server and sends a system message to them.

  • Config path: general.checkForUpdate
  • Default Value: true

Update Type

What updates to notify for.
Options are: RELEASE, BETA, ALPHA

  • Config path: general.checkForUpdateType
  • Default Value: RELEASE

VR Only

Set to true to only allow VR players to join the server.
If enabled, VR hotswitching will be automatically disabled.

  • Config path: general.vr_only
  • Default Value: false

Vivecraft Only

Set to true to only allow players that have Vivecraft installed to join the server.

  • Config path: general.vive_only
  • Default Value: false

Allow OPs

Set to true, to allow server OPs to bypass VR/Vivecraft only settings.

  • Config path: general.allow_op
  • Default Value: true

Message and Kick Delay

Ticks to wait before kicking a player or sending the welcome messages. (20 ticks is 1 second)
The player's client must send the Vivecraft VERSION info in this time.

  • Config path: general.messageAndKickDelay
  • Default Value: 200
  • Min: 100
  • Max: 1000

VR Easteregg items

Gives VR Players fun cakes and drinks at random, when they respawn.

  • Config path: general.vrFun
  • Default Value: true

Add Vivecraft Vrafting Recipes

Allows crafting of Vivecraft items, like the Climbing Claws or the Jump Boots

  • Config path: general.viveCrafting
  • Default Value: true

Request VR Data.

Asks the client for the VR data, if this is disabled no movement data will be shared, and some features will not work.

  • Config path: general.requestData
  • Default Value: true

Send VR Data

Send the VR movement data to the clients, if this is disabled clients will not see each others movement.

  • Config path: general.sendData
  • Default Value: true

Send Data to Owner

Sends the player position data also back to the player that sent it, usually not needed.
Enable this on a dedicated server when using replay mod or something similar.

  • Config path: general.sendDataToOwner
  • Default Value: false

Kick players on setting change.

Kicks players on setting changes, if they don't support updating that setting on the fly. So it forces a rejoin.

  • Config path: general.kickPlayersOnSettingUpdate
  • Default Value: false

Spigot Setting Overrides

Enable Spigot Setting Overrides.

When enabled, this will override the listed spigot settings.

  • Config path: setSpigotSettings.enabled
  • Default Value: true

'moved-wrongly-threshold' Override

Overrides the moved-wrongly-threshold spigot setting, if this is larger.

  • Config path: setSpigotSettings.movedWronglyThreshold
  • Default Value: 15.0
  • Min: 0.0
  • Max: 10000.0

'moved-too-quickly-multiplier' Override

Overrides the moved-too-quickly-multiplier spigot setting, if this is larger.

  • Config path: setSpigotSettings.movedTooQuickly
  • Default Value: 64.0
  • Min: 0.0
  • Max: 10000.0

Permissions

Enable Permissiongroups

Will assign players to the VR/NonVR groups when they join and have vivecraft installed.

  • Config path: permissions.groupsEnabled
  • Default Value: true

NonVR Permissiongroup

The group to assign to Vivecraft players that are not in VR.

  • Config path: permissions.NonVRgroup
  • Default Value: 'vive.non-vivegroup'

NonVR Permissiongroup

The group to assign to Vivecraft players that are actively in VR.

  • Config path: permissions.VRgroup
  • Default Value: 'vive.vivegroup'

Climbing Limit Bypass

Permission that can be given to allow players to climb on any block.
This is the same as setting climbey.blockmode to DISABLED just for them.

  • Config path: permissions.climbperm
  • Default Value: 'vive.climbanywhere'

Messages Settings

Set message to nothing to not send. e.g., leaveMessage = ''
Use &player in any message for the player name.
For messages that take two placeholders (i.e., death by mob) use &cause for the second placeholder.
When using a placeholder in a message, the message needs to be surrounded by '' to load correctly

Enable Messages

Enable or disable all messages.

  • Config path: messages.enabled
  • Default Value: false

VR Welcome Message

Message sent when a player joins with VR active.

  • Config path: messages.welcomeVR
  • Default Value: '&player has joined with standing VR!'

NonVR Welcome Message

Message sent when a player joins with VR not active.

  • Config path: messages.welcomeNonVR
  • Default Value: '&player has joined with Non-VR companion!'

Seated VR Welcome Message

Message sent when a player joins with VR in seated mode.

  • Config path: messages.welcomeSeated
  • Default Value: '&player has joined with seated VR!'

Non Vivecraft Welcome Message

Message sent when a player joins without vivecraft installed.

  • Config path: messages.welcomeVanilla
  • Default Value: '&player has joined as a Muggle!'

Leave Message

Message sent when a player leaves the server.

  • Config path: messages.leaveMessage
  • Default Value: '&player has disconnected from the server!'

VR Death Message

Message sent when a player dies with VR active.

  • Config path: messages.deathVR
  • Default Value: '&player died in standing VR!'

NonVR Death Message

Message sent when a player dies with VR not active.

  • Config path: messages.deathNonVR
  • Default Value: '&player died in Non-VR companion!'

Seated VR Death Message

Message sent when a player dies with VR in seated mode.

  • Config path: messages.deathSeated
  • Default Value: '&player died in seated VR!'

Non Vivecraft Death Message

Message sent when a player dies without Vivecraft.

  • Config path: messages.deathVanilla
  • Default Value: '&player died as a Muggle!'

VR Death by Mob Message

Message sent when a player dies because of a mob with VR active.

  • Config path: messages.deathByMobVR
  • Default Value: '&player was slain by &cause in standing VR!'

NonVR Death by Mob Message

Message sent when a player dies because of a mob with VR not active.

  • Config path: messages.deathByMobNonVR
  • Default Value: '&player was slain by &cause in Non-VR companion!'

Seated VR Death by Mob Message

Message sent when a player dies because of a mob with VR in seated mode.

  • Config path: messages.deathByMobSeated
  • Default Value: '&player was slain by &cause in seated VR!'

Non Vivecraft Death by Mob Message

Message sent when a player dies because of a mob without Vivecraft.

  • Config path: messages.deathByMobVanilla
  • Default Value: '&player was slain by &cause as a Muggle!'

Vivecraft Only Kick Message

Message sent to a player when they get kicked because of the Vivecraft Only setting.

  • Config path: messages.KickViveOnly
  • Default Value: 'This server is configured for Vivecraft players only.'

VR Only Kick Message

Message sent to a player when they get kicked because of the VR Only setting.

  • Config path: messages.KickVROnly
  • Default Value: 'This server is configured for VR players only.'

Vanilla Modifications for VR Players

Creeper Swell Distance

Distance at which creepers swell and explode for standing VR players.
Vanilla distance: 3

  • Config path: vrChanges.creeperSwellDistance
  • Default Value: 1.75
  • Min: 0.1
  • Max: 10.0

Mobs Melee Range Adjustment

Adjusts the range in which mobs can use melee attacks against standing VR players.
This is a reduction to the vanilla range (0.8 blocks), so 0.0 causes no change, and -0.7 means the mobs need to almost touch the player to cause an attack.
When set very low, mobs might stop right in front of the player without attacking!

  • Config path: vrChanges.mobAttackRangeAdjustment
  • Default Value: -0.4
  • Min: -0.7
  • Max: 0.0

Dual Wielding

Allows vr players to hit/mine with their non-dominant hand items.
CAUTION! When enabling this, also make sure to enable allowFasterBlockBreaking, or breaking blocks too fast will still use the main hand item.

  • Config path: vrChanges.dualWielding
  • Default Value: true

Boots Damage Addition

Melee damage addition for VR players when hitting with their feet.
This scales with the armor attribute of the boots, doing one additional damage per Armor level, times this multiplier
Set to 0.0 to disable.

  • Config path: vrChanges.bootsArmorDamage
  • Default Value: 0.0
  • Min: 0.0
  • Max: 5.0

Projectile Inaccuracy Multiplier

Projectiles by default have an inaccuracy to not shoot in the same direction all the time.
With this, the inaccuracy can be adjusted for VR players.
1.0 is equal to vanilla, 0.0 is no inaccuracy at all.

  • Config path: vrChanges.projectileInaccuracyMultiplier
  • Default Value: 1.0
  • Min: 0.0
  • Max: 1.0

Allow Faster Block Breaking

Allows VR players to bypass the vanilla block breaking check, which prevents breaking blocks too fast.

  • Config path: vrChanges.allowFasterBlockBreaking
  • Default Value: true

Allow Roomscale Shield Blocking

Allows VR players to block attacks by holding their shield up, without needing to actively use it. This means they can block attacks without needing to slow down.

  • Config path: vrChanges.allowRoomscaleShieldBlocking
  • Default Value: true

Allow Attacks While Blocking

Allows VR players to attack entities, while they are actively using a shield. (This setting does not affect roomscale shield blocking)

  • Config path: vrChanges.allowAttacksWhileBlocking
  • Default Value: true

Bow Damage Adjustments

Standing VR Bow Damage Multiplier

Archery damage multiplier for VR players in standing mode.
Set to 1.0 to disable.

  • Config path: vrChanges.bow.standingMultiplier
  • Default Value: 1.5
  • Min: 1.0
  • Max: 10.0

Seated VR Bow Damage Multiplier

Archery damage multiplier for VR players in seated mode.
Set to 1.0 to disable.

  • Config path: vrChanges.bow.seatedMultiplier
  • Default Value: 1.0
  • Min: 1.0
  • Max: 10.0

Standing VR Bow Headshot Multiplier

Headshot damage multiplier for VR players in standing mode.
Set to 1.0 to disable.

  • Config path: vrChanges.bow.standingHeadshotMultiplier
  • Default Value: 2.0
  • Min: 1.0
  • Max: 10.0

Seated VR Bow Headshot Multiplier

Headshot damage multiplier for VR players in seated mode.
Set to 1.0 to disable.

  • Config path: vrChanges.bow.seatedHeadshotMultiplier
  • Default Value: 1.5
  • Min: 1.0
  • Max: 10.0

NonVR Bow Headshot Multiplier

Headshot damage multiplier for Vanilla/NonVR players.
Set to 1.0 to disable.

  • Config path: vrChanges.bow.vanillaHeadshotMultiplier
  • Default Value: 1.0
  • Min: 1.0
  • Max: 10.0

Headshot Indicator

Indicator to notify players that they got a headshot. Options are:
NONE: No indicator.
AUDIO: Plays a sound near the shooter.
VISUAL: Spawns particles at the hit location.
BOTH: Both Audio and Visual indicators.

  • Config path: vrChanges.bow.headshotIndicator
  • Default Value: BOTH

PVP Settings

Send Damage Negated Notification

Notifies the player that tried to cause damage, that it was blocked from the server.

  • Config path: pvp.notifyBlockedDamage
  • Default Value: false

Allow Standing VR vs Standing VR Damage

Allows Standing VR players to damage each other.

  • Config path: pvp.VRvsVR
  • Default Value: true

Allow Seated VR vs Seated VR Damage

Allows Seated VR players to damage each other.

  • Config path: pvp.SEATEDVRvsSEATEDVR
  • Default Value: true

Allow Standing VR vs NonVR Damage

Allows Standing VR players and Non VR players to damage each other.

  • Config path: pvp.VRvsNONVR
  • Default Value: true

Allow Seated VR vs NonVR Damage

Allows Seated VR players and Non VR players to damage each other.

  • Config path: pvp.SEATEDVRvsNONVR
  • Default Value: true

Allow Standing VR vs Seated VR Damage

Allows Standing VR players and Seated VR Players to damage each other.

  • Config path: pvp.VRvsSEATEDVR
  • Default Value: true

Climbey Motion Settings

Allow Climbey Climb/Jump

Allows the use of Jump Boots and Climb Claws.

  • Config path: climbey.enabled
  • Default Value: false

Climbable Blockmode

Specifies how the blocks in the blocklist are interpreted. Options are:
DISABLED: List is ignored. All blocks are climbable.
WHITELIST: Only blocks on the list are climbable.
BLACKLIST: All blocks are climbable except those on the list

  • Config path: climbey.blockmode
  • Default Value: DISABLED

Climbey Blocklist

List of block names for use with WHITELIST/BLACKLIST block mode.
Uses Mojang block names, not Spigot materials.
For 1.12.2 and older these are of the form id:data or name:data
i.e. wool:14 or 35:14.
For 1.13+ these are of the form namespace:blockid or just blockid
i.e. minecraft:white_wool or white_wool

  • Config path: climbey.blocklist
  • Default Value: [white_wool, dirt, grass_block]

Roomscale Crawling Settings

Allow Roomscale Crawling

Allows VR players to get into the crawl state by getting low to the ground. Disabling does not prevent vanilla crawling.

  • Config path: crawling.enabled
  • Default Value: true

Teleport Settings

Allow Teleporting

Allows VR players to use teleport movement. It is recommended to leave this enabled for players prone to VR sickness.
Disabling this only works for Vivecraft 1.3.0+ clients.

  • Config path: teleport.enabled
  • Default Value: true

Force Limit Survival Teleport range

Enforces limited teleport range and frequency in Survival.

  • Config path: teleport.limitedSurvival
  • Default Value: false

Forced Up Teleport Limit

Maximum number of blocks players in Survival mode can teleport up. Set to 0 to disable.

  • Config path: teleport.upLimit
  • Default Value: 4
  • Min: 1
  • Max: 16

Forced Down Teleport Limit

Maximum number of blocks players in Survival mode can teleport down. Set to 0 to disable.

  • Config path: teleport.downLimit
  • Default Value: 4
  • Min: 1
  • Max: 16

Forced Horizontal Teleport Limit

Maximum number of blocks players in Survival mode can teleport horizontally. Set to 0 to disable.

  • Config path: teleport.horizontalLimit
  • Default Value: 16
  • Min: 1
  • Max: 32

Worldscale Settings

Limit Worldscale Range

Limit the range of worldscales players are allowed to use.

  • Config path: worldScale.limitRange
  • Default Value: false

Minimum Worldscale

Lower limit of allowed worldscale

  • Config path: worldScale.min
  • Default Value: 0.5
  • Min: 0.1
  • Max: 100.0

Maximum Worldscale

Upper limit of allowed worldscale

  • Config path: worldScale.max
  • Default Value: 2.0
  • Min: 0.1
  • Max: 100.0

Other Clientsetting Overrides

Force 'Raw Item Positions'

Forces players to use the Raw Item Positions setting

  • Config path: settingOverrides.thirdPersonItems
  • Default Value: false

Force 'Raw Custom Item Positions'

Forces players to use the Raw Item Positions setting, only for items with custom model data/custom item models.

  • Config path: settingOverrides.thirdPersonItemsCustom
  • Default Value: false

VR Hotswitch Settings

Allow switching between VR / NonVR

Allows players to switch between VR and NonVR on the fly.
If disabled, they will be locked to the mode they joined with.

  • Config path: vrSwitching.enabled
  • Default Value: true

Debug Settings

Debug Logging

Will log debug information, like clients that connect with Vivecraft and their Vivecraft version.

  • Config path: debug.debugLogging
  • Default Value: false

Debug Particles

Debug Particles

Will spawn debug particles to indicate the server state.

  • Config path: debug.particles.enabled
  • Default Value: false

OP Only Particles

Only spawns particles near server operators.

  • Config path: debug.particles.opOnly
  • Default Value: true

Device Particles

Will spawn particles at VR players device positions, to indicate the server VR data state.

  • Config path: debug.particles.vrDevices
  • Default Value: false

Head Particles

Will spawn particles at VR players head position, to indicate the server VR data state.

  • Config path: debug.particles.vrHead
  • Default Value: false

Head Hitbox Particles

Will spawn particles at the corners of the bow head hitbox.

  • Config path: debug.particles.headHitbox
  • Default Value: false
Clone this wiki locally