GeyserMC

https://geysermc.org/wiki/
Admin
GeyserMC is a bridge that enables cross-platform play between Minecraft: Bedrock Edition and...
Tokens:73,037
Snippets:778
Trust Score:9.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET Request Example for Front Texture

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-render-controller-get-front-texture

Demonstrates how to fetch a front texture using a provided texture ID via an HTTP GET request. Requires the texture_id as a path parameter. This example uses C# and HttpClient.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.geysermc.org/render/front/:texture_id");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

--------------------------------

### Get Project Information (C# HttpClient)

Source: https://geysermc.org/wiki/api/downloads.geysermc.org/project

Example using C#'s HttpClient to fetch project details. Ensure the 'Accept' header is set to 'application/json'.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://download.geysermc.org/v2/projects/:project");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### C# HttpClient request example

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-link-controller-get-bedrock-link-v-2

Example implementation using C# HttpClient to perform the GET request.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.geysermc.org/v2/link/bedrock/:xuid");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Successful Response Example

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-link-controller-get-java-link-v-2

An example of the JSON array returned when a linked account is found.

```json
[
  {
    "bedrock_id": 2535432196048835,
    "java_id": "d34eb447-6e90-4c78-9281-600df88aef1d",
    "java_name": "Tim203",
    "last_name_update": 0
  }
]
```

--------------------------------

### C# HttpClient Example

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-skin-controller-get-recent-uploads-page

Example of how to make a GET request to the recent uploads API using HttpClient in C#.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.geysermc.org/v2/skin/bedrock/recent/:page");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### C# HttpClient Example

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-stats-controller-get-all-stats-2

Example of how to fetch statistics using HttpClient in C#.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.geysermc.org/v2/stats");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Version Information Response Example

Source: https://geysermc.org/wiki/api/downloads.geysermc.org/version

An example JSON response containing details about a project version, including its ID, name, version string, and build numbers.

```json
{
  "project_id": "geyser",
  "project_name": "Geyser",
  "version": "2.1.0",
  "builds": [
    0
  ]
}
```

--------------------------------

### Comprehensive mappings.json example

Source: https://geysermc.org/wiki/geyser/custom-items

A full example demonstrating the usage of definition, legacy, and group types within a single mappings.json file.

```json
{
    "format_version": 2,
    "items": {
        "minecraft:flint": [
            {
                "type": "definition",
                "model": "geyser_mc:test_item",
                "bedrock_identifier": "geyser_mc:test_item",
                "display_name": "An Example Item!",
                "bedrock_options": {
                    "icon": "potato",
                    "creative_category": "items"
                }
            },
            {
                "type": "legacy",
                "custom_model_data": 42,
                "bedrock_identifier": "geyser_mc:test_legacy_item",
                "display_name": "A Very Old Item!",
                "bedrock_options": {
                    "icon": "cobweb"
                }
            },
            {
                "type": "group",
                "model": "geyser_mc:another_test_item",
                "definitions": [
                    {
                        "bedrock_identifier": "geyser_mc:another_test_item_nether",
                        "predicate": {
                            "type": "match",
                            "property": "context_dimension",
                            "value": "minecraft:the_nether"
                        },
                        "components": {
                            "minecraft:consumable": {
                                "animation": "drink",
                                "consume_seconds": 10
                            }
                        }
                    },
                    {
                        "bedrock_identifier": "geyser_mc:another_test_item",
                        "bedrock_options": {
                            "icon": "carrot"
                        },
                        "components": {
                            "minecraft:consumable": {
                                "animation": "drink",
                                "consume_seconds": 10
                            }
                        }
                    }
                ]
            }
        ]
    }
}
```

--------------------------------

### C# HttpClient Example

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-stats-controller-get-all-stats

Example of how to fetch statistics using HttpClient in C#.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.geysermc.org/v1/stats");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Windows Startup Script for Geyser-Standalone

Source: https://geysermc.org/wiki/geyser/creating-a-startup-script

Use this batch script to start Geyser-Standalone on Windows. Ensure Java 21+ is installed and the script is in the same directory as the Geyser-Standalone jar file.

```batch
@echo off  
java -Xms1024M -jar Geyser-Standalone.jar  
pause  

```

--------------------------------

### C# HttpClient Example

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-health-controller-health

Example using C# HttpClient to send a GET request to the GeyserMC API health endpoint. Ensures the response is successful and prints the content.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.geysermc.org/health");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

--------------------------------

### Project Information JSON Response Example

Source: https://geysermc.org/wiki/api/downloads.geysermc.org/project

An example of the JSON response structure when requesting project information. Includes project ID, name, and a list of versions.

```json
{
  "project_id": "geyser",
  "project_name": "Geyser",
  "versions": [
    "string"
  ]
}
```

--------------------------------

### C# HttpClient Example

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-skin-controller-get-recent-uploads

This C# code snippet demonstrates how to use HttpClient to make a GET request to the GeyserMC API to fetch recent Bedrock skins. Ensure the 'Accept' header is set to 'application/json'.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.geysermc.org/v2/skin/bedrock/recent");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### HttpClient C# Request Example

Source: https://geysermc.org/wiki/api/downloads.geysermc.org/builds

Example implementation using C# HttpClient to fetch build data from the Geyser API.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://download.geysermc.org/v2/projects/:project/versions/:version/builds");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Get Project Information (HTTP)

Source: https://geysermc.org/wiki/api/downloads.geysermc.org/project

Demonstrates how to make an HTTP GET request to retrieve information about a specific project. Replace ':project' with the actual project identifier.

```http
GET
## https://download.geysermc.org/v2/projects/:project
```

--------------------------------

### C# HttpClient Request

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-link-controller-get-java-link-v-2

Example implementation using C# HttpClient to perform the GET request.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.geysermc.org/v2/link/java/:uuid");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### Example JSON Response (Success)

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-skin-controller-get-recent-uploads-page

This is an example of a successful JSON response containing skin data and total page count.

```json
{
  "data": [
    {
      "id": 0,
      "texture_id": "string"
    }
  ],
  "total_pages": 0
}
```

--------------------------------

### Successful response schema example

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-link-controller-get-bedrock-link-v-2

Example JSON response returned when a linked account is found.

```json
{
  "bedrock_id": 2535432196048835,
  "java_id": "d34eb447-6e90-4c78-9281-600df88aef1d",
  "java_name": "Tim203",
  "last_name_update": 0
}
```

--------------------------------

### C# HttpClient Example

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-utils-controller-get-bedrock-or-java-uuid

This C# code snippet demonstrates how to use HttpClient to make a GET request to the GeyserMC API endpoint for retrieving player UUIDs. Ensure you handle the response appropriately.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.geysermc.org/v2/utils/uuid/bedrock_or_java/:username");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### C# HttpClient Request

Source: https://geysermc.org/wiki/api/downloads.geysermc.org/projects

Example of how to fetch the projects list using C# HttpClient.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://download.geysermc.org/v2/projects");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### JSON Response Schema Example

Source: https://geysermc.org/wiki/api/downloads.geysermc.org/builds

An example of the JSON structure returned by the builds endpoint.

```json
{
  "project_id": "geyser",
  "project_name": "Geyser",
  "version": "2.1.0",
  "builds": [
    {
      "build": 30,
      "time": "2024-07-14T21:42:40.604Z",
      "channel": "default",
      "promoted": true,
      "changes": [
        {
          "commit": "string",
          "summary": "string",
          "message": "string"
        }
      ],
      "downloads": {}
    }
  ]
}
```

--------------------------------

### Start Geyser with IPv4 stack preference flag

Source: https://geysermc.org/wiki/geyser/common-issues

Use the -Djava.net.preferIPv4Stack=true flag when starting the Java process to resolve locale asset cache loading failures caused by IPv6 connection attempts.

```bash
java -Xms1024M -Djava.net.preferIPv4Stack=true -jar Geyser.jar
```

--------------------------------

### Automated Geyser Standalone Install Script for Termux

Source: https://geysermc.org/wiki/geyser/setup/self/standalone

A script to automate the download and installation of Geyser Standalone on Termux. This is an alternative to the manual steps.

```bash
curl https://gist.githubusercontent.com/rtm516/e3e07d6595ee41e05a38b03c0f4d7a80/raw/install.sh | bash
```

--------------------------------

### Install and run Geyser on Android via Termux

Source: https://geysermc.org/wiki/geyser/setup

Manual commands to install OpenJDK 21, download the Geyser Standalone jar, and execute it within the Termux environment.

```bash
pkg install openjdk-21
wget https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/standalone
java -jar Geyser-Standalone.jar
```

--------------------------------

### Example extension.yml Configuration

Source: https://geysermc.org/wiki/geyser/extensions

Defines the metadata and dependencies for a Geyser extension. Ensure the `id` is unique and lowercase.

```yaml
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

```

--------------------------------

### C# HttpClient Request

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-skin-controller-get-skin

Example implementation using C# HttpClient to fetch skin data.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.geysermc.org/v2/skin/:xuid");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### GET /v2/projects/:project/versions/:version/builds

Source: https://geysermc.org/wiki/api/downloads.geysermc.org/builds

Retrieves a list of all available builds for a specific project and version.

```APIDOC
## GET https://download.geysermc.org/v2/projects/:project/versions/:version/builds

### Description
Retrieves all available builds for a specific project version.

### Method
GET

### Endpoint
https://download.geysermc.org/v2/projects/:project/versions/:version/builds

### Parameters
#### Path Parameters
- **project** (string) - Required - The project identifier (e.g., geyser).
- **version** (string) - Required - A version of the project (e.g., latest or 2.1.0).

### Response
#### Success Response (200)
- **project_id** (string) - The project identifier.
- **project_name** (string) - The display name of the project.
- **version** (string) - The requested version.
- **builds** (array) - List of available builds.

#### Response Example
{
  "project_id": "geyser",
  "project_name": "Geyser",
  "version": "2.1.0",
  "builds": [
    {
      "build": 30,
      "time": "2024-07-14T21:42:40.604Z",
      "channel": "default",
      "promoted": true,
      "changes": [
        {
          "commit": "string",
          "summary": "string",
          "message": "string"
        }
      ],
      "downloads": {}
    }
  ]
}
```

--------------------------------

### GET /v2/projects/:project/versions/:version/builds/latest

Source: https://geysermc.org/wiki/api/downloads.geysermc.org/build-latest

The endpoint path used to retrieve information related to a specific build.

```http
GET 
## /v2/projects/:project/versions/:version/builds/latest
```

--------------------------------

### Example Main Class with Event Subscription

Source: https://geysermc.org/wiki/geyser/extensions

Demonstrates a main class for a Geyser extension that subscribes to the `GeyserPostInitializeEvent`. Use this event for most of your extension's logic as the GeyserAPI is fully available.

```java
@Subscribe
public void onPostInitialize(GeyserPostInitializeEvent event) {
    // example: show that your extension is loading.
    this.logger().info("Loading example extension...");
}

```

--------------------------------

### Creating a Resource Pack from a File Path

Source: https://geysermc.org/wiki/geyser/api

Demonstrates how to create a resource pack object using a file path. This is useful for loading resource packs from the file system to be sent to players.

```java
ResourcePack pack = ResourcePack.create(PackCodec.path(path));
```

--------------------------------

### Implement a custom entity extension

Source: https://geysermc.org/wiki/geyser/custom-entities

A full example showing how to define a custom entity, register entity properties, and override entity data during the spawn event.

```java
public class MyExtension implements Extension {  
    // Create a custom entity definition  
    private final CustomEntityDefinition enhancedZombie = CustomEntityDefinition.of(Identifier.of("myext:enhanced_zombie"));  
    private GeyserFloatEntityProperty healthFraction = null;  
  
    // Register the custom entity type  
    @Subscribe  
    public void onDefineEntities(GeyserDefineEntitiesEvent event) {  
        event.register(enhancedZombie);  
    }  
  
    // Optionally: Register entity properties (Bedrock identifier)  
    @Subscribe  
    public void onDefineProperties(GeyserDefineEntityPropertiesEvent event) {  
        healthFraction = event.registerFloatProperty(  
            enhancedZombie.identifier(),  
            Identifier.of("myext:health_fraction"),   
            0f, 1f, 1f  
        );  
    }  
  
    // Replace a default Bedrock entity definition with our custom one  
    @Subscribe  
    public void onSpawn(ServerSpawnEntityEvent event) {  
        // Unless you want to replace everything, you should probably add checks for e.g., entity type, or entity UUID  
        event.definition(enhancedZombie);  
        event.preSpawnConsumer(entity -> {  
            entity.override(GeyserEntityDataTypes.SCALE, 1.5f);  
            entity.override(GeyserEntityDataTypes.COLOR, (byte) 4);  
        });  
    }  
}
```

--------------------------------

### Fabric Mod: Register Geyser Event Bus

Source: https://geysermc.org/wiki/geyser/events

Example of implementing ModInitializer and EventRegistrar in a Fabric mod to register the Geyser event bus. Registration is done within the server starting event to ensure Geyser API is loaded.

```java
public class ExampleMod implements ModInitializer, EventRegistrar {  
    public static final Logger LOGGER = LoggerFactory.getLogger("modid");  
      
    @Override   
    public void onInitialize() {  
        ServerLifecycleEvents.SERVER_STARTING.register((server) -> {  
            GeyserApi.api().eventBus().register(this, this); // register your mod & this class instance as a listener  
        });  
          
        LOGGER.info("Geyser is cool!");  
    }  
      
    // here an event, we subscribe as usual with the @Subscribe annotation  
    @Subscribe   
    public void onGeyserPostInitializeEvent(GeyserPostInitializeEvent event) {  
        LOGGER.info("Geyser started!");  
    }  
}
```

--------------------------------

### Example HTTP response headers for resource packs

Source: https://geysermc.org/wiki/geyser/packs

This output demonstrates the expected HTTP headers, specifically Content-Type and Content-Length, required for remote resource pack hosting.

```http
HTTP/1.1 200 OK  
Date: Wed, 03 Jul 2024 23:03:06 GMT  
Content-Type: application/zip  
Content-Length: 95400  
Connection: keep-alive  
access-control-allow-methods: GET  
access-control-allow-origin: *  
Cache-Control: public, s-maxage=1209600  
content-disposition: attachment; filename="=?UTF-8?Q?GeyserOptionalPack.mcpack?="; filename*=UTF-8''GeyserOptionalPack.mcpack  
etag: "0258409cde3a2906e1085490fa5b10b77"  
last-modified: Wed, 03 Jul 2024 08:42:41 GMT  
CF-Cache-Status: HIT  
Age: 21500  
Accept-Ranges: bytes  
Report-To: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v4?s=DUpNVi9R96y13%2BlJm%2BNTpDLvSt9bw9CFDUh8Qwhpb9SsqjJbuInBGtSM5hiM2dGbSGkUccP4KvSqqD%2FCKrrcQ9ur5at5G0u8FrfooVTKLP%2B4MwGoUl29DwlxeMVg6tX36RjjICmV97M4FlErCZEe%2F3gM%2FA%3D%3D"}],"group":"cf-nel","max_age":604800}  
NEL: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}  
Server: cloudflare  
CF-RAY: 89da81ca69c63735-FRA  
alt-svc: h3=":443"; ma=86400
```

--------------------------------

### Statistics Response Schema Example

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-stats-controller-get-all-stats-2

An example of the JSON response structure for the statistics endpoint.

```JSON
{
  "pre_upload_queue": {
    "length": 0
  },
  "upload_queue": {
    "estimated_duration": 0,
    "length": 0
  }
}
```

--------------------------------

### Add item entry to texture_data

Source: https://geysermc.org/wiki/geyser/custom-items

Example entry for an item registered with the Bedrock identifier example:yummy_food inside the texture_data object.

```json
"example:yummy_food": {
    "textures": [
        "textures/items/yummy_food"
    ]
}
```

--------------------------------

### C# HttpClient Example for Raw Texture

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-render-controller-get-raw-texture

Demonstrates how to fetch raw texture data using C# HttpClient. Replace ':texture_id' with the actual Java texture ID.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.geysermc.org/render/raw/:texture_id");  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

--------------------------------

### Install OpenJDK 21 on Termux

Source: https://geysermc.org/wiki/geyser/setup/self/standalone

Installs OpenJDK version 21, which is required to run Geyser Standalone on Android via Termux.

```bash
pkg install openjdk-21
```

--------------------------------

### Example custom block mapping JSON

Source: https://geysermc.org/wiki/geyser/custom-blocks

A sample JSON file structure for registering custom blocks, placed within the custom_mappings folder.

```json
{
	"format_version": 1,  
	"blocks": {  
		"minecraft:granite_wall": {  
			"name": "my_block",  
			"display_name": "Custom Granite Wall",  
			"geometry": "geometry.blocks.my_block_geo",  
			"material_instances": {  
				"*": {  
					"texture": "some_texture",  
					"render_method": "alpha_test",  
					"face_dimming": true,  
					"ambient_occlusion": true  
				}  
			},  
			"tags": ["stone", "wall"],  
			"state_overrides": {  
				"east=none,north=none,south=none,up=true,waterlogged=true,west=none": {  
					"geometry": "geometry.blocks.my_other_block_geo",  
					"destructible_by_mining": 10,  
					"place_air": false  
				},  
				"east=none,north=none,south=none,up=false,waterlogged=true,west=tall": {  
					"friction": 0.6,  
					"light_emission": 7,  
					"light_dampening": 8,  
					"transformation": {  
                        "scale": [0.5, 0.5, 0.5],  
                        "translation": [1, 0, 0],  
                        "rotation": [0, 90, 0]  
                    }  
				},  
				"east=none,north=none,south=low,up=true,waterlogged=true,west=tall": {  
					"placement_filter": {  
						"conditions": [{
							"allowed_faces": ["up", "down"],  
							"block_filter": [{
									"tags": "!query.any_tag('stone')"  
								},  
								"minecraft:dirt"  
							]
						}]
					}
				}
			}
		}
	}
}
```

--------------------------------

### Create a ModalForm

Source: https://geysermc.org/wiki/geyser/forms

Example of creating a basic ModalForm with a title, content, and two buttons. Use this for simple confirmations or choices.

```java
ModalForm.builder()
    .title("Title")
    .content("Content")
    .button1("Button 1")
    .button2("Button 2")
```

--------------------------------

### JSON Bedrock Options for Tools

Source: https://geysermc.org/wiki/geyser/custom-items

Example configuration for a tool or weapon item using bedrock_options in JSON, with display_handheld enabled.

```json
    "bedrock_options": {  
        "icon": "example:my_sword", // must match shorthands defined in item_texture.json  
        "display_handheld": true, // usually only set for weapons or tools  
        "creative_category": "items",  
        "creative_group": "itemGroup.name.sword",  
        "tags": ["example:my_weapon"]  
    }  
```

--------------------------------

### Example JSON Response for Bedrock Player

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-utils-controller-get-bedrock-or-java-uuid

This is an example of a successful JSON response when the username corresponds to a Bedrock player. It includes the player's Floodgate UUID and username.

```json
{
  "id": "0000000000000000000901f64f65c7c3",
  "name": ".Tim203"
}
```

--------------------------------

### Resource Pack Creation

Source: https://geysermc.org/wiki/geyser/api

Demonstrates how to create a custom resource pack using the Geyser API, loading it from a file path.

```APIDOC
## Resource Pack Creation

### Description
This section details how to create and manage resource packs within the Geyser API. You can define custom resource packs and send them to individual sessions or all sessions.

### Creating a Resource Pack from a File Path
Use the `ResourcePack.create` method with a `PathPackCodec` to load a resource pack from a specified file path.

### Code Example

```java
// Assuming 'path' is a Path object representing the resource pack directory
ResourcePack pack = ResourcePack.create(PackCodec.path(path));
```

### Related Events
- `SessionLoadResourcePacksEvent`: For sending resource packs to individual sessions before they log in.
- `GeyserDefineResourcePacksEvent`: For sending resource packs to all sessions.
```

--------------------------------

### Get Gamertag from XUID

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-xbox-controller-get-gamertag-v-2

This snippet shows how to make a GET request to the GeyserMC API to retrieve a gamertag associated with a given XUID. Ensure the XUID is a valid integer.

```http
GET
## https://api.geysermc.org/v2/xbox/gamertag/:xuid
```

```json
{
  "gamertag": "Tim203"
}
```

```json
{
  "message": "string"
}
```

```json
{
  "message": "string"
}
```

--------------------------------

### Response schema example

Source: https://geysermc.org/wiki/api/downloads.geysermc.org/download-latest

The empty object schema returned by the API.

```json
{}
```

--------------------------------

### C# HttpClient Example

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-xbox-controller-get-gamertag-v-2

Demonstrates how to use C#'s HttpClient to call the GeyserMC API for retrieving a gamertag. The response is read as a string. Ensure the 'Accept' header is set to 'application/json'.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.geysermc.org/v2/xbox/gamertag/:xuid");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

--------------------------------

### GET /v2/projects Request

Source: https://geysermc.org/wiki/api/downloads.geysermc.org/projects

The endpoint to retrieve a list of all available projects.

```http
GET 
## https://download.geysermc.org/v2/projects
```

--------------------------------

### Define waypoint_mappings.json

Source: https://geysermc.org/wiki/geyser/custom-waypoints

Example configuration file for custom waypoint styles, specifying format version, identifiers, distances, and sprite paths.

```json
{
  "format_version": 1,
  "waypoint_styles": {
    "geyser:my_first_waypoint": {
      "near_distance": 10,
      "far_distance": 100,
      "sprites": [
        "geyser:custom_waypoint_0",
        "geyser:custom_waypoint_1"
      ]
    },
    "geyser:my_second_waypoint": {
      "sprites": [
        "geyser:second_waypoint/texture_1",
        "geyser:second_waypoint/texture_2",
        "geyser:second_waypoint/texture_3",
        "geyser:second_waypoint/texture_4"
      ]
    },
    "geyser:the_best_waypoint": {
      "near_distance": 50,
      "sprites": [
        "geyser:ultimate_waypoint/near",
        "geyser:ultimate_waypoint/far"
      ]
    }
  }
}
```

--------------------------------

### GET /v2/projects

Source: https://geysermc.org/wiki/api/downloads.geysermc.org/projects

Retrieves a list of all available projects from the GeyserMC download service.

```APIDOC
## GET https://download.geysermc.org/v2/projects

### Description
Gets a list of all available projects.

### Method
GET

### Endpoint
https://download.geysermc.org/v2/projects

### Response
#### Success Response (200)
- **projects** (array of strings) - A list of project names.

#### Response Example
{
  "projects": [
    "string"
  ]
}
```

--------------------------------

### Linux Startup Script for Geyser-Standalone

Source: https://geysermc.org/wiki/geyser/creating-a-startup-script

This shell script is for starting Geyser-Standalone on Linux. It navigates to the script's directory before running the Geyser jar. Ensure the script has execute permissions using 'chmod +x'.

```sh
#!/bin/sh   
cd "$( dirname "$0" )"   
java -Xms1024M -jar Geyser-Standalone.jar  

```

--------------------------------

### Workaround for Firewall Issues (OVH/SoYouStart)

Source: https://geysermc.org/wiki/geyser/fixing-unable-to-connect-to-world

This workaround attempts to connect to the Bedrock IP and port through a web browser, then immediately tries connecting through Bedrock. It can resolve firewall issues on specific hosts like OVH/SoYouStart.

```bash
http://test.geysermc.org:19132
```

--------------------------------

### Create a CustomForm with Various Components

Source: https://geysermc.org/wiki/geyser/forms

Example of creating a CustomForm, which offers the highest level of customization. This snippet demonstrates using dropdowns, input fields, toggles, and sliders.

```java
CustomForm.builder()
    .title("Title")
    .dropdown("Text", "Option 1", "Option 2")
    .input("Input", "placeholder")
    .toggle("Toggle")
    .slider("Text", 0, 10, 1, 5)
```

--------------------------------

### GET https://api.geysermc.org/v2/skin/:xuid

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-skin-controller-get-skin

Retrieves the most recently converted skin of a Bedrock player.

```APIDOC
## GET https://api.geysermc.org/v2/skin/:xuid

### Description
Get the most recently converted skin of a Bedrock player.

### Method
GET

### Endpoint
https://api.geysermc.org/v2/skin/:xuid

### Parameters
#### Path Parameters
- **xuid** (string) - Required - Bedrock xuid

### Response
#### Success Response (200)
- **hash** (string) - The hash of the skin bytes
- **is_steve** (boolean) - If the skin is a Steve or an Alex
- **signature** (string) - The signature of the skin data used by Minecraft
- **texture_id** (string) - The texture id used by Minecraft
- **value** (string) - The value of the skin data used by Minecraft

#### Response Example
{
  "hash": "string",
  "is_steve": true,
  "signature": "string",
  "texture_id": "string",
  "value": "string"
}

#### Error Response (400)
- **message** (string) - The error message

#### Response Example
{
  "message": "string"
}
```

--------------------------------

### GET /v2/xbox/xuid/:gamertag

Source: https://geysermc.org/wiki/api/api.geysermc.org/global-api-web-api-xbox-controller-get-xuid-v-2

Retrieves the XUID associated with a specific Bedrock player gamertag.

```APIDOC
## GET /v2/xbox/xuid/:gamertag

### Description
Retrieves the XUID associated with the provided Bedrock player gamertag.

### Method
GET

### Endpoint
/v2/xbox/xuid/:gamertag

### Parameters
#### Path Parameters
- **gamertag** (string) - Required - The gamertag of the Bedrock player

### Response
#### Success Response (200)
- **xuid** (int64) - The XUID associated with the gamertag

#### Response Example
{
  "xuid": 2535432196048835
}

#### Error Response (400)
- **message** (string) - The error message for invalid gamertag input

#### Error Response (503)
- **message** (string) - The error message when the account is not cached or the Xbox Live API is unavailable
```
Tokens:
Raw