alemi/aiocraft
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
asyncio-driven headless client library for block game
266 commits 2 branches 3 tags 1.1 MiB
Python 99.3%
Rust 0.7%
Find a file
alemi 47bea5fa5b
docs: fix link to treepuncher repo
2024-02-20 15:58:13 +01:00
.github/workflows Only run CI/CD on main branch 2022-05-15 13:28:56 +02:00
compiler feat: harder, better, faster, stronger 2023-11-20 17:36:03 +01:00
examples fix: remove example which doesn't apply anymore 2023-11-20 17:50:38 +01:00
src/aiocraft fix: when deserializing specialize for received proto 2024-01-17 02:09:51 +01:00
.editorconfig style: tabs, 2 for rs, 4 for py 2022-07-06 12:41:40 +02:00
.gitignore fix: gitignore built wheel files 2022-05-27 10:50:32 +02:00
Cargo.toml chore: moved all source under src 2023-11-20 23:45:09 +01:00
LICENSE Initial commit 2021-09-30 17:05:54 +02:00
pyproject.toml docs: updated README, bumped version 2023-11-20 17:57:33 +01:00
README.md docs: fix link to treepuncher repo 2024-02-20 15:58:13 +01:00

README.md

aiocraft

an asyncio-driven headless client library for block game with packet definitions

aiocraft is a collection of types, definitions and utils to build minecraft clients without the official Java implementation

it is built on top of PrismarineJS/minecraft-data, which contains definitions for all types across all versions

aiocraft provides a raw implementation of a client but it isn't ready to be used, if you're looking for a convenient client library take a look at Treepuncher

Packets

the whole Minecraft protocol from 0.30c to 1.19.3 is compiled and available feature flags to only include certain protocol versions are planned all types and packets are instantiable and serializable on all supported protocols:

from aiocraft.proto.play.serverbound import PacketPosition

a_packet = PacketPosition(x=-4.0, y=64.0, z=10.5, onGround=True)
await client.dispatcher.write(a_packet)

Client

an abstract client implementation is provided, but it's supposed to be extended (like in Treepuncher) the abstract client implements flows for all game phases and both a .join() or a .info() method to easily start the login flow

Types

aiocraft defines these minecraft types:

  • Dimension
  • Difficulty
  • Gamemode
  • GameProfile
  • Enchantment
  • BlockPos
  • Item (without constants)
  • Texture
  • Player

more types are planned but still not generated:

  • Entity
  • Block
  • Item (with constants)

World

a chunk parser is provided with native code (Rust + PyO3). It is pretty fast but the abstract client doesn't make use of it