Skip to content
This repository has been archived by the owner on Dec 23, 2024. It is now read-only.

Commit

Permalink
Updated README, fixed the artifact
Browse files Browse the repository at this point in the history
  • Loading branch information
Atmerek committed Jun 30, 2024
1 parent 0c9c060 commit 308511f
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 1 deletion.
1 change: 1 addition & 0 deletions MinecraftPlugins/CrossplayPackage/.gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
### IntelliJ IDEA ###
out/
.idea/*
!.idea/artifacts/
!.idea/artifacts/CrossplayPackage_jar.xml

### Eclipse ###
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,46 @@ The Roblox side provides an example framework to help you start creating your ow
- **ModifyMode.rbxm**
Contains a GUI button for the BreakBlockScript.lua.

## Support
# Our API

We provide an API to resolve Minecraft player's usernames and skins by their UUIDs. The API supports both Java UUID and Bedrock UUIDs (floodgate).

## Get Username by UUID

**Endpoint**: `/api/uuid/:uuid`

- **Method**: GET
- **Description**: Retrieves the username associated with the provided UUID.
- **Parameters**:
- `uuid` (string): The UUID of the Minecraft player. Supports both Java and Bedrock UUIDs.

**Example Request**:
```sh
curl https://crossplayproject.xyz/api/uuid/92270a4f-f954-4087-a932-e8d0e5deb2bd
```

**Example Response**:
```json
{
"username":"TheAtmerek"
}
```

## Get Skin by UUID

**Endpoint**: `/api/uuid/:uuid/skin`

- **Method**: GET
- **Description**: Retrieves the skin associated with the provided UUID.
- **Parameters**:
- `uuid` (string): The UUID of the Minecraft player. Supports both Java and Bedrock UUIDs.

**Example Request**:
```sh
curl https://crossplayproject.xyz/api/uuid/92270a4f-f954-4087-a932-e8d0e5deb2bd/skin
```

**Response**: Returns the skin image in PNG format.
# Support

For support, reach us at [our Discord](https://dc.crossplayproject.xyz).

0 comments on commit 308511f

Please sign in to comment.