summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9f21000
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# gsctool
+
+Simple GSC loader and dumper for `Call Of Duty: Black Ops 1 (T5) (Microsoft Windows)`.
+
+To load the demo GSC plugin copy `gsctool` to the games root directory.
+
+This demo will give you a raygun on spawn in zombie mode (solo).
+
+* GSC dumps are written to `gsctool/cache`
+
+This project is intended to be a starting point for more advanced mods.
+
+# Instructions
+
+Run: `git submodule update --init --recursive` to clone submodules.
+
+Then build project using the provided makefile in Windows Subsystem for Linux
+and inject resulting DLL.
+
+The compiler used for this project is `tcc`.
+
+Note: You can modify and reload GSC scripts while Black Ops is running by quiting
+the level and starting it again.
+
+![Demo](https://raw.githubusercontent.com/lunarjournal/gsctool/main/images/demo.png)
+
+# Libraries
+
+* [cdl86](https://github.com/lunarjournal/cdl86) detour library
+* [miniz](https://github.com/lunarjournal/miniz) zlib library
+