MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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 <pierre>
develop
Pierre Lulé 2022-05-01 15:31:59 +02:00 committed by GitHub
parent 7120988044
commit 876d9132b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/Remote.rst
Unescape Escape View File

@ -75,10 +75,11 @@ from other (non-C++) languages, including:
- `RemoteClientDF-Net <https://github.com/RosaryMala/RemoteClientDF-Net>`_ for C# - `RemoteClientDF-Net <https://github.com/RosaryMala/RemoteClientDF-Net>`_ for C#
- `dfhackrpc <https://github.com/BenLubar/dfhackrpc>`_ for Go - `dfhackrpc <https://github.com/BenLubar/dfhackrpc>`_ for Go
- `dfhack-remote <https://github.com/alexchandel/dfhack-remote>`_ for JavaScript - `dfhack-remote <https://github.com/alexchandel/dfhack-remote>`__ for JavaScript
- `dfhack-client-qt <https://github.com/cvuchener/dfhack-client-qt>`_ for C++ with Qt - `dfhack-client-qt <https://github.com/cvuchener/dfhack-client-qt>`_ for C++ with Qt
- `dfhack-client-python <https://github.com/McArcady/dfhack-client-python>`_ for Python (adapted from :forums:`"Blendwarf" <178089>`) - `dfhack-client-python <https://github.com/McArcady/dfhack-client-python>`_ for Python (adapted from :forums:`"Blendwarf" <178089>`)
- `dfhack-client-java <https://github.com/McArcady/dfhack-client-java>`_ for Java - `dfhack-client-java <https://github.com/McArcady/dfhack-client-java>`_ for Java
- `dfhack-remote <https://docs.rs/dfhack-remote/latest/dfhack_remote/index.html>`__ for Rust
Protocol description Protocol description

1
docs/changelog.txt
Unescape Escape View File

@ -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 - `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 - ``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``). - Document DFHack `lua-string` (``startswith``, ``endswith``, ``split``, ``trim``, ``wrap``, and ``escape_pattern``).
- Added a Rust client library to the `remote interface docs <remote-client-libs>`
## API ## API
- Added functions reverse-engineered from ambushing unit code: ``Units::isHidden``, ``Units::isFortControlled``, ``Units::getOuterContainerRef``, ``Items::getOuterContainerRef`` - Added functions reverse-engineered from ambushing unit code: ``Units::isHidden``, ``Units::isFortControlled``, ``Units::getOuterContainerRef``, ``Items::getOuterContainerRef``