aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLeonardo Bishop <me@leonardobishop.com>2023-07-27 22:11:31 +0100
committerLeonardo Bishop <me@leonardobishop.com>2023-07-27 22:11:31 +0100
commit71db52c5443a7bf82d9a23a770994a42b043be04 (patch)
treef75f2605bb1bdc53842cd85c90d105dcc77e1c10 /README.md
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ce2941a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# murder (s&box)
+
+A re-creation of Murder from Garry's Mod, in s&box. Available at [asset.party](https://asset.party/leonardobishop/murder).
+
+## Progress
+
+This project is in active development. Things are broken, features are missing, and the code can be described as a "bodge" at best.
+
+It currently uses assets from the base game, [Sandbox](https://github.com/Facepunch/sandbox), and [simple weapon base](https://github.com/timmybo5/simple-weapon-base).
+
+To-do:
+
+- Murderer's ability to see footsteps.
+- Murderer's ability to throw knife.
+- Most sound effects.
+- Most weapon effects (though they do work).
+- Spectator mode.
+- The whole clue system thing that nobody really cared about.
+- De-shittify code.
+
+Already implemted:
+
+- Most of the actual Murder logic.
+- Basic movement / networking / etc.
+- Weapon functionality (sans knife throwing).
+- Blinding.
+- Inventory "system".
+
+## Feedback
+
+I'm reachable in the s&box Discord server `@leonardobishop` or via email `me [at] leonardobishop [dot] com`.
+
+## Credits
+
+This project makes use of other open source assets. Their credits and attributions can be found in [ATTRIBUTIONS](ATTRIBUTIONS).
+