spnda / dart_minecraft Goto Github PK

View Code? Open in Web Editor NEW

20.0 3.0 6.0 283 KB

A Dart library for Minecraft and Mojang Web-APIs, authentication, and NBT Files.

Home Page: https://pub.dev/packages/dart_minecraft

License: MIT License

Dart 100.00%

minecraft library dart mojang mojang-api mojang-authentication minecraft-api nbt-parser nbt-api nbt-library

dart_minecraft's Introduction

dart_minecraft

A simple Dart library for interfacing with the Mojang and Minecraft APIs. It also includes NBT read/write functionality and functions to ping Minecraft: Java Edition servers.

You can simply import the library like this:

import 'package:dart_minecraft/dart_minecraft.dart';

Examples

Below are some basic examples of the features included in this library. A better and more extensive example can be found here. However you should always keep in mind that there is a rate limit on all API, set at 600 requests per 10 minutes. You are expected to cache the results and this is not done by the library itself.

Authenticating with Mojang API

dart_minecraft offers functionality to authenticate with the Mojang API called Yggdrasil.

void main() async {
    // This authenticates, invalidates older tokens, and gets a new access
    // and client token. Be sure to store them, but keep them safe.
    MojangAccount account = authenticate("username", "password");
}

Skin/Cape of a player

Get the skin and/or cape texture URL of a player. This just requires the player's UUID or username.

void main() async {
    // PlayerUUID is a Pair<String, String>
    PlayerUuid player = await getUuid('<your username>');
    Profile profile = await getProfile(player.second);
    String url = profile.textures.getSkinUrl();
}

Reading NBT data

Read NBT data from a local file. This supports the full NBT specification, however support for SNBT is not implemented yet. A full list of tags/types usable in this context can be found here.

void main() async {
    // You can create a NbtFile object from a File object or
    // from a String path.
    final nbtReader = NbtReader.fromFile('yourfile.nbt');
    await nbtReader.read();
    NbtCompound rootNode = nbtReader.root;
    // You can now read information from your [rootNode].
    // for example, rootNode[0] will return the first child,
    // if present.
    print(rootNode.first);
    print(rootNode.getChildrenByTag(NbtTagType.TAG_STRING));
}

Pinging a server

Pings the Minecraft: Java Edition (1.6+) server at 'mc.hypixel.net'. You can use any DNS or IP Address to ping them. The server will provide basic information, as the player count, ping and MOTD.

void main() async {
	/// Pinging a server and getting its basic information is 
	/// as easy as that.
	final server = await ping('mc.hypixel.net');
	if (server == null || server.response == null) return;
	print('Latency: ${server.ping}');
	final players = ping.response!.players;
	print('${players.online} / ${players.max}'); // e.g. 5 / 20
}

License

The MIT License, see LICENSE.

dart_minecraft's People

Contributors

Stargazers

Watchers

Forkers

thekingdave huynguyen1590 mario359 thinesjs exoad kocherovets

dart_minecraft's Issues

Can't read player.dat file on web

I'm trying to read a Minecraft playerdata file using Flutter Web, and I'm running into a couple issues:

Apparently the file I was trying to read was compressed as gzip. Digging into the code, I saw this comment:
"On JS platforms, this does nothing, as it requires converters from 'dart:io'."
Not a huge problem for me though, as I can detect the compression type and just use https://pub.dev/packages/archive which does support web.
After decompressing, I'm getting "Error: Unsupported operation: Int64 accessor not supported by dart2js." which is from this line: https://github.com/spnda/dart_minecraft/blob/main/lib/src/utilities/readers/_byte_reader.dart#L61
I also found this related issue: dart-lang/sdk#10275
Is there anything we can do about this?

can you code plugins in minecraft using dart?

Can't ping server

void getServer() async {
    final server = await ping('mc.hypixel.net');
    if (server == null || server.response == null) return;
    final players = server.response!.players;
    if (kDebugMode) {
      print('Pinged ...');
    }
    if (kDebugMode) {
      print('${players.online} / ${players.max}. ${server.ping}ms.');
    }
    setState(() {
      playersOnline = players;
    });
  }

Error: Unsupported operation: dart:io is required to ping servers.

Even when i import dart:io, it still doesnt work

Can you support to read NBT as Json map?

I was checking out your repo and thought it would be awesome if you could add support for reading NBT files and converting them to JSON. It would make working with NBT data a lot easier for people like me who need to create a user interface like this.

Can't read mcstructure file (it is nbt file)

Bedrock .mcstructure files structure https://gist.github.com/tryashtar/87ad9654305e5df686acab05cc4b6205

can't read file

I have the file in my folders but every time I try to read the nbt file I get error (E/flutter ( 5298): [ERROR:flutter/runtime/dart_vm_initializer.cc(41)] Unhandled Exception: PathNotFoundException: Cannot open file, path = 'assets/gifs/deneme1.nbt' (OS Error: No such file or directory, errno = 2))

void asd() async {
    print("executed main");
    final nbtReader = NbtReader.fromFile('assets/gifs/deneme1.nbt');
    try {
      nbtReader.read();
    } on NbtFileReadException {
      print('Failed to read data.nbt');
    }
  }

Improvement: Refactor code to match effective_dart guidelines

While reading the code I found that PascalCase is being used to name Dart source files (e.g. Minecraft.java). Effective Dart guidelines (proposed by the Dart team) advise to name files with lower_snake_case convention. It would be nice to refactor the code so it matches this guideline so all Dart & Flutter developers communicate using the same language patterns.

NBTReader.getContentEndian() returns Endian.big without condition

In lib/src/nbt/nbt_reader.dart, class NbtReader
Line 70 to 72

Endian getContentEndian() { return Endian.big; }

This code is going to cause that whenever I try to get the endian of a NBT file, I would get Endian.big.
Is this an oversight? Or maybe you just don't intend to implement this function?

Also, can you please add an argument that receives Endian type variable to NbtWriter().writeFile() to enable us to write NBT file in little endian? I read a NBT file in little endian then write it as another file but then the new NBT file seems broken.

I can't ping servers that have a port other than 25565

Hello, I noticed that only the server with port 25565 is displayed. If the server has a different port, it is not displayed.

below my code:

https://pastebin.com/Ne5igc2m