Browse Source

Add readme

alaah 6 years ago
parent
commit
723d3e150d
1 changed files with 12 additions and 0 deletions
  1. 12 0
      README.md

+ 12 - 0
README.md

@@ -0,0 +1,12 @@
+Put a full vanilla res.pak and ModTools into this directory. Vanilla files will be stored in CDBV and PAKV.
+Create dirs CDB and PAK, and only put the files you edited. Refer to the [Corrupted](https://gitlab.com/alaah/dead-cells-corrupted-mode) files for an example.
+
+# Files
+* compile-all – exec compile-cdb and compile-pak
+* compile-cdb – collapse the CDB dir into PAK/data.cdb
+* compile-pak – build the mod and optionally launch dead cells
+* config – variables; edit to your needs
+* extract-vanilla – extracts the full res.pak
+
+# License
+See LICENSE for information