alemi/aiocraft
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: wording, consistency

Browse source
This commit is contained in:
əlemi 2023-11-20 19:25:50 +01:00
parent 338f6c91cc
commit 13475e65e8
Signed by: alemi
GPG key ID: A4895B84D311642C
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,16 +1,16 @@
# aiocraft # aiocraft
**an asyncio-driven headless client library for block game with packet definitions** **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 involving the official client and Java 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](https://github.com/PrismarineJS/minecraft-data), which contains definitions for all types across all versions. it is built on top of [PrismarineJS/minecraft-data](https://github.com/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](https://git.alemi.dev/treepuncher/about)** 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](https://git.alemi.dev/treepuncher/about)**
## Packets ## Packets
The whole Minecraft protocol from `0.30c` to `1.19.3` is compiled and available. 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. feature flags to only include certain protocol versions are planned
All types and packets are instantiable and serializable on all supported protocols: all types and packets are instantiable and serializable on all supported protocols:
``` ```
from aiocraft.proto import PacketArmAnimation from aiocraft.proto import PacketArmAnimation
a_packet = PacketArmAnimation(hand=0) a_packet = PacketArmAnimation(hand=0)
@ -18,8 +18,8 @@ await client.dispatcher.write(a_packet)
``` ```
## Client ## Client
An abstract client is provided, but it's supposed to be extended (like in **[Treepuncher](https://git.alemi.dev/treepuncher/about)**) an abstract client implementation is provided, but it's supposed to be extended (like in **[Treepuncher](https://git.alemi.dev/treepuncher/about)**)
Such client includes all game phases implemented and both a `.join()` or a `.info()` method to handle the flow. the abstract client implements flows for all game phases and both a `.join()` or a `.info()` method to easily start the login flow
## Types ## Types
aiocraft defines these minecraft types: aiocraft defines these minecraft types:
@ -41,5 +41,5 @@ more types are planned but still not generated:
* `Item` (with constants) * `Item` (with constants)
## World ## 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. a chunk parser is provided with native code (Rust + PyO3). It is pretty fast but the abstract client doesn't make use of it