mirror of
https://github.com/ammaraskar/pyCraft.git
synced 2024-12-05 00:23:24 +01:00
32 lines
952 B
ReStructuredText
32 lines
952 B
ReStructuredText
.. pyCraft documentation master file, created by
|
|
sphinx-quickstart on Sun Mar 22 00:54:04 2015.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Welcome to pyCraft's documentation!
|
|
===================================
|
|
|
|
``pyCraft`` is a python project to handle networking
|
|
between a Minecraft server as a client.
|
|
|
|
The authentication package contains utilities to manage communicating
|
|
with Mojang's authentication servers in order to log in with a minecraft
|
|
account, edit profiles etc
|
|
|
|
The Connection class under the networking package handles
|
|
connecting to a server, sending packets, listening for packets etc
|
|
|
|
The example implementation show a couple different approaches to how
|
|
you can get started with the library. One from command line and the
|
|
other being more programmatically inclined.
|
|
|
|
|
|
Contents:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
authentication
|
|
connecting
|
|
example
|