.. luasteam documentation master file, created by
   sphinx-quickstart on Mon Dec 10 18:07:32 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

**luasteam** - Lua bindings for the SteamWorks API
======================================================

luasteam enables you to use SteamWorks API from Lua, for example (but not limited to) when you're building games with `Love2D <https://love2d.org/>`_.

To learn how to use luasteam, check our `Getting Started <getting_started.html>`_ section. If you're already familiar with luasteam v4, you can check the `Migration Guide <migration.html>`_ to see what's new in v5+, since at lot has changed.

While using this documentation, you may also like to check the `SteamWorks API Reference <https://partner.steamgames.com/doc/api>`_ and `SteamWorks API Overview <https://partner.steamgames.com/doc/sdk/api>`_.

.. toctree::
    :maxdepth: 2
    :caption: General Documentation:

    Getting Started <getting_started>
    Migration Guide from v4 <migration>
    Networking Sockets Example <networking_sockets_example>

.. toctree::
    :maxdepth: 2
    :caption: API Reference:
    :glob:
    
    Core Functions <steam_api>
    Extra <extra>
    auto/*

Indices and tables
==================
* :ref:`genindex`