Skip to content
This repository was archived by the owner on May 22, 2025. It is now read-only.

Commit 99acb3d

Browse files
authored
Update README.md
update readme with `pathfinder` feature and rust-analyzer note, re: tgstation#115
1 parent 0bdb3bb commit 99acb3d

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This library is currently used in the [/tg/station] codebase, and is required fo
77
it to run. A pre-compiled DLL version can be found in the repo root of codebases that use it,
88
but you can build your own from this repo (and you should if you're running a server).
99

10-
Builds can also be found on the [releases page] but should only be used for Windows,
10+
Builds can also be found on the [releases page] **but should only be used for Windows**,
1111
as Linux has compatibility issues across distributions.
1212

1313
[releases page]: https://github.com/tgstation/rust-g/releases
@@ -104,11 +104,14 @@ The default features are:
104104
105105
Additional features are:
106106
* batchnoise: Discrete Batched Perlin-like Noise, fast and multi-threaded - sent over once instead of having to query for every tile.
107+
* pathfinder: An a* pathfinder used for finding the shortest path in a static node map. Not to be used for a non-static map.
107108
* hash: Faster replacement for `md5`, support for SHA-1, SHA-256, and SHA-512. Requires OpenSSL on Linux.
108109
* redis_pubsub: Library for sending and receiving messages through Redis.
109110
* unzip: Function to download a .zip from a URL and unzip it to a directory.
110111
* worleynoise: Function that generates a type of nice looking cellular noise, more expensive than cellularnoise
111112
113+
Regarding rust-analyzer: If you are using a feature set other than the default, you will need to adjust `rust-analyzer.cargo.features`.
114+
112115
## Installing
113116
114117
The rust-g binary (`rust_g.dll` or `librust_g.so`) should be placed in the root

0 commit comments

Comments
 (0)