dfhack/docs/plugins/RemoteFortressReader.rst

25 lines
656 B
ReStructuredText

2022-07-25 07:56:21 -06:00
RemoteFortressReader
====================
2022-07-25 07:56:21 -06:00
.. dfhack-tool::
:summary: Backend for Armok Vision.
2022-08-12 00:34:37 -06:00
:tags: dev graphics
:no-command:
.. dfhack-command:: RemoteFortressReader_version
:summary: Print the loaded RemoteFortressReader version.
.. dfhack-command:: load-art-image-chunk
:summary: Gets an art image chunk by index.
This plugin provides an API for realtime remote fortress visualization. See
:forums:`Armok Vision <146473>`.
2022-07-25 07:56:21 -06:00
2022-08-17 23:42:02 -06:00
Usage
-----
2022-07-25 07:56:21 -06:00
``RemoteFortressReader_version``
Print the loaded RemoteFortressReader version.
``load-art-image-chunk <chunk id>``
Gets an art image chunk by index, loading from disk if necessary.