Skip to content

earthsworth/lunar-api

Repository files navigation

🌙 Lunar API

A 3rd-party LunarClient backend implementation inspired by Solar-Sockets

Project Status Java WebSocket

✨ Features

Feature Status
✅ Authenticator Implemented
✅ Cosmetics Implemented
✅ Emotes Implemented
✅ Jams Implemented
✅ Conversation & Friends Implemented
✅ Styngr API Implemented
✅ Game Metadata Implemented
❌ Launcher Metadata Pending

Structure

The backend is available at src

Frontend at dashboard

Develop on the servlet

Please see develop.md

Connect to the server

Enable LunarClient debug mode and add these JVM params to your client

-DserviceOverrideAuthenticator=ws://127.0.0.1:8080/ws
-DserviceOverrideAssetServer=ws://127.0.0.1:8080/ws
-DserviceOverrideApi=http://127.0.0.1:8080/api/lunar
-DserviceOverrideStyngr=http://127.0.0.1:8080/api/styngr

Use the Javaagent to enable Lunar debug mode if you don't want to manually modify the file (DO NOT USE THE 1.1.0 VERSION)

OpenAPI

The OpenAPI is available at https://<your-backend>/api-docs (use http protocol if you're on the local one)

You can import it via Swagger Editor

Resources

Guideline

CONTRIBUTING.md