History

roberts e883181b5a Initial commit		2025-05-09 15:53:19 -05:00
..
.github	Initial commit	2025-05-09 15:53:19 -05:00
docs	Initial commit	2025-05-09 15:53:19 -05:00
examples	Initial commit	2025-05-09 15:53:19 -05:00
src	Initial commit	2025-05-09 15:53:19 -05:00
test	Initial commit	2025-05-09 15:53:19 -05:00
.gitpod	Initial commit	2025-05-09 15:53:19 -05:00
HISTORY.md	Initial commit	2025-05-09 15:53:19 -05:00
index.d.ts	Initial commit	2025-05-09 15:53:19 -05:00
index.js	Initial commit	2025-05-09 15:53:19 -05:00
LICENSE	Initial commit	2025-05-09 15:53:19 -05:00
package.json	Initial commit	2025-05-09 15:53:19 -05:00
README.md	Initial commit	2025-05-09 15:53:19 -05:00

README.md

prismarine-realms

Minecraft Realm interface for Minecraft Java and Bedrock editions, providing a stable API to start/stop Realms, and obtain Realm information such as connection addresses.

Minecraft Realms is a subscription based service provided by Mojang where users can host, create and manage their own private Minecraft servers.

Installation

npm install prismarine-realms

Usage

RealmAPI

.from(authflow: Authflow, platform: 'bedrock' | 'java')

Takes an Authflow instance from prismarine-auth, you can see the documentation for this here.

Example

const { Authflow } = require('prismarine-auth') 
const { RealmAPI } = require('prismarine-realms')

const authflow = new Authflow()

const api = RealmAPI.from(authflow, 'bedrock') // or 'java'

// Returns a list of Realms the authenticating account has joined or owns.
await api.getRealms().then(console.log)

Documentation

See API Documentation