From 90d46f0ec7c0178e13c57702473585ccd04159a5 Mon Sep 17 00:00:00 2001 From: Kas-tle <26531652+Kas-tle@users.noreply.github.com> Date: Mon, 8 Apr 2024 12:19:14 -0700 Subject: [PATCH] Add hydraulic to other downloads --- docs/other/geyseroptionalpack.md | 2 -- docs/other/hydraulic.md | 28 ++++++++++++++++++++++++++++ sidebars.ts | 3 ++- src/pages/download/index.tsx | 18 ++++++++++++++++-- 4 files changed, 46 insertions(+), 5 deletions(-) create mode 100644 docs/other/hydraulic.md diff --git a/docs/other/geyseroptionalpack.md b/docs/other/geyseroptionalpack.md index 1432b8d..f02b4d3 100644 --- a/docs/other/geyseroptionalpack.md +++ b/docs/other/geyseroptionalpack.md @@ -3,8 +3,6 @@ title: GeyserOptionalPack description: GeyserOptionalPack is a Bedrock resource pack that fixes parity issues with Geyser to bring Bedrock Edition in line with Java Edition. --- -# GeyserOptionalPack - ## [Download here](https://ci.opencollab.dev/job/GeyserMC/job/GeyserOptionalPack/job/master/lastSuccessfulBuild/artifact/GeyserOptionalPack.mcpack) {#download-here} GeyserOptionalPack is a Bedrock resource pack that adds more features to Geyser to bring Bedrock Edition in line with Java Edition. A resource pack allows various features and bug fixes to be implemented in Bedrock, including: diff --git a/docs/other/hydraulic.md b/docs/other/hydraulic.md new file mode 100644 index 0000000..fbcca37 --- /dev/null +++ b/docs/other/hydraulic.md @@ -0,0 +1,28 @@ +--- +title: Hydraulic +description: 'Hydraulic is a companion to Geyser which allows for Bedrock players to join modded Minecraft: Java Edition servers.' +--- + +Hydraulic is a companion to Geyser which allows for Bedrock players to join modded Minecraft: Java Edition servers. + +## What is Hydraulic? {#what-is-hydraulic} + +Hydraulic is a server-side mod, which allows for Bedrock players to join modded Minecraft: Java Edition servers. This project works alongside [Geyser](https://github.com/GeyserMC/Geyser) to make this possible. + +:::caution + +This project is still in very early development and should not be used on production setups! + +::: + +## Contributing {#contributing} + +Any contributions are appreciated. Please feel free to reach out to us on [Discord](https://discord.gg/geysermc) if +you're interested in helping out with Hydraulic. + +### Project Setup {#project-setup} + +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! \ No newline at end of file diff --git a/sidebars.ts b/sidebars.ts index d0e020c..62e37dd 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -125,7 +125,8 @@ const sidebars: SidebarsConfig = { 'other/community-geyser-projects', 'other/test-server', 'other/developer-guide', - 'other/discord-bot-usage' + 'other/discord-bot-usage', + 'other/hydraulic' ] }; diff --git a/src/pages/download/index.tsx b/src/pages/download/index.tsx index b7ad0ed..e27bd9c 100644 --- a/src/pages/download/index.tsx +++ b/src/pages/download/index.tsx @@ -1,7 +1,7 @@ import React from 'react'; import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -import { faTowerCell, faFileZipper } from '@fortawesome/free-solid-svg-icons'; +import { faTowerCell, faFileZipper, faGear } from '@fortawesome/free-solid-svg-icons'; import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'; import HeroBanner from '@site/src/components/HeroBanner'; import HeroBackground from '@site/static/img/site/split-background.jpg'; @@ -26,7 +26,7 @@ const DownloadPage: React.FC = () => ( backgroundImage={HeroBackground} /> - + ( /> } /> + A companion mod to Geyser which allows for Bedrock players to join modded Minecraft: Java Edition servers.} + inner={ + Hydraulic, + }} + gridColumns={1} + /> + } + />