summaryrefslogtreecommitdiff
path: root/libnres/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'libnres/README.md')
-rw-r--r--libnres/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/libnres/README.md b/libnres/README.md
new file mode 100644
index 0000000..065bd40
--- /dev/null
+++ b/libnres/README.md
@@ -0,0 +1,25 @@
+# Library for NRes files (Deprecated)
+
+Library for viewing and retrieving game resources of the game **"Parkan: Iron Strategy"**.
+All versions of the game are supported: Demo, IS, IS: Part 1, IS: Part 2.
+Supports files with `lib`, `trf`, `rlb` extensions.
+
+The files `gamefont.rlb` and `sprites.lib` are not supported.
+This files have an unknown signature.
+
+## Example
+
+Example of extracting game resources:
+
+```rust
+fn main() {
+ let file = std::fs::File::open("./voices.lib").unwrap();
+ // Extracting the list of files
+ let list = libnres::reader::get_list(&file).unwrap();
+
+ for element in list {
+ // Extracting the contents of the file
+ let data = libnres::reader::get_file(&file, &element).unwrap();
+ }
+}
+```