diff --git a/docs/plugins/RemoteFortressReader.rst b/docs/plugins/RemoteFortressReader.rst index 287debca8..103c904db 100644 --- a/docs/plugins/RemoteFortressReader.rst +++ b/docs/plugins/RemoteFortressReader.rst @@ -1,4 +1,18 @@ -remotefortressreader +RemoteFortressReader ==================== -An in-development plugin for realtime fortress visualisation. -See :forums:`Armok Vision <146473>`. +Tags: +:dfhack-keybind:`RemoteFortressReader_version` +:dfhack-keybind:`load-art-image-chunk` + +:index:`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 `` + Gets an art image chunk by index, loading from disk if necessary. diff --git a/plugins/remotefortressreader/remotefortressreader.cpp b/plugins/remotefortressreader/remotefortressreader.cpp index 9ab9a7502..643e92b21 100644 --- a/plugins/remotefortressreader/remotefortressreader.cpp +++ b/plugins/remotefortressreader/remotefortressreader.cpp @@ -221,12 +221,14 @@ DFHACK_PLUGIN_IS_ENABLED(enableUpdates); // Mandatory init function. If you have some global state, create it here. DFhackCExport command_result plugin_init(color_ostream &out, std::vector &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( "load-art-image-chunk", "Gets an art image chunk by index, loading from disk if necessary", - loadArtImageChunk, false, - "Usage: load_art_image_chunk N, where N is the id of the chunk to get.")); + loadArtImageChunk)); enableUpdates = true; return CR_OK; }