Skip to content

Commit 5e90970

Browse files
committed
fixes
1 parent 560181d commit 5e90970

9 files changed

Lines changed: 3683 additions & 2333 deletions

File tree

docs/configuration/config.mdx

Lines changed: 93 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,96 @@
11
---
2-
title: "🗎 GE Config (config.yml)"
2+
title: "🗎 GE Default Config (config.yml)"
33
sidebar_position: 1
44
---
5+
```yaml
6+
# GeyserExtras
7+
# If Geyser is detected, all required config changes will be automatically applied.
8+
# For more details, go to https://geyserextras.letsgoaway.dev/
9+
10+
# Enable the GeyserExtras menu, which can be opened by players by
11+
# double-tapping inventory, or typing `/ge`.
12+
#
13+
# The GeyserExtras Menu provides actions and configurable settings such as
14+
# - Remapping certain actions (e.g emotes/pick block) to Java Edition only actions (e.g offhand)
15+
# - Configurable HUD Visibility
16+
# - Quick access to form remakes of Java Edition Menus
17+
# (e.g Player List, Advancements, Statistics).
18+
#
19+
# You can configure default options for Bedrock Players at
20+
# `preferences/default.json`
21+
# and for Java Players at
22+
# `preferences/java/default.json`.
23+
#
24+
# Setting this to `false` also disables saving of preferences.
25+
enable-geyser-extras-menu: true
26+
27+
# Enable the Java Edition styled cooldown.
28+
enable-custom-cooldown: true
29+
30+
# Enable the Java Edition combat sounds.
31+
enable-java-combat-sounds: true
32+
33+
# Enable the Block Display entity workaround using FMBE. (EXPERIMENTAL)
34+
# Note that the translation is not 100% accurate and some block types might be invisible (candles, doors, campfires),
35+
# where as some blocks will render differently (fence, glass panes, some storage containers).
36+
# Block Display billboards do not work and X/Z scale are linked to which ever one is highest,
37+
# meaning that this should only be enabled for very simple usages of Block Displays.
38+
# (https://wiki.bedrock.dev/commands/display-entities.html)
39+
enable-block-display-workaround: false
40+
41+
# Requires PacketEvents and Java Edition clients on 1.21.9 or above.
42+
# https://modrinth.com/plugin/packetevents
43+
44+
# Enables the cape workaround. (EXPERIMENTAL)
45+
46+
# This shows Bedrock Edition player capes on Java Edition clients,
47+
# by using fake mannequin player entities.
48+
# It copies the packets of the player, so the position is identical.
49+
# The hitbox of the mannequin is identical to the player and
50+
# whenever the mannequin is attacked by the player it is translated as an attack
51+
# to the bedrock player.
52+
53+
# This may break anti-cheats or plugins, and is not perfect.
54+
55+
# The Bedrock Edition player's cape will sometimes slightly clip
56+
# inside the Bedrock Player when wearing armor and if the player attacks.
57+
58+
# The cape is visually removed when entering mounts that can support more than one
59+
# player (including chest boats).
60+
61+
# This only works with capes that are available on Java Edition, that are also on
62+
# Bedrock Edition.
63+
enable-bedrock-capes-on-java-workaround: true
64+
65+
# When the server closes or Geyser reloads, should GeyserExtras automatically reconnect players to the server.
66+
auto-reconnect: true
67+
68+
# The language that Java Edition players read when using a GeyserExtras command (e.g, `/muteemotechat`).
69+
# This is automatically set on Bedrock Edition from the player's settings.
70+
# You can see the list of all locale codes here:
71+
# https://github.com/GeyserExtras/data/blob/main/langs/language_names.json
72+
default-locale: en_US
73+
74+
# Enables downloading of Bedrock Player skins.
75+
# This will download the Geometry, Animations, and Textures of your players skins/capes.
76+
# Persona skins are currently bugged.
77+
enable-skin-saving: true
78+
79+
# Whether to disable the Paper Doll or not.
80+
# The Paper Doll is the small player graphic in the top left of bedrock players screens
81+
# This can give players a competitive advantage over java in some cases, for example,
82+
# you can see what armor you have on without pressing the inventory key
83+
# you can see what armor has broken during combat
84+
disable-paper-doll: false
85+
86+
# Whether to check for updates or not.
87+
# This also disables updating of the GeyserExtrasPack and GeyserOptionalPack,
88+
# however you can manually update them by deleting the 'GeyserExtras/cache/' folder.
89+
check-for-updates: true
90+
91+
# Only enable if you know what you are doing.
92+
debug-mode: false
93+
94+
# The version of the config. DO NOT CHANGE!
95+
version: 4
96+
```

docs/configuration/java-preferences.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,12 @@
22
title: "👥\ufe0e Java Preferences (preferences/java/default.json)"
33
sidebar_position: 3
44
---
5+
Please ensure you follow proper JSON formatting or the plugin may fail to read your config.
6+
7+
## `muteEmoteChat`
8+
#### Default: `false`
9+
#### Values: `true` | `false`
10+
Set the default emote chat mute status for Java Players.
11+
They can toggle this with `/emotechat`.
12+
13+

docs/configuration/player-preferences.mdx

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,58 @@
22
title: "👤\ufe0e GE Menu Preferences (preferences/default.json)"
33
sidebar_position: 2
44
---
5+
:::warning
6+
All options below can be edited by the player, these set the defaults.
7+
8+
If you dont want the player to be able to edit these options, set `enable-geyser-extras-menu: false` in config.yml.
9+
:::
10+
11+
## `cooldownType`
12+
#### Default: `"TITLE"`
13+
#### Values: `"TITLE"`
14+
Set the default combat cooldown indicator location for Bedrock Edition players.
15+
16+
## `showCoordinates`
17+
#### Default: `true`
18+
#### Values: `true` | `false`
19+
Set the default visibility of the coordinate display for Bedrock Edition players.
20+
21+
## `advancedTooltips`
22+
#### Default: `false`
23+
#### Values: `true` | `false`
24+
Set the default visibility of Geyser's Java Advanced Tooltips display for Bedrock Edition players. (F3+H on Java Edition)
25+
26+
## `customSkullSkins`
27+
#### Default: `true`
28+
#### Values: `true` | `false`
29+
Set the default visibility of Geyser's Player Skull skin workaround for Bedrock Edition players.
30+
31+
## `remappableActionMap`
32+
TODO
33+
34+
## `adjustCooldownWithPing`
35+
#### Default: `true`
36+
#### Values: `true` | `false`
37+
Set the default option for adjusting cooldown meter progress based on connection to the server.
38+
39+
Recommended to stay enabled as this can help with combat timing.
40+
41+
## `indicatorUpdateRate`
42+
#### Default: `60.0`
43+
#### Values: `any number from 5-300`
44+
Set the default option for the display update rate of the combat cooldown indicator.
45+
This can solve problems with flickering on higher frame rate monitors.
46+
47+
:::note TODO ↓
48+
:::
49+
50+
## `settingsMenuForm`
51+
## `enableDoubleClickShortcut`
52+
## `doubleClickMS`
53+
## `promptOnLinks`
54+
## `lockedPerspective`
55+
## `selectedPacks`
56+
## `selectedSubpacks`
57+
## `sendSystemToasts`
58+
## `showFPS`
59+

docs/features/emote-chat.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
---
22
title: "Emote Chat"
33
---
4+
GeyserExtras can foward the Emote Chat to Java Edition players.
5+
-18.7 MB
Binary file not shown.
10.7 MB
Binary file not shown.

docs/features/pack/java-combat-improvements.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ title: "Java Edition Combat Improvements"
44
description: "Sounds and Textures"
55
---
66
import ReactPlayer from 'react-player'
7-
import combatsoundsvideo from './assets/combatsounds.mp4'
7+
import combatsoundsvideo from './assets/combatsounds.webm'
88

99

1010
# Java Edition Combat Improvements
1111

1212
## Configuration
1313

1414
<details>
15-
<summary>🗎 GE Config (`config.yml`)</summary>
15+
<summary> Related **🗎 GE Config (`config.yml`)** Options</summary>
1616

1717
```yaml
1818
# Enable the Java Edition styled cooldown.
@@ -25,8 +25,8 @@ enable-java-combat-sounds: true
2525
2626
2727
<details>
28-
<summary>👤&#xfe0e; GE Menu Preferences (`preferences/default.json`)</summary>
29-
28+
<summary>Related **👤&#xfe0e; GE Menu Preferences (`preferences/default.json`)** Options</summary>
29+
[`cooldownType: "TITLE"`](/docs/configuration/player-preferences#cooldowntype)
3030
</details>
3131
3232

docs/features/skin-saver.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: "Skin Saver"
3+
---

0 commit comments

Comments
 (0)