]> granicus.if.org Git - nethack/commitdiff
update build notes
authorAdam Powers <apowers@ato.ms>
Sun, 30 Aug 2020 17:30:03 +0000 (10:30 -0700)
committerAdam Powers <apowers@ato.ms>
Sun, 30 Aug 2020 17:30:03 +0000 (10:30 -0700)
sys/lib/README.md

index 3d314eb317fcb3fc178dcc09b19045a0492710d0..d27a3e8752b9a7091817b4e11a75918ae0d8084f 100644 (file)
@@ -4,6 +4,8 @@ This creates a library for NetHack that can be incorporated into other programs.
 * nethack.js / nethack.wasm - a [WebAssembly / WASM](https://webassembly.org/) library for use in JavaScript programs (both nodejs and browser)
 
 ## API: libnethack.a
+This libarary has only been built on MacOS, but should work on Linux and other unix-ish platforms. If you have problems, start by stealing hints files from the `sys/unix/hints` for your platform. Contributions for other platforms are happily accepted.
+
 The API is two functions:
 * `nhmain(int argc, char *argv[])` - The main function for NetHack that configures the program and runs the `moveloop()` until the game is over. The arguments to this function are the [command line arguments](https://nethackwiki.com/wiki/Options) to NetHack.
 * `stub_graphics_set_callback(stub_callback_t cb)` - A single function that sets a callback to gather graphics events: write a string to screen, get user input, etc. Your job is to pass in a callback and handle all the requested rendering events to show NetHack on the scrren. The callback is `void stub_callback_t(const char *name, void *ret_ptr, const char *fmt,  ...)`