* Begin testing i18n Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Add crowdin in-context demo for non-mdx Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Add crowdin-sync system Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Working sync system for translations Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Only build en locale for PRs Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Modify yarn install Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Do not immute cache Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Try with standard yarn install Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Revert to yarn --immutable Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Remove explicit url/file-loader resolutions Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Only log webpack errors Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Added MCServerHost to hosting providers (#47) * Added MCServerHost to hosting providers * Update providers.ts * Correct grammar and make instructions more concise --------- Co-authored-by: Kas-tle <26531652+Kas-tle@users.noreply.github.com> * Update supported Bedrock versions * Remove and Replace "TydiumCraft Skin API" (#53) * Update community-geyser-projects.md I no longer will run TydiumCraft Skin API. I have no interest in continuing it at this time (or anything minecraft related). However I have switched out the spot with an API that 100% is always updated and active. Hosted by my good friend Bret06. This works so much better as well. Thanks for everything over the years guys! Tydium out! * Update wiki/other/community-geyser-projects.md 👍 Co-authored-by: chris <github@onechris.mozmail.com> --------- Co-authored-by: chris <github@onechris.mozmail.com> * Update wording for creepernation api Update wording because it’s bothering me * Update GeyserExtras description (#52) * Update community-geyser-projects.md * Update wiki/other/community-geyser-projects.md Co-authored-by: chris <github@onechris.mozmail.com> --------- Co-authored-by: Luke <32024335+lukeeey@users.noreply.github.com> Co-authored-by: chris <github@onechris.mozmail.com> * Try matrix build strategy Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Fix matrix output Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Matrix goes to GITHUB_OUTPUT Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Fix deploy needs to combine Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Ensure correct commit is used if crowdin updates Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Make sure excluded content is respected Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Allow permission for commit action write Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Sync translations with Crowdin * Update index.md to make clear that this is for servers, not purely for clients (#57) * Update providers.ts (#58) * Update providers.ts VemoxHost added * Maintain alphabetized list --------- Co-authored-by: Kas-tle <26531652+Kas-tle@users.noreply.github.com> * Start on re-writing the providers page to provide more useful details to improve the setup guide * more work on this * Rework paper page for setup * Don't try and build paper setup as a full page * adjust not listed message * update mod/proxy pages * Initial setup i18n Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Add ability to hide proxy setup instructions by provider Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Temporary auto deployment; fix broken links Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Fix heading consistency Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Update language on provider instructions * Update language on new provider instructions * Upgrade actions/setup-node due to hang issue * Both * Forgot how many times we setup node... * Documentation for changes in API/2.6.2 (#62) * Document latest Geyser changes: - remote resource packs * Update/Finish pack docs * small typo fixes * Update page content * fix build * Update supported Bedrock version * Add Modrinth Servers to providers (#63) * Update supported versions & api version * Update versions.json to include 1.21.72 (#64) * Update bedrock version (#67) * Add 'we are not mojang' disclaimer to footer * Stop translations from overriding footer message Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Fix Standalone dump view (#68) * Add OrionNodes to providers (#69) * Update supported Bedrock versions in versions.json (1.21.81, 1.21.82) (#70) * Update faq.mdx to include recommended API (#73) Tydium skin API is abandoned, please direct users to a working API such as the one recommended by Tydium Derived from: https://github.com/GeyserMC/GeyserWebsite/commit/19ae50f95ddbfc24ff34a42d278bdc263e0200e6 * Update anticheat-compatibility.md (#74) * Update versions.json * Update versions.json (#75) * Remove LAC because it is no longer being maintained (#76) * Update versions.json for 1.21.7 (#77) * Update versions.json for 1.21.93 (#78) * Update versions.json for 1.21.94 (#79) * Update versions.json for Java 1.21.8 (#80) * Update Geyser Api version (#81) * Readd Hydraulic and add Rainbow, provide Item API V2 warning for Hydraulic (#82) * Fix incorrect Ubuntu on Oracle Cloud instructions (#84) * Remove Geyser Android App and Tempest (#83) * Update version.json for 1.21.100 (#88) * Update getting-started-with-the-api.md (#89) * Add and update wiki pages, add Thunder download. (#90) * Add a Thunder and Rainbow wiki page, touch up some other pages * Fix mobile sidebar * Address review 1/2 * Address review 1.5/2 (oops) * Address review 2/2 Co-authored-by: chris <github@onechris.mozmail.com> --------- Co-authored-by: chris <github@onechris.mozmail.com> * Indicate 1.21.101 on the Geyser Website (#93) * Added GeyserFloatingPoints to FAQ (#92) * Added GeyserFloatingPoints. * Update wiki/geyser/faq.mdx Co-authored-by: chris <github@onechris.mozmail.com> --------- Co-authored-by: chris <github@onechris.mozmail.com> * Update versions.json to indicate support for bedrock 1.21.111 * Update versions.json for Java 1.21.9/1.21.10 (#97) * Update versions.json for Java 1.21.9 * Update versions.json to include 1.21.10 * Update supported Bedrock version --------- Co-authored-by: Aurorawr <auroranova8756@gmail.com> Co-authored-by: chris <github@onechris.mozmail.com> * Update extensions file for new dependency system (#98) * Update extensions file for new dependency system * Update version * Update wiki/geyser/extensions.md --------- Co-authored-by: chris <github@onechris.mozmail.com> * Replace the Crowdin link with the current one (#101) * Replace the Crowdin link with the current one * Replace the link with the subdomain redirect * Update versions.json to include 1.21.114 (#102) * Update rainbow.md to indicate 1.21.9/.10 (#103) * Revise port forwarding instructions for Ubuntu Updated instructions for allowing Minecraft and Geyser through the OS firewall on Ubuntu. * Update providers and deploy action Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Sync translations with Crowdin * Correct providers syntax Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Use more templates wherever possible * Add build cache; update docusaurus-og Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Test deploy time with cache hit Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Use read-only cache for matrix build Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Unlikely we will use gh actions on arm... Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * This time cache will hit Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Hopefully correct yarn cache path... Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Maybe npm? Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Surely... Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * This time... Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Include yarn/docusaurus cache for PRs Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Add page IDs to more pages, fix broken pages * Update i18n pages * Sync translations with Crowdin * Add missing support pages and articles on providers, add Discord links * Add blog post on preparing Geyser servers for NetherNet Drafted with the help of Claude Opus 5.5. * Rewrite the hosted setup guide for NetherNet, add hosting page Provider entries now describe ports, signaling and install steps, grouped in the order the setup guide shows them. The guide generates the NetherNet config from them, and the old supported hosting providers list is replaced by a hosting page for Open Collaboration supporters. Drafted with the help of Claude Opus 5.5. * Rewrite the self-hosted setup guides for NetherNet The self-hosting pages now use the same steps and generated config as the hosted guide, and point out that the Geyser port needs both TCP and UDP. Drafted with the help of Claude Opus 5.5. * Add HTTPS for NetherNet page Covers serving built-in signaling over HTTPS, with a certificate in the Geyser config or with a reverse proxy (Caddy, nginx). Drafted with the help of Claude Opus 5.5. * Skip Crowdin sync in deploy workflow when no token is set Forks do not have the Crowdin secrets, so the sync step failed there and nothing got deployed. Without a token, the workflow now builds and deploys the pushed commit as is. Drafted with the help of Claude Opus 5.5. * Address: rtm's comments * Improve layout, drop confusing 26.40 note on setup guide * Cleanup blog post language / line breaks * Merge proxy server guides for server hosts, adjust exarotron provider entry, adjust setup guides to work with crowdin * Split the proxy setup guides back into Velocity and BungeeCord Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Update hosting providers to upstream and collapse strings into defaults Port upstream's provider changes to the new format: add Minehost and ConsulHosting, update MCServerHost, rename Feather to Dawn and Modrinth Servers to Modrinth Hosting, merge RamShard into RackGenius, add MyArena, and drop hosts upstream removed. Restore link fixes the rewrite undid and install details dropped from the live page. Replace host-specific strings with templates or the generated steps where they say the same thing. Hosts that pick the port themselves show where it comes from instead of the config step. Hosts without NetherNet details that shared the Java server's port now ask for a new port, open for both TCP and UDP, and the generated config turns clone-remote-port off. Hosts that cannot give out a port fall back to the "Not listed" guide for the Java server's port, which uses Warden. BisectHosting no longer uses assumed example data. Entries keep the date of their last edit. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Remove Dawn and date Aternos and exaroton today Dawn now integrates with Aternos, so it no longer needs its own entry. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Remove unused translation strings and fix the English GeyserConnect text Drop keys the code no longer uses from every locale: the old EmoteOffhand description ID, the theme's old unlisted content strings, strings removed on this branch, and the removed Custom Resource Packs sidebar category. The English GeyserConnect description had an outdated message that overrode the current one on the English site. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Hide the NetherNet and RakNet option when only the Java port is available With only the Java server's port there is no second UDP port for RakNet, so the "Not listed" Java port guide shows the NetherNet config without transport tabs. Drop the placeholder text that only applied there. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Add an HTTPS step to the self-hosted guides and correct external signaling HTTPS claims Self-hosted guides end with a recommended step to serve signaling over HTTPS, since Geyser's built-in signaling uses plain HTTP by default and players get a "Trust on First Use?" prompt. External signaling services do not all provide HTTPS, so the blog post and HTTPS page now name Warden as one that does instead of implying all do. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Update port forwarding guide, update OVH note * Sync translations with Crowdin * Hide entire placeholder strings and correcntly mark chrome json in crowdin Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Update actions and yarn Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Sync translations with Crowdin * Apply batched suggestions from code review Co-authored-by: Eclipse <eclipse@eclipseisoffline.xyz> * Fix NetherNet docs for the final Geyser PR - Built-in signaling serves HTTPS instead of HTTP once a certificate is configured (blog, system properties) - "Free port" is now "available port" in the blog - System properties: drop the removed "none" signaling mode, fix the signaling port default - playit.gg: note that the guide is for RakNet, and link playit.gg's NetherNet progress Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Build the setup guides from translation strings The per-platform setup pages are replaced by SetupGuide.tsx, which renders the hosted and self-hosted guides from shared MDXTranslatable strings, so Crowdin translates each sentence once instead of every page separately. Also: - "Not listed" with only the Java port sets mode: nxs instead of relying on Geyser's fallback - The playit.gg note links playit.gg's NetherNet progress instead of describing a setup - "free port" is now "available port" Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Remove the trustedProxies.fetch system property for now Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * Fix crowdin sync and don't translate trade names Signed-off-by: GitHub <noreply@github.com> * Sync translations with Crowdin * Fix build Signed-off-by: GitHub <noreply@github.com> * Sync translations with Crowdin * Address more concerns with nethernet https guide Signed-off-by: GitHub <noreply@github.com> * Fix signaling-trusted-proxies config in nethernet https article Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> * Remove port forwarding from the HTTPS guide Ports are already covered by the setup guide, and HTTPS does not change which ports need to be opened. Reverse proxies now use signaling-trusted-proxies, which reads X-Forwarded-For. * Remove placeholder hosts, hide the hosting page until it launches - Remove the placeholder hosts and their logos - Aternos and exaroton are bronze supporters: highlighted with a badge in the setup guide, without a "last updated" date, but not listed on the hosting page, which only shows gold and silver - Hide the hosting page and its links for now, and mention in the blog post that it is coming soon * Supporting hosts configure Geyser, they do not install it * Sync translations with Crowdin * Move nethernet https guide up on sidebar * Update to docusaurus 3.10 and fix all type errors Signed-off-by: GitHub <noreply@github.com> * HTTP and HTTPS do not both run at once * Link win-acme's and nginx's own Windows guides in the HTTPS guide * Fix crowdin key exclusion logic Signed-off-by: GitHub <noreply@github.com> * Sync translations with Crowdin * Address reviews, clear up instructions for users. Adds info on haproxy, NXS and MOTD forwarding * Note certificate permissions and where to save the Caddyfile * Sync translations with Crowdin * Document the geyser nethernet command * Sync translations with Crowdin * Support directly linking to the "not listed" or a specific hosts' guide * Mention warden supporting custom domains * Add HOSTING_PROVIDERS.md, update existing server host setup entries to reduce translation strings used * Sync translations with Crowdin --------- Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com> Signed-off-by: GitHub <noreply@github.com> Co-authored-by: Yara Durand <87721861+Roolps@users.noreply.github.com> Co-authored-by: chris <github@onechris.mozmail.com> Co-authored-by: Tydium <67938521+Tydium@users.noreply.github.com> Co-authored-by: Creeperz653 <76449952+Creeperz653@users.noreply.github.com> Co-authored-by: LetsGoAway <68365423+letsgoawaydev@users.noreply.github.com> Co-authored-by: Luke <32024335+lukeeey@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Dan <20766261+D4n2021@users.noreply.github.com> Co-authored-by: santevemox <57247088+santevemox@users.noreply.github.com> Co-authored-by: rtm516 <ryantmilner@hotmail.co.uk> Co-authored-by: Emma Alexia <wafflecoffee7@gmail.com> Co-authored-by: Alex <zomka@fard.ing> Co-authored-by: Aurorawr <100384210+Novampr@users.noreply.github.com> Co-authored-by: Jens Collaert <63231928+Jens-Co@users.noreply.github.com> Co-authored-by: OrionNodes <ethan@orionnodes.com> Co-authored-by: SylentHuntress <91935048+sylenthuntress@users.noreply.github.com> Co-authored-by: oryxel <gamingnoob681@gmail.com> Co-authored-by: Eclipse <eclipse@eclipseisoffline.xyz> Co-authored-by: Nebojsa Majic <79749977+Onako2@users.noreply.github.com> Co-authored-by: qscbm187531 <1309635304@qq.com> Co-authored-by: Eveline Carter <6444703+drakon64@users.noreply.github.com> Co-authored-by: SleepyPop <81194303+SleepyPopp@users.noreply.github.com> Co-authored-by: Aurorawr <auroranova8756@gmail.com> Co-authored-by: rtm516 <rtm516@users.noreply.github.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
8.8 KiB
title, description, crowdin_page_id
| title | description | crowdin_page_id |
|---|---|---|
| Geyser Extensions | Geyser Extensions are the equivalent of "plugins", but specifically for the Geyser platform. This brings the advantage of them being platform-agnostic, meaning that you won't have to worry about supporting all platforms individually. | 72a25d96-4c07-49d4-a661-56d65f68188d |
Geyser Extensions
Geyser Extensions are the equivalent of "plugins", but specifically for the Geyser platform. This brings the advantage of them being platform-agnostic, meaning that you won't have to worry about supporting all platforms individually. Additionally, they will be, by design, only applied for Bedrock players joining via Geyser.
What can Geyser Extensions do?
Extensions can fully utilize the Geyser API to add additional functionality to Geyser. See Geyser API docs for info on what is currently possible.
To name a few examples:
- Register custom items and blocks
- Hide commands from being suggested
- Change the MOTD
- Register your own commands
- Listen to events, e.g. the emote event.
The underlying Geyser API is steadily expanding, creating more and more opportunities.
Which Geyser Extensions exist?
Check out Modrinth's Geyser extensions section under the "plugins" tab!
Installing Extensions
To install an extension, simply put the extension .jar file into Geyser's extensions folder.
Then, restart Geyser (or the server Geyser runs on).
Updating Extensions
To update extensions, use the update folder within the extensions directory as follows:
- Copy the updated versions of your extension jars into the
updatefolder inside theextensionsdirectory. - On the next server or application restart, any extensions in the
updatefolder will automatically replace the corresponding extensions in the main extensions directory. If an extension is new, it will be added. - If an update fails, it will be logged, and the server/application will proceed with loading extensions as usual. You can review the logs to address any issues.
Creating Geyser Extensions
The easiest way to create an extension would be utilizing this official template.
Simply create a new repository from the template, customize the extension.yml & settings.gradle files, and get started making the extension.
Geyser recognizes extensions when they have a file called extension.yml in the jars resources folder.
id: exampleid
name: ExampleExtension
main: org.geyser.extension.exampleid.ExampleExtension
api: 2.9.0
version: 1.0.0
authors: [ExampleAuthor]
dependencies: # Optional
exampledependency:
# When this dependency should be loaded (BEFORE or AFTER your extension)
load: BEFORE # Default: BEFORE
# This determines whether or not this dependency is required for this extension to load
required: true # Default: true
Explanations for the individual fields:
- id: The id of the extension. Every extension needs to have their unique id - all lowercase letters. If you e.g. register a command for your extension, it will have the id as a prefix: e.g.
/exampleid command. - name: The name of the extension.
- main: The main class of your extension.
- api: The Geyser API version your extension targets.
- authors: The author(s) of the extension. To add more than one entry, separate entries with a comma.
- dependencies: The dependencies of the extension. Each dependency has a load order and required property with defaults of
BEFOREandtruerespectively.
Creating the main class
The main class, the entrypoint for the extension, needs to implement the Extension interface provided by Geyser.
That way, Geyser recognizes the extension, and gives you access to important methods - such as logger(), to get your extensions logger.
To see all the methods provided by that interface, see here.
Unlike plugins, extensions do not have a onEnable or onDisable method. Instead, most actions are done in events at different stages during Geyser's lifecycle using events.
Some important ones are:
GeyserPreInitializeEvent: This event is fired when Geyser starts to initialize. If you e.g. need to register extension commands that are configured in your config, you would need to load the config here to ensure that your config is ready before theGeyserDefineCommandsEventis fired.GeyserPostInitializeEvent: It is called when Geyser has completed initializing. The bulk of your code should go here, as the GeyserAPI is fully available at this stage.GeyserShutdownEvent: Called when Geyser is shutting down. You can use this to e.g. save data, or clean up resources.
See below for an example:
@Subscribe
public void onPostInitialize(GeyserPostInitializeEvent event) {
// example: show that your extension is loading.
this.logger().info("Loading example extension...");
}
If you wish to register custom items, global resource packs (or soon, custom blocks and entities), you will need to subscribe to the event using the @Subscribe annotation, and register them in the event. You can find an example for custom items here. For other events, see here for documentation.
To build your extension, run the Gradle build task, and install the extension.
Creating commands with Geyser Extensions
To create a command, you would need to use the Commands package in the Geyser API. Brief rundown:
- Command.java This interface represents a command in Geyser - to make one, you can use the CommandBuilder. You can register it with the GeyserDefineCommandsEvent
- CommandExecutor.java This interface represents a command execute handler in Geyser, and extends the CommandSource interface.
- CommandSource.java This interface represents a command source in Geyser. It can be used to e.g. send messages to the source, check if the source has permission to execute a command, or get the locale.
Command command = Command.builder(this) // "this" is the extension's main class
.name("ExampleCommand")
.bedrockOnly(true)
.source(CommandSource.class)
.aliases(List.of("example", "ex"))
.description("An example command")
.isPlayerOnly(false)
.suggestedOpOnly(false)
.permission("example.command")
.executor((source, cmd, args) -> {
// this is the command executor - this is where you would put your code to execute the command.
// source is the source that executed the command
// cmd is the command that was executed
// args are the arguments passed to the command
source.sendMessage("Hello World");
})
.build();
To register the command, you would need to subscribe to the GeyserDefineCommandsEvent, and register the command there:
@Subscribe
public void onDefineCommands(GeyserDefineCommandsEvent event) {
event.register(command);
}
If everything went right, you should be able to execute the command in-game by running /extesionid [command] - in our case, /exampleid examplecommand.
Here, it would send "Hello World" to the source that ran the command.
Since we also set aliases, you could also run /exampleid example or /exampleid ex for the same command.
To provide args, simple run /exampleid examplecommand [args] - replacing [args] with the arguments you want to pass to the command.
Listening to Events
See here for documentation. You do not need to register the event listener, Geyser will do that for you.
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.