Skip to content

lefant/PlayerCoordsAPI

 
 

Repository files navigation

PlayerCoordsAPI

A lightweight Fabric mod that exposes your Minecraft player coordinates via a local HTTP API.

📋 Overview

PlayerCoordsAPI provides real-time access to your Minecraft player coordinates through a simple HTTP endpoint. This enables external applications to track your position without needing to read Minecraft's memory or capture the screen.

✨ Features

  • Lightweight HTTP server running only on localhost providing your coordinates
  • Client-side only - no server-side components needed
  • Works in singleplayer and multiplayer
  • Mod menu integration allowing you to enable/disable the API

🚀 Installation

  1. Install Fabric Loader
  2. Download the latest playercoordsapi-x.x.x+mcx.x.x.jar from the releases page
  3. Place the jar in your .minecraft/mods folder
  4. Launch Minecraft with the Fabric profile

🔌 API Usage

Endpoint Method Description
/api/coords GET Returns the player's current coordinates and world infos

Response Format

{
  "x": 123.45,
  "y": 64.00,
  "z": -789.12,
  "yaw": 180.00,
  "pitch": 12.50,
  "world": "overworld",
  "biome": "plains",
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "username": "PlayerName"
}

Response Fields

Field Type Description
x number East-West
y number Height
z number North-South
yaw number Horizontal rotation (degrees)
pitch number Vertical rotation (degrees)
world string Minecraft world
biome string Minecraft biome
uuid string Player UUID
username string Player username

Error Responses

Status Message
403 Access denied
404 Player not in world

🔒 Security

For security reasons, the API server:

  • Only accepts connections from localhost 127.0.0.1
  • Runs on port 25565 by default
  • Provides read-only access to player position data
  • Allows requests from any origin (CORS Access-Control-Allow-Origin: *) for easy integration with web applications

🛠️ Examples

cURL

curl http://localhost:25565/api/coords

Python

import requests

response = requests.get("http://localhost:25565/api/coords")
data = response.json()
print(f"Player {data['username']} (UUID: {data['uuid']}) at X: {data['x']}, Y: {data['y']}, Z: {data['z']}")

JavaScript

fetch("http://localhost:25565/api/coords")
    .then(response => response.json())
    .then(data => console.log(`Player ${data.username} (UUID: ${data.uuid}) at X: ${data.x}, Y: ${data.y}, Z: ${data.z}`));

Crafted by Sukikui

About

Lightweight Fabric mod exposing locally MC player coords through HTTP API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Java 100.0%