Add a guide

GUIDE.md

@@ -0,0 +1,38 @@
+# Easy steps to add a cheat to this app:
+
+1. Create a file in [the cheat directory](./cheats/)
+2. Create a class that inherits from `Hack`:
+
+```python
+from hack import Hack
+
+class Yourcheat(Hack):
+    def __init__(self, **kwargs) -> None:
+        super().__init__(**kwargs)
+```
+
+3. Add the method who will contains the cheat logic, note that:
+   - Your method must contains a sub-method and must be added to
+     the `hackloop` at the end of the method (see example below).
+
+```python
+    def mycheat(self) -> None:
+        # Cheat initialization, will run only one time
+
+        def cheat():
+            # Your cheat logic, will be looped
+
+        # Setup the loop
+        self.hack_loop(cheat)
+```
+
+## Extra infos
+
+- `self.pm` is used to read/write memory
+- `self.offsets` contains a list of offsets
+- `self.find_module` finds a module (`.dll`)
+- `self.find_uint` always returns something (blocking thread)
+- You can always add time between each loop call by calling `sleep`
+- See the [utils](./utils.py) file if you need more tools, like a vector class,
+  colour etc.
+- If needed, feel free to add your own offsets to the `self.offsets` variable

README.md

@@ -1,6 +1,6 @@
 # CSGOHACKS
 
-External cheats, educational content only.
+External cheats for Windows, educational content only.
 
 ## How to use?
 
@@ -45,3 +45,5 @@ Feel free to modify the [run.bat](./run.bat) as you wish.
 - No-recoil
 - Radar hack
 - Trigger hack
+
+Want to add a cheat? See [the guide](./GUIDE.md)!