node-mojang-api 1.0.3 | Documentation

node-mojang-api

1.0.3

Authentication ▸
- Instance members
- #accessToken
- #name
- #id
- #authenticate
- #refresh
- #validate
Client ▸
- Instance members
- #setAccessToken
- #setName
- #setId
- #fileExists
- #readFile
- #writeFile
Mojang ▸
- Static members
- .status
- .getUUID
- .getNameHistory
- .getSkin
NameHistoryInstance
TexturesContainer
SkinContainer
CapeContainer
RealmsWorld
RealmsWorldBackup
RealmsWorldBackupMetadata
RealmsSubscription
Realms ▸
- Instance members
- #getWorlds
- #getIP
- #hasPendingUpdate
- #getBackups
- #getDownload
- #getOPs
- #getSubscription
- #getPendingInvites

Need help reading this?

Authentication

Class representing the authentication of a client with Mojang's authentication server

new Authentication(email: string, password: string, client_path: string)

Parameters

email (string) email of Mojang account

password (string) password of Mojang account

client_path

(string
            = <CURRENT_WORKING_DIRECTORY>)

path to the file that will store the client

Instance Members

▸ accessToken

Access token of client object

accessToken

Returns

string: access token

▸ name

Name of client object

name

Returns

string: client name

▸ id

ID of client object

Returns

string: client id

▸ authenticate(game)

Performs authentication with Mojang server

authenticate(game: string): string

Parameters

game

(string
            = "Minecraft")

Game to authenticate with, either "Minecraft" or "Scrolls"

Returns

string: access token

▸ refresh()

Performs refresh of the access token with Mojang server

refresh(): string

Returns

string: access token

▸ validate()

Performs validate of the access token with Mojang server

validate(): boolean

Returns

boolean:

Client

Class representing the client

new Client(path: string?)

Parameters

path (string?) A path to the JSON file where the client will be stored

Instance Members

▸ setAccessToken

Sets the access token

setAccessToken

Parameters

accessToken (string) Access token

▸ setName

Sets the name

setName

Parameters

name (string) Name

▸ setId

Sets the id

setId

Parameters

id (string) ID

▸ fileExists()

Checks if the path of the client json file exists

fileExists(): boolean

Returns

boolean:

▸ readFile()

Reads the client json file and sets the values stored to the current client

readFile()

▸ writeFile()

Writes the current client to the client json file

writeFile()

Mojang

a module that contains miscellaneous endpoint wrappers for Mojang APIs

Mojang

Static Members

▸ status()

Checks the status of all mojang servers

status(): Array<object>

Returns

Array<object>: an array of servers and statuses in the form { <server_name>: <server_status> }. Server status can be on of the following: green - no issues, yellow - some issues, red - server unavailable

▸ getUUID(username, timestamp)

Gets the UUID of the user of a specified username

getUUID(username: string, timestamp: number): string

Parameters

username (string) The username of the Minecraft account

timestamp

(number
            = <current_time>)

The timestamp at which to check the username

Returns

string: The UUID of the user with the username at the timestamp provided

▸ getNameHistory(uuid)

Gets the history of names used by a user of a specified UUID

getNameHistory(uuid: string): Array<NameHistoryInstance>

Parameters

uuid (string) The unhyphenated UUID of the Minecraft account

Returns

Array<NameHistoryInstance>: An array containing the past names of a user

▸ getSkin(uuid)

Gets the URL to the cape and skin textures of the specified user

getSkin(uuid: string): TexturesContainer

Parameters

uuid (string) The unhypenated UUID of the Minecraft account

Returns

TexturesContainer: The textures associated with the specified account

NameHistoryInstance

a container for Minecraft name history instances

NameHistoryInstance

Type: object

Properties

name (string) : The username of the account

changedToAt (number?) : The (java) timestamp the username was changed to the associated username. This value is absent for the original username

TexturesContainer

a container for Minecraft account textures

TexturesContainer

Type: object

Properties

skin (SkinContainer) : Data about a minecraft skin

cape (CapeContainer) : Data about a minecraft cape

SkinContainer

a container for Minecraft skin data

SkinContainer

Type: object

Properties

url (string) : The url to the skin texture

model (string) : The model type of the skin, can be one of the following: normal, slim

CapeContainer

a container for Minecraft cape data

CapeContainer

Type: object

Properties

url (string) : The url to the cape texture

RealmsWorld

a Minecraft world hosted on Minecraft Realms

RealmsWorld

Type: Object

Properties

id (number) : The ID of the world

owner (string) : The owner of the world

ownerUUID (string) : The unique ID of the owner, note: UUID does not have hyphens

name (string) : The name of the world

motd (string) : The MOTD of the server, does not support color

state (string) : The status of the server, can be one of the following: ADMIN_LOCK, CLOSED, OPEN, UNITIALIZED

daysLeft (number) : How many days are left of subscription. Always '0' if not owner and returns '-1' if expired

expired (boolean) : Whether the subscription has expired

expiredTrial (boolean) : Whether the trial subscription has expired

worldType (string) : Type of the world, can be one of the following: NORMAL, MINIGAME, ADVENTUREMAP, EXPERIENCE, INSPIRATION

minigameName (string) : The name of the minigame that is currently active, null if not in a minigame

minigameId (number) : The unique ID of the minigame, null if not in minigame

minigameImage (string) : base64 of the current minigame image in the format PNG, null if not in minigame

activeSlot (number) : Current server world (1-4)

RealmsWorldBackup

a Minecraft Realms world backup

RealmsWorldBackup

Type: Object

Properties

backupId (string) : The ID of the world backup

lastModifiedDate (number) : The timestamp the backup was created

size (number) : The size of the backup

metadata (RealmsWorldBackupMetadata) : Additional data about the backup

RealmsWorldBackupMetadata

a container for additional Minecraft Realms backup data

RealmsWorldBackupMetadata

Type: Object

Properties

game_difficulty (number) : The difficulty set for the world, 0-3. The difficlties are as follows: 0 - Peaceful, 1 - Easy, 2 - Normal, 3 - Hard

name (string) : The name of the world

gameServerVersion (string) : The version of Minecraft when the backup was created

enabledPacks (string)

description (string)

game_mode (number) : The default gamemode of the world

world_type (string) : The type of world generation used

RealmsSubscription

a container for a Minecraft Realms subscription

RealmsSubscription

Type: Object

Properties

startDate (number) : Timestamp of when the subscription was started

daysLeft (number) : Number of days left before the subscription renews, -1 if the subscription is inactive

subscriptionType (string) : The type of subscription, can be one of the following: NORMAL, RECURRING

Realms

Class representing a client connected to Minecraft Realms

new Realms(auth: Authentication)

Parameters

auth (Authentication) a valid authenticated authentication client

Instance Members

▸ getWorlds()

Sets and returns list of worlds that the authenticated user has access to on Minecraft Realms

getWorlds(): Array<RealmsWorld>

Returns

Array<RealmsWorld>: Array of RealmsWorld objects

▸ getIP(world)

Returns the current IP of the realm

getIP(world: RealmsWorld): string

Parameters

world (RealmsWorld) A Minecraft Realms world object

Returns

string: Server IP

▸ hasPendingUpdate(world)

Returns true if the server has a pending update

hasPendingUpdate(world: RealmsWorld): boolean

Parameters

world (RealmsWorld) A Minecraft Realms world object

Returns

boolean: server has update

▸ getBackups(world)

Returns the list of backups for the world

getBackups(world: RealmsWorld): Array<RealmsWorldBackup>

Parameters

world (RealmsWorld) A Minecraft Realms world object

Returns

Array<RealmsWorldBackup>: An array of Minecraft Realms backups

▸ getDownload(world)

Returns the URL to the latest world backup

getDownload(world: RealmsWorld): string

Parameters

world (RealmsWorld) A Minecraft Realms world object

Returns

string: URL to Minecraft Realms backup

▸ getOPs(world)

Gets a list of operators for a Minecraft Realm

getOPs(world: RealmsWorld): Array<string>

Parameters

world (RealmsWorld) A Minecraft Realms world object

Returns

Array<string>: A list of operators names

▸ getSubscription(world)

Gets information about the Minecraft Realms subscription

getSubscription(world: RealmsWorld): RealmsSubscription

Parameters

world (RealmsWorld) A Minecraft Realms world object

Returns

RealmsSubscription: Information about the Minecraft Realms subscription

▸ getPendingInvites()

Gets the number of pending Minecraft Realms invites the currently authenticated user has

getPendingInvites(): number

Returns

number: number of pending Minecraft Realms invites