update docs for RemoteFortressReader

develop
myk002 2022-07-25 06:56:21 -07:00
parent 6b1c0b5308
commit 38c17b5215
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 22 additions and 6 deletions

@ -1,4 +1,18 @@
remotefortressreader RemoteFortressReader
==================== ====================
An in-development plugin for realtime fortress visualisation. Tags:
See :forums:`Armok Vision <146473>`. :dfhack-keybind:`RemoteFortressReader_version`
:dfhack-keybind:`load-art-image-chunk`
:index:`Backend for Armok Vision.
<RemoteFortressReader; Backend for Armok Vision.>` Provides an API for realtime
remote fortress visualization. See :forums:`Armok Vision <146473>`.
Usage:
``enable RemoteFortressReader``
Enable the plugin.
``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.

@ -221,12 +221,14 @@ DFHACK_PLUGIN_IS_ENABLED(enableUpdates);
// Mandatory init function. If you have some global state, create it here. // Mandatory init function. If you have some global state, create it here.
DFhackCExport command_result plugin_init(color_ostream &out, std::vector <PluginCommand> &commands) DFhackCExport command_result plugin_init(color_ostream &out, std::vector <PluginCommand> &commands)
{ {
commands.push_back(PluginCommand("RemoteFortressReader_version", "List the loaded RemoteFortressReader version", RemoteFortressReader_version, false, "This is used for plugin version checking.")); commands.push_back(PluginCommand(
"RemoteFortressReader_version",
"List the loaded RemoteFortressReader version",
RemoteFortressReader_version));
commands.push_back(PluginCommand( commands.push_back(PluginCommand(
"load-art-image-chunk", "load-art-image-chunk",
"Gets an art image chunk by index, loading from disk if necessary", "Gets an art image chunk by index, loading from disk if necessary",
loadArtImageChunk, false, loadArtImageChunk));
"Usage: load_art_image_chunk N, where N is the id of the chunk to get."));
enableUpdates = true; enableUpdates = true;
return CR_OK; return CR_OK;
} }