Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spnda/dart_minecraft
A Dart library for Minecraft and Mojang Web-APIs, authentication, and NBT Files.
https://github.com/spnda/dart_minecraft
dart dart-library dart-package library minecraft minecraft-api minecraft-apis mojang mojang-api mojang-authentication nbt nbt-api nbt-files nbt-library nbt-parser yggdrasil yggdrasil-api
Last synced: 8 days ago
JSON representation
A Dart library for Minecraft and Mojang Web-APIs, authentication, and NBT Files.
- Host: GitHub
- URL: https://github.com/spnda/dart_minecraft
- Owner: spnda
- License: mit
- Created: 2020-10-09T22:06:12.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T00:16:33.000Z (6 months ago)
- Last Synced: 2024-05-22T01:28:31.852Z (6 months ago)
- Topics: dart, dart-library, dart-package, library, minecraft, minecraft-api, minecraft-apis, mojang, mojang-api, mojang-authentication, nbt, nbt-api, nbt-files, nbt-library, nbt-parser, yggdrasil, yggdrasil-api
- Language: Dart
- Homepage: https://pub.dev/packages/dart_minecraft
- Size: 276 KB
- Stars: 18
- Watchers: 3
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# dart_minecraft
[](https://pub.dev/packages/dart_minecraft)
[](https://github.com/spnda/dart_minecraft/issues)
[](https://github.com/spnda/dart_minecraft/stargazers)
[](https://raw.githubusercontent.com/spnda/dart_minecraft/main/LICENSE)
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:
```dart
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](https://github.com/spnda/dart_minecraft/tree/main/example).
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.
```dart
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.
```dart
void main() async {
// PlayerUUID is a Pair
PlayerUuid player = await getUuid('');
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](https://github.com/spnda/dart_minecraft/tree/main/lib/src/nbt/tags).
```dart
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.
```dart
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](https://github.com/spnda/dart_minecraft/raw/main/LICENSE).