Merge pull request #156 from gamingrobot/plugin-docs

Add plugin docs

docs/conf.py

@@ -43,6 +43,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
 ]
 
 if spelling is not None:

docs/plugins/core/auth.rst

@@ -0,0 +1,20 @@
+.. _plugin-auth:
+
+****
+Auth
+****
+
+Description
+===========
+.. automodule:: spock.plugins.core.auth
+
+Events
+======
+Undocumented
+
+Methods and Attributes
+======================
+.. autoclass:: AuthCore
+    :members:
+    :undoc-members:
+

docs/plugins/core/event.rst

@@ -0,0 +1,20 @@
+.. _plugin-event:
+
+*****
+Event
+*****
+
+Description
+===========
+.. automodule:: spock.plugins.core.event
+
+Events
+======
+Undocumented
+
+Methods and Attributes
+======================
+.. autoclass:: EventCore
+    :members:
+    :undoc-members:
+

docs/plugins/core/index.rst

@@ -0,0 +1,23 @@
+Core Plugins
+============
+
+.. toctree::
+    :hidden:
+
+    auth
+    event
+    net
+    settings
+    taskmanager
+    ticker
+    timer
+
+
+- :ref:`plugin-auth` - Handling Minecraft account authentication
+- :ref:`plugin-event` - Provides an event system
+- :ref:`plugin-net` - Handles packets
+- :ref:`plugin-settings` - Allows custom settings handlers
+- :ref:`plugin-taskmanager` - Create state machine tasks
+- :ref:`plugin-ticker` - Ticks 20 times a second
+- :ref:`plugin-timer` - Create timers to do stuff later
+

docs/plugins/core/net.rst

@@ -0,0 +1,20 @@
+.. _plugin-net:
+
+***
+Net
+***
+
+Description
+===========
+.. automodule:: spock.plugins.core.net
+
+Events
+======
+Undocumented
+
+Methods and Attributes
+======================
+.. autoclass:: NetCore
+    :members:
+    :undoc-members:
+

docs/plugins/core/settings.rst

@@ -0,0 +1,17 @@
+.. _plugin-settings:
+
+********
+Settings
+********
+
+Description
+===========
+.. automodule:: spock.plugins.core.settings
+
+Events
+======
+Undocumented
+
+Methods and Attributes
+======================
+Undocumented

docs/plugins/core/taskmanager.rst

@@ -0,0 +1,17 @@
+.. _plugin-taskmanager:
+
+************
+Task Manager
+************
+
+Description
+===========
+.. automodule:: spock.plugins.core.taskmanager
+
+Events
+======
+Undocumented
+
+Methods and Attributes
+======================
+Undocumented

docs/plugins/core/ticker.rst

@@ -0,0 +1,18 @@
+.. _plugin-ticker:
+
+******
+Ticker
+******
+
+Description
+===========
+.. automodule:: spock.plugins.core.ticker
+
+Events
+======
+Undocumented
+
+Methods and Attributes
+======================
+Undocumented
+

docs/plugins/core/timer.rst

@@ -0,0 +1,20 @@
+.. _plugin-timer:
+
+*****
+Timer
+*****
+
+Description
+===========
+.. automodule:: spock.plugins.core.timer
+
+Events
+======
+Undocumented
+
+Methods and Attributes
+======================
+.. autoclass:: TimerCore
+    :members:
+    :undoc-members:
+

docs/plugins/helpers/chat.rst

@@ -0,0 +1,64 @@
+.. _plugin-chat:
+
+****
+Chat
+****
+
+Description
+===========
+.. automodule:: spock.plugins.helpers.chat
+
+Events
+======
+.. object:: chat
+
+    Chat event was recieved 
+
+    **Playload** ::
+
+        {'position': position, 'raw': json_data, 'text': text, 'type': chat_type, 'message': msg, 'name': name, 'uuid': uuid}
+
+    .. object:: position
+
+        *int*
+
+        Where the text should be displayed
+
+    .. object:: raw
+
+        *dict*
+
+        Raw json data from the chat message
+
+    .. object:: text
+
+        *string*
+
+        The text of the chat message
+
+    .. object:: type
+
+        *string*
+
+        The type of message (achievement, admin, announcement, emote, incoming, outgoing, text)
+
+    .. object:: message
+
+        *string*
+
+        message
+
+    .. object:: uuid
+
+        *string*
+
+        UUID of the player who sent the message
+
+
+Methods and Attributes
+======================
+.. autoclass:: ChatCore
+    :members:
+    :undoc-members:
+
+

docs/plugins/helpers/clientinfo.rst

@@ -0,0 +1,87 @@
+.. _plugin-clientinfo:
+
+***********
+Client Info
+***********
+
+Description
+===========
+.. automodule:: spock.plugins.helpers.clientinfo
+
+Events
+======
+.. object:: client_login_success
+
+    Client Info is done processing the Login Success packet
+
+.. object:: client_join_game
+
+    Client Info is done processing the Join Game packet
+
+    **Playload** ::
+
+        GameInfo()
+
+.. object:: client_spawn_update
+
+    Client Info is done processing the Spawn Position packet
+
+    **Playload** ::
+
+        Position()
+
+.. object:: client_health_update
+
+    When the players health changes
+
+    **Playload** ::
+
+        PlayerHealth()
+
+.. object:: client_death
+
+    When the player health becomes 0.0
+
+    **Playload** ::
+
+        PlayerHealth()
+
+.. object:: client_position_update
+
+    When the player is moved by the server
+
+    **Playload** ::
+
+        PlayerPosition()
+
+.. object:: client_add_player
+
+    Player added to the player list
+
+    **Playload** ::
+
+        PlayerListItem()
+
+.. object:: client_update_player
+
+    Player info is updated on the player list
+
+    **Playload** ::
+
+        PlayerListItem()
+
+.. object:: client_remove_player
+
+    Player removed from the player list
+
+    **Playload** ::
+
+        PlayerListItem()
+
+Methods and Attributes
+======================
+.. autoclass:: ClientInfo
+    :members:
+    :undoc-members:
+
+

docs/plugins/helpers/craft.rst

@@ -0,0 +1,20 @@
+.. _plugin-craft:
+
+*****
+Craft
+*****
+
+Description
+===========
+.. automodule:: spock.plugins.helpers.craft
+
+Events
+======
+Undocumented
+
+Methods and Attributes
+======================
+.. autoclass:: CraftPlugin
+    :members:
+    :undoc-members:
+

docs/plugins/helpers/entities.rst

@@ -0,0 +1,20 @@
+.. _plugin-entities:
+
+********
+Entities
+********
+
+Description
+===========
+.. automodule:: spock.plugins.helpers.entities
+
+Events
+======
+Undocumented
+
+Methods and Attributes
+======================
+.. autoclass:: EntitiesCore
+    :members:
+    :undoc-members:
+

docs/plugins/helpers/index.rst

@@ -0,0 +1,33 @@
+Helper Plugins
+==============
+
+.. toctree::
+    :hidden:
+
+    chat
+    clientinfo
+    craft
+    entities
+    interact
+    inventory
+    keepalive
+    movement
+    physics
+    respawn
+    start
+    world
+
+
+- :ref:`plugin-chat` - Process chat into simple events
+- :ref:`plugin-clientinfo` - Keep track of information about the client/player
+- :ref:`plugin-craft` - Craft items
+- :ref:`plugin-entities` - Keep track of entities
+- :ref:`plugin-interact` - Interact with the world
+- :ref:`plugin-inventory` - Interact with inventories in Minecraft
+- :ref:`plugin-keepalive` - Keep sending the keep alive packet
+- :ref:`plugin-movement` - Basic movement around the world
+- :ref:`plugin-physics` - Reimplmentation of the Vanilla physics
+- :ref:`plugin-respawn` - Auto respawn the player on death
+- :ref:`plugin-start` - Helper start system for doing handshake and login
+- :ref:`plugin-world` - Keep track of world data
+