From 876d9132b1b07fa7128d9096e1395f10667e7206 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pierre=20Lul=C3=A9?= Date: Sun, 1 May 2022 15:31:59 +0200 Subject: [PATCH] Add a link to the rust library for interacting with the remote API (#2121) * Add link to the rust api client library Add a link to https://docs.rs/dfhack-remote/latest/dfhack_remote/index.html a library interacting with DFHack remote API for the Rust programming language * Use the docs.rs link * Fix duplicate link label, included the change in the changelog Co-authored-by: pierre --- docs/Remote.rst | 3 ++- docs/changelog.txt | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/Remote.rst b/docs/Remote.rst index c41a14058..de741f66a 100644 --- a/docs/Remote.rst +++ b/docs/Remote.rst @@ -75,10 +75,11 @@ from other (non-C++) languages, including: - `RemoteClientDF-Net `_ for C# - `dfhackrpc `_ for Go -- `dfhack-remote `_ for JavaScript +- `dfhack-remote `__ for JavaScript - `dfhack-client-qt `_ for C++ with Qt - `dfhack-client-python `_ for Python (adapted from :forums:`"Blendwarf" <178089>`) - `dfhack-client-java `_ for Java +- `dfhack-remote `__ for Rust Protocol description diff --git a/docs/changelog.txt b/docs/changelog.txt index 06406087a..cc7f2af06 100644 --- a/docs/changelog.txt +++ b/docs/changelog.txt @@ -74,6 +74,7 @@ changelog.txt uses a syntax similar to RST, with a few special sequences: - `confirm`: Correct the command name in the plugin help text - ``Quickfort Blueprint Editing Guide``: added screenshots to the Dreamfort case study and overall clarified text - Document DFHack `lua-string` (``startswith``, ``endswith``, ``split``, ``trim``, ``wrap``, and ``escape_pattern``). +- Added a Rust client library to the `remote interface docs ` ## API - Added functions reverse-engineered from ambushing unit code: ``Units::isHidden``, ``Units::isFortControlled``, ``Units::getOuterContainerRef``, ``Items::getOuterContainerRef``