prismarine-realms
v1.3.2
Published
Library to manage and interact with Minecraft Realms for Java/Bedrock edition
Downloads
25,758
Readme
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)