Lua Client
==========

This page covers using the kRPC Lua client with the ``KSA`` service.

Installing
----------

Install the kRPC Lua client 0.7.0 from `LuaRocks
<https://luarocks.org/modules/djungelorm/krpc>`_:

.. code-block:: bash

   luarocks install krpc 0.7.0

Using the KSA Service
---------------------

The client builds the ``KSA`` service from the definitions the server sends when it connects,
so the service is ``conn.ksa``:

.. code-block:: lua

   local krpc = require 'krpc'
   local conn = krpc.connect('Example')
   print(conn.ksa.active_vehicle.name)

The `kRPC Lua client guide <https://krpc.github.io/krpc/0.7.0/lua/client.html>`_ covers connecting, streams and the
client's other features.