Minor fixes and small changes (#26)
* Update link in wiki/other/geyserconnect.md * fix: error title hierarchy in wiki\geyser\api.md * Update linking.md * Update geyser api version * Update floodgate javadocs link * Add the download link in hydraulic.md * Update hydraulic.md * Update understanding-the-config.md * fix(config-editor): no showing checkbox * Added the option to display the comments out * Update config-editor.tsx * Update config-editor.tsx * Update hydraulic.md --------- Co-authored-by: Kas-tle <26531652+Kas-tle@users.noreply.github.com>
This commit is contained in:
1 parent
4d4bd8046a
commit
d70a839a0e
9 files changed
+50
-16
No files matched your search
@@ -70,6 +70,26 @@ const ConfigEditorPage: React.FC = () => {
|
||||
|
||||
// Check if we are in a comment
|
||||
if (line.startsWith('#')) {
|
||||
if (!line.includes('# ') && line.includes(': ')) {
|
||||
const splitLine = line.split(':');
|
||||
splitLine[0] = splitLine[0].trim();
|
||||
splitLine[1] = splitLine[1].trim();
|
||||
if (splitLine[0] === '#proxy-protocol-whitelisted-ips') {
|
||||
currentComment = '';
|
||||
return;
|
||||
}
|
||||
currentComment += '<strong>Note: This option is commented on, and if you change it, it will be automatically uncommented.</strong>' + '<br>';
|
||||
// Add the config option to the config object
|
||||
newConfig[currentSection] = newConfig[currentSection] || {};
|
||||
newConfig[currentSection][splitLine[0]] = {
|
||||
desc: currentComment,
|
||||
value: splitLine[1]
|
||||
};
|
||||
|
||||
// Reset the comment
|
||||
currentComment = '';
|
||||
return;
|
||||
}
|
||||
currentComment += line.replace(/^# ?/i, '') + '<br>';
|
||||
return;
|
||||
}
|
||||
@@ -118,10 +138,10 @@ const ConfigEditorPage: React.FC = () => {
|
||||
{Object.keys(config[configKey]).map(configOption => {
|
||||
const configOptionInfo = config[configKey][configOption];
|
||||
const configOptionKey = configKey === '' ? configOption : `${configKey}.${configOption}`;
|
||||
|
||||
const showOptionName = configOption.replace('#','')
|
||||
return (
|
||||
<div key={configOptionKey} className={styles.configOption}>
|
||||
<h3>{configOption}</h3>
|
||||
<h3>{showOptionName}</h3>
|
||||
<p dangerouslySetInnerHTML={{ __html: configOptionInfo.desc }} />
|
||||
{getInput(configOptionKey, configOptionInfo.value)}
|
||||
</div>
|
||||
@@ -143,7 +163,12 @@ const ConfigEditorPage: React.FC = () => {
|
||||
if (currentObj.hasOwnProperty(nestedKey)) {
|
||||
if (index === keys.length - 1) {
|
||||
const oldValue = currentObj[nestedKey].value;
|
||||
newConfig = newConfig.replace(` ${nestedKey}: ${oldValue}`, ` ${nestedKey}: ${value}`);
|
||||
if (nestedKey.startsWith('#')) {
|
||||
const newKey = nestedKey.replace('#','');
|
||||
newConfig = newConfig.replace(` ${nestedKey}: ${oldValue}`, ` ${newKey}: ${value}`);
|
||||
} else {
|
||||
newConfig = newConfig.replace(` ${nestedKey}: ${oldValue}`, ` ${nestedKey}: ${value}`);
|
||||
}
|
||||
} else {
|
||||
currentObj = currentObj[nestedKey];
|
||||
}
|
||||
@@ -202,16 +227,19 @@ const ConfigEditorPage: React.FC = () => {
|
||||
// Boolean
|
||||
return (
|
||||
<div key={name}>
|
||||
<input className={styles.checkbox} type='checkbox' id={name} defaultChecked={value.toLowerCase() === 'true'} onChange={handleChange} />
|
||||
<input className={styles.checkbox} type='checkbox' id={name}
|
||||
defaultChecked={value.toLowerCase() === 'true'} onChange={handleChange}/>
|
||||
<label htmlFor={name} className='switch'></label>
|
||||
</div>
|
||||
);
|
||||
} else if (!isNaN(value)) {
|
||||
// Number
|
||||
return <input key={name} className={styles.formInput} type='number' defaultValue={value} id={name} onChange={handleChange} />;
|
||||
return <input key={name} className={styles.formInput} type='number' defaultValue={value}
|
||||
id={name} onChange={handleChange}/>;
|
||||
} else {
|
||||
// String
|
||||
return <input key={name} className={styles.formInput} type='text' defaultValue={value.replace(/"/g, '')} id={name} onChange={handleChange} />;
|
||||
return <input key={name} className={styles.formInput} type='text'
|
||||
defaultValue={value.replace(/"/g, '')} id={name} onChange={handleChange}/>;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -141,7 +141,7 @@
|
||||
}
|
||||
|
||||
.checkbox {
|
||||
display: none;
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
.hidden {
|
||||
|
||||
@@ -26,7 +26,7 @@ Most [API methods have a simple explanation](https://github.com/GeyserMC/Floodga
|
||||
|
||||
:::note
|
||||
|
||||
To see full, detailed documentation, see the [javadocs](https://repo.opencollab.dev/javadoc/maven-snapshots/org/geysermc/floodgate/api/2.2.2-SNAPSHOT).
|
||||
To see full, detailed documentation, see the [javadocs](https://repo.opencollab.dev/javadoc/maven-snapshots/org/geysermc/floodgate/api/latest).
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ player-link:
|
||||
enabled: true
|
||||
# Whether to use global linking. Global linking uses a central server to request link
|
||||
# accounts, allowing people to link once, join everywhere (on servers with global linking).
|
||||
use-global-linking: true
|
||||
enable-global-linking: true
|
||||
```
|
||||
([see the default config](https://github.com/GeyserMC/Floodgate/blob/master/core/src/main/resources/config.yml))
|
||||
|
||||
|
||||
+1
-1
@@ -92,7 +92,7 @@ The network package contains basic information about the remote server via the
|
||||
interface, such as the server's IP address and port, and the protocol version of the remote server. Or the auth type.
|
||||
You can also get the port/IP that Geyser listens to via the [BedrockListener](https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/network/BedrockListener.java) interface.
|
||||
|
||||
### [Skin](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/skin) {#skin}
|
||||
#### [Skin](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/skin) {#skin}
|
||||
The skin package contains some records representing skin data. If you want to change the skin of players, you can listen to the [SessionSkinApplyEvent](https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/event/bedrock/SessionSkinApplyEvent.java), and set a new skin, skin geometry or cape there.
|
||||
|
||||
#### [Pack](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/pack) {#pack}
|
||||
|
||||
@@ -32,7 +32,7 @@ Add Geyser's API codebase as a dependency:
|
||||
<dependency>
|
||||
<groupId>org.geysermc.geyser</groupId>
|
||||
<artifactId>api</artifactId>
|
||||
<version>2.4.1-SNAPSHOT</version>
|
||||
<version>2.4.2-SNAPSHOT</version>
|
||||
<scope>provided</scope>
|
||||
</dependency>
|
||||
```
|
||||
@@ -40,7 +40,7 @@ Add Geyser's API codebase as a dependency:
|
||||
**Gradle**
|
||||
```groovy
|
||||
dependencies {
|
||||
compileOnly('org.geysermc.geyser:api:2.4.1-SNAPSHOT')
|
||||
compileOnly('org.geysermc.geyser:api:2.4.2-SNAPSHOT')
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
@@ -22,6 +22,8 @@ The options for Geyser on the Bedrock-facing end. Mostly contains options for ho
|
||||
|
||||
**`compression-level`**: An number value that represents how much to compress outgoing traffic. Can be any number from -1 to 9; any other value will be replaced with the nearest acceptable value. The higher the number, the more CPU processing that is used but with less bandwidth used. Default is 6.
|
||||
|
||||
**`broadcast-port`**: The port to broadcast to Bedrock clients with the MOTD that they should use to connect to the server. DO NOT uncomment and change this unless Geyser runs on a different internal port than the one that is used to connect.
|
||||
|
||||
**`enable-proxy-protocol`**: Whether to enable PROXY protocol or not for clients. You DO NOT WANT this feature unless you run UDP reverse proxy in front of your Geyser instance. You do NOT need this for BungeeCord (and forks), Velocity, or Waterfall.
|
||||
|
||||
**`proxy-protocol-whitelisted-ips`**: Disabled by default, and only enable this if you use "enable-proxy-protocol". A list of allowed PROXY protocol speaking proxy IP addresses/subnets. Should really only be used when you are not able to use a proper firewall (usually true with shared hosting providers etc.). Keeping this list empty means there is no IP address whitelist. IP addresses, subnets, and links to plain text files containing either are supported.
|
||||
@@ -37,6 +39,8 @@ Options for the remote (Java) server.
|
||||
|
||||
**Please keep in mind, what you specify in the Geyser `auth-type` option MUST be the same as what the remote server has (with the exception of Geyser being in online mode and remote being in offline mode). You simply cannot join an online mode server without a genuine account. If you want to allow Minecraft: Bedrock Edition accounts to join without a Minecraft: Java Edition account, see the [Floodgate](/wiki/floodgate/) wiki page.**
|
||||
|
||||
**`allow-password-authentication`**: Allow for password-based authentication methods through Geyser. Only useful in online mode. If this is false, users must authenticate to Microsoft using a code provided by Geyser on their desktop.
|
||||
|
||||
**`use-proxy-protocol`**: Whether to enable PROXY/HAProxy protocol or not while connecting to the server. This is useful only when:
|
||||
- Your server supports PROXY protocol (it probably doesn't)
|
||||
- You run Velocity or BungeeCord with its respective option enabled.
|
||||
@@ -68,8 +72,6 @@ saved-user-logins:
|
||||
|
||||
**`passthrough-motd`**: If the MOTD should be relayed from the remote server. Causes the `motd1` and `motd2` options in the bedrock section to no longer have a use.
|
||||
|
||||
**`passthrough-protocol-name`**: Relay the protocol name (e.g. BungeeCord [X.X], Paper 1.X) - this is only really useful when using a custom protocol name! This will also show up on sites like MCSrvStatus. \<mcsrvstat.us\>
|
||||
|
||||
**`passthrough-player-count`**: If the current and max player counts should be relayed from the remote server.
|
||||
|
||||
**`legacy-ping-passthrough`**: If enabled, manually pings the server by impersonating a Minecraft client instead of using the server's API. **This option should *only* be enabled if your MOTD or player count is not accurate,** as it can cause errors especially on BungeeCord. This option does nothing on Geyser Standalone.
|
||||
|
||||
@@ -8,7 +8,7 @@ GeyserConnect is a extension for Geyser that allows you to join multiple servers
|
||||
## Setup {#setup}
|
||||
(For GeyserConnect to work you need an open UDP port, by default it's `19132`).
|
||||
1. Download the latest Geyser build from the [downloads page](https://geysermc.org/download#standalone)
|
||||
2. Download the latest build from [Github Actions](https://github.com/GeyserMC/GeyserConnect/actions)
|
||||
2. Download the latest build from [here](https://geysermc.org/download/?project=other-projects&geyserconnect=expanded)
|
||||
3. Extract the downloaded ZIP file, and put the extracted JAR file into the `extensions` folder in your GeyserMC standalone installation.
|
||||
4. Start Geyser standalone as you do with a normal Geyser install. EG: `java -Xms1024M -jar Geyser.jar` (More info on [Creating a Startup Script](/wiki/geyser/creating-a-startup-script/))
|
||||
5. Shutdown the standalone Geyser instance, and make you're desired changes to the GeyserConnect configuration in `GeyserConnect` in the `extensions` folder.
|
||||
|
||||
@@ -15,6 +15,10 @@ This project is still in very early development and should not be used on produc
|
||||
|
||||
:::
|
||||
|
||||
## Download {#download}
|
||||
|
||||
You can download Hydraulic [here](https://geysermc.org/download/?project=other-projects&hydraulic=expanded).
|
||||
|
||||
## Contributing {#contributing}
|
||||
|
||||
Any contributions are appreciated. Please feel free to reach out to us on [Discord](https://discord.gg/geysermc) if
|
||||
@@ -25,4 +29,4 @@ you're interested in helping out with Hydraulic.
|
||||
1. Clone the repo to your computer.
|
||||
2. Navigate to the Hydraulic root directory and run `git submodule update --init --recursive`. This command downloads all the needed submodules for Hydraulic and is a crucial step in this process.
|
||||
3. The project should import into your IDE after the loom setup is complete. For more detailed information, see the [Fabric setup](https://fabricmc.net/wiki/tutorial:setup)
|
||||
4. Use `./gradlew build` to compile a jar file, or use `./gradlew :fabric:runServer` or `./gradlew :neoforge:runServer` to run a server with Hydraulic installed. Make sure to install Geyser into your `mods` folder!
|
||||
4. Use `./gradlew build` to compile a jar file, or use `./gradlew :fabric:runServer` or `./gradlew :neoforge:runServer` to run a server with Hydraulic installed. Make sure to install Geyser into your `mods` folder!
|
||||
Reference in new issue
Block a user