From e173c06eb9da9e84e2e63e4871ff7ef5868b4e43 Mon Sep 17 00:00:00 2001 From: qscbm187531 <1309635304@qq.com> Date: Thu, 7 Sep 2023 19:51:52 +0800 Subject: [PATCH] Fix hyperlinks and update some descriptions. (#193) * Fix hyperlinks in custom-skulls.md * Fix hyperlinks in toc.yml. * Update extensions.md * Update api.md * Fix word errors * Update geyser api version * Update api.md * Add a limitations * Update api.md * Update api.md * Update _docs/geyser/api.md Co-authored-by: rtm516 --------- Co-authored-by: rtm516 --- _data/toc.yml | 2 +- _docs/geyser/api.md | 4 ++++ _docs/geyser/current-limitations.md | 1 + _docs/geyser/custom-skulls.md | 4 ++-- _docs/geyser/extensions.md | 4 ++-- _docs/geyser/getting-started-with-the-api.md | 6 +++--- 6 files changed, 13 insertions(+), 8 deletions(-) diff --git a/_data/toc.yml b/_data/toc.yml index 42ea9af..0f4560a 100644 --- a/_data/toc.yml +++ b/_data/toc.yml @@ -55,7 +55,7 @@ - title: Enabling custom skulls url: "geyser/custom-skulls/#enabling-custom-skulls" - title: custom-skulls.yml - url: "geyser/custom-skulls/#custom-skulls.yml" + url: "geyser/custom-skulls/#custom-skullsyml" - title: Geyser API url: "geyser/api/" children: diff --git a/_docs/geyser/api.md b/_docs/geyser/api.md index 3d59615..95ce5d9 100644 --- a/_docs/geyser/api.md +++ b/_docs/geyser/api.md @@ -81,6 +81,10 @@ like currently, showing emotes. The item package contains classes and interfaces related to items in Geyser. You can create custom items and register them using the Geyser API. See [here](/geyser/custom-items) for detailed information on how to register custom items. +#### [Block](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/block) +The block package contains classes and interfaces related to blocks in Geyser. You can create custom blocks using this package, and register them in using the [GeyserDefineCustomBlocksEvent](https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/event/lifecycle/GeyserDefineCustomBlocksEvent.java). +See [here](/geyser/custom-blocks) for detailed information. + #### [Network](https://github.com/GeyserMC/Geyser/tree/master/api/src/main/java/org/geysermc/geyser/api/network) The network package contains basic information about the remote server via the [RemoteServer](https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/network/RemoteServer.java) diff --git a/_docs/geyser/current-limitations.md b/_docs/geyser/current-limitations.md index caf8c99..3cd66ce 100644 --- a/_docs/geyser/current-limitations.md +++ b/_docs/geyser/current-limitations.md @@ -25,6 +25,7 @@ The following things cannot be fixed without changes to Bedrock or the Java prot - Invisible item frames - Blocks (excluding jack-o-lantern) on entity heads (E.G. armor stands, players) - Saddled camels unmoveable/unrideable on bedrock. +- Bedrock edition players cannot see the changes to fence block states made by the Java Debug Stick. The following changes **are supported** with the [GeyserOptionalPack](/other/geyseroptionalpack/), which is a Bedrock resource pack you can install for additional functionality for features Bedrock does not natively support: - Custom armor stand poses diff --git a/_docs/geyser/custom-skulls.md b/_docs/geyser/custom-skulls.md index c66de16..573293f 100644 --- a/_docs/geyser/custom-skulls.md +++ b/_docs/geyser/custom-skulls.md @@ -6,7 +6,7 @@ title: Custom skulls with Geyser Unlike Java Edition, Bedrock does not have native support for custom skull items. As a result, any method to display custom skulls with Geyser is, to some extent, a workaround. Geyser has long supported in-world custom skulls via the spawning of player entities. This, however, does not allow for the use of custom skulls in inventories, nor does it allow them to be worn by entities. To resolve this, Geyser now allows for the pre-registration of custom skulls via a config file. Geyser will then use this config file to generate a custom resource pack on start that contains the geometry and textures for the pre-registered custom skulls. To the client, these skulls are blocks. Therefore, they can be held in player inventories. In additional, attachables are defined for each skull block so that it is displayed correctly when worn and held by entities. -To setup custom skulls in geyser, you have to choose how you are going to register your blocks. The easiest is [using custom-skulls.yml](#custom-skulls.yml) but you can also [use a Geyser extension](#geyser-extensions). +To setup custom skulls in geyser, you have to choose how you are going to register your blocks. The easiest is [using custom-skulls.yml](#custom-skullsyml) but you can also [use a Geyser extension](#geyser-extensions). ## Enabling custom skulls @@ -135,4 +135,4 @@ public class RegisterCustomSkull implements Extension { ## Scraping custom skulls from a world -Custom skulls can be extracted from an existing world for easy implementation via mappings or API using the tool [HeadExtractor](https://github.com/davchoo/HeadExtractor) made by Amberichu. See the linked repository for usage instructions. \ No newline at end of file +Custom skulls can be extracted from an existing world for easy implementation via mappings or API using the tool [HeadExtractor](https://github.com/davchoo/HeadExtractor) made by Amberichu. See the linked repository for usage instructions. diff --git a/_docs/geyser/extensions.md b/_docs/geyser/extensions.md index 3fdceaf..4877898 100644 --- a/_docs/geyser/extensions.md +++ b/_docs/geyser/extensions.md @@ -7,7 +7,7 @@ Geyser Extensions are the equivalent of "plugins", but specifically for the Geys ### What can Geyser Extensions do? Extensions can fully utilize the Geyser API to add additional functionality to Geyser. See [Geyser API docs](/geyser/api/) for info on what is currently possible. To name a few examples: -- Register custom items +- Register custom items and blocks - Hide commands from being suggested - Change the MOTD - Register your own commands @@ -120,4 +120,4 @@ See [here](/geyser/events) for documentation. You do not need to register the ev Facing troubles with extensions? - Make sure you are using the latest version of Geyser - older versions might not have the latest API changes. - Add debug prints. -- Ask in the #development channel in the [Geyser Discord server](https://discord.gg/geysermc). \ No newline at end of file +- Ask in the #development channel in the [Geyser Discord server](https://discord.gg/geysermc). diff --git a/_docs/geyser/getting-started-with-the-api.md b/_docs/geyser/getting-started-with-the-api.md index d36d1c5..38db495 100644 --- a/_docs/geyser/getting-started-with-the-api.md +++ b/_docs/geyser/getting-started-with-the-api.md @@ -31,7 +31,7 @@ Add Geyser's API codebase as a dependency: org.geysermc.geyser api - 2.1.2-SNAPSHOT + 2.2.0-SNAPSHOT provided ``` @@ -39,7 +39,7 @@ Add Geyser's API codebase as a dependency: **Gradle** ```groovy dependencies { - compileOnly('org.geysermc.geyser:api:2.1.2-SNAPSHOT') + compileOnly('org.geysermc.geyser:api:2.2.0-SNAPSHOT') } ``` @@ -83,4 +83,4 @@ FloodgateApi api = FloodgateApi.getInstance(); api.isFloodgatePlayer(uuid); ``` -For more information on the Floodgate API, see [here](/floodgate/api/). \ No newline at end of file +For more information on the Floodgate API, see [here](/floodgate/api/).