minecraft-pe
v1.0.0
Published
A package using minecraftpocket-servers.com API that allow users to easily manage their minecraft bedrock servers.
Downloads
13
Maintainers
Readme
minecraft-pe
A package using minecraftpocket-servers.com API that allow users to easily manage their minecraft bedrock servers.
Usage
Initialization
This structure is necessary in order for the package to work.
const Minecraft = require('minecraft-pe');
const server = new Minecraft("YOUR_SERVER_API_KEY");
You can get your
SERVER_API_KEY
here by clicking in the gear button (You must have registered a minecraft server before btw) And It'll be like this )
Get Informations from your Minecraft Server
Code
server.getInformations().then(data => {
console.log(data);
const id = data.id;
const name = data.name;
const address = data.address;
const port = data.port;
const hostname = data.hostname;
const players = data.players;
const version = data.version;
const url = data.url;
});
⚠ You can't set data from getInformations() function as a super global variable at the moment (Sorry). ⚠
Expected Output (example)
{
id: '111746',
name: 'Exodus',
address: 'play.exodus.ovh.mine.fun',
port: '25565',
private: '1',
password: '0',
location: 'France',
hostname: 'Exodus UHC',
is_online: '1',
players: '3',
maxplayers: '100',
version: '1.17.0',
platform: null,
uptime: '100',
score: '2',
rank: '1004',
votes: '0',
favorited: '0',
comments: '0',
url: 'https://minecraftpocket-servers.com/server/111746/',
last_check: 'July 11th, 2021 04:01 PM EST',
last_online: 'July 11th, 2021 04:01 PM EST'
}
All of above (Full Example)
const Minecraft = require('minecraft-pe');
const server = new Minecraft("YOUR_SERVER_API_KEY");
server.getInformations().then(data => console.log(data));
Install
npm install minecraft-pe
Changelog
1.0.0
Credits
Don't forget to Star this open-source repo !
License
Apache-2.0