feat: add example cheat

Author: not-matthias

.envrc

@@ -0,0 +1,4 @@
+watch_file devenv.nix 
+watch_file devenv.yaml 
+watch_file devenv.lock
+eval "$(devenv print-dev-env)"

.gitignore

@@ -1,2 +1,5 @@
 target/
-!example/target
+!example/target
+
+.devenv*
+devenv.local.nix

Cargo.lock

@@ -0,0 +1,138 @@
+{
+  "nodes": {
+    "devenv": {
+      "locked": {
+        "dir": "src/modules",
+        "lastModified": 1673522518,
+        "narHash": "sha256-dnx3rqIPWlKXtmMpgJt0IYVW993NE3hFQbmkTOqF31Q=",
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "5ad17277d94133e015307f3dbc2f30f5fe693464",
+        "type": "github"
+      },
+      "original": {
+        "dir": "src/modules",
+        "owner": "cachix",
+        "repo": "devenv",
+        "type": "github"
+      }
+    },
+    "flake-compat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1668681692,
+        "narHash": "sha256-Ht91NGdewz8IQLtWZ9LCeNXMSXHUss+9COoqu6JLmXU=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "009399224d5e398d03b22badca40a37ac85412a1",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-utils": {
+      "locked": {
+        "lastModified": 1667395993,
+        "narHash": "sha256-nuEHfE/LcWyuSWnS8t12N1wc105Qtau+/OdUAjtQ0rA=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "5aed5285a952e0b949eb3ba02c12fa4fcfef535f",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "gitignore": {
+      "inputs": {
+        "nixpkgs": [
+          "pre-commit-hooks",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1660459072,
+        "narHash": "sha256-8DFJjXG8zqoONA1vXtgeKXy68KdJL5UaXR8NtVMUbx8=",
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "rev": "a20de23b925fd8264fd7fad6454652e142fd7f73",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1673466167,
+        "narHash": "sha256-1HzUCtWwHRGzTOHCIKGG0lVL6wvsyPSSyBuIqZWYowc=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "68e03abb2fd8db50eaee69ad58b208451143e005",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs-stable": {
+      "locked": {
+        "lastModified": 1671271954,
+        "narHash": "sha256-cSvu+bnvN08sOlTBWbBrKaBHQZq8mvk8bgpt0ZJ2Snc=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "d513b448cc2a6da2c8803e3c197c9fc7e67b19e3",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-22.05",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "pre-commit-hooks": {
+      "inputs": {
+        "flake-compat": "flake-compat",
+        "flake-utils": "flake-utils",
+        "gitignore": "gitignore",
+        "nixpkgs": [
+          "nixpkgs"
+        ],
+        "nixpkgs-stable": "nixpkgs-stable"
+      },
+      "locked": {
+        "lastModified": 1673281605,
+        "narHash": "sha256-v6U0G3pJe0YaIuD1Ijhz86EhTgbXZ4f/2By8sLqFk4c=",
+        "owner": "cachix",
+        "repo": "pre-commit-hooks.nix",
+        "rev": "f8992fb404c7e79638192a10905b7ea985818050",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "pre-commit-hooks.nix",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "devenv": "devenv",
+        "nixpkgs": "nixpkgs",
+        "pre-commit-hooks": "pre-commit-hooks"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

devenv.lock

@@ -0,0 +1,10 @@
+{pkgs, ...}: {
+  env.RUST_LOG = "info";
+  env.NIXPKGS_ALLOW_UNFREE = "1";
+
+  packages = with pkgs; [
+    assaultcube
+  ];
+
+  languages.rust.enable = true;
+}

devenv.nix

@@ -0,0 +1,3 @@
+inputs:
+  nixpkgs:
+    url: github:NixOS/nixpkgs/nixpkgs-unstable

devenv.yaml

@@ -1,6 +1,6 @@
-use hax::ExternalMemory;
-use hax::memlib::MemoryReadExt;
 use env_logger::Env;
+use hax::memlib::MemoryReadExt;
+use hax::ExternalMemory;
 
 fn test_simple(mem: ExternalMemory) {
     // &value
@@ -34,7 +34,6 @@ fn test_struct(mem: ExternalMemory) {
     log::info!("money: {}", money);
 }
 
-
 fn main() {
     env_logger::Builder::from_env(Env::default().default_filter_or("info")).init();
 

example/cheat/src/main.rs

@@ -5,15 +5,15 @@ use memoffset::offset_of;
 struct Player {
     health: u32,
     armor: u32,
-    money: u32
+    money: u32,
 }
 
 impl Player {
     pub fn new() -> Self {
         Self {
             health: 100,
             armor: 200,
-            money: 1000
+            money: 1000,
         }
     }
 }
@@ -52,9 +52,6 @@ fn main() {
         log::info!("offset: {:x}", offset_of!(Player, money));
         println!();
 
-
-
-
         // Wait for user input
         //
         let mut input = String::new();

example/target/src/main.rs

@@ -6,4 +6,7 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-hax = { git = "https://github.com/hax-rs/hax", branch = "feature" }
+env_logger = "0.10.0"
+log = "0.4.17"
+
+hax = { git = "https://github.com/hax-rs/hax" }

project/Cargo.toml

@@ -1,4 +1,68 @@
-#[hax::main]
-fn entrypoint() {
-    println!("Hello, world!");
+#![allow(unused)]
+
+use env_logger::Env;
+use hax::memlib::MemoryReadExt;
+use hax::ExternalMemory;
+use hax::memlib::MemoryWriteExt;
+
+
+#[cfg(target_os = "linux")]
+const PLAYER_POINTER: u64 = 0x5F0E10;
+#[cfg(target_os = "linux")]
+const HEALTH: u64 = 0x100;
+#[cfg(target_os = "linux")]
+const ARMOR: u64 = 0x104;
+
+
+#[cfg(target_os = "windows")]
+const PLAYER_POINTER: u64 = 0x10F4F4;
+#[cfg(target_os = "windows")]
+const HEALTH: u64 = 0xF8;
+#[cfg(target_os = "windows")]
+const ARMOR: u64 = 0x150;
+
+struct Player {
+    mem: ExternalMemory,
+    player: u64
+}
+
+impl Player {
+    pub fn new(mem: ExternalMemory) -> Self {
+        let player = mem.read::<u32>(PLAYER_POINTER) as u64;
+
+        Self {
+            mem,
+            player
+        }
+    }
+
+    pub fn health(&self) -> u16 {
+        self.mem.read(self.player + HEALTH)
+    }
+
+    pub fn set_health(&self, health: u16)  {
+        self.mem.write(self.player + HEALTH, &health)
+    }
+
+    pub fn armor(&self) -> u16 {
+        self.mem.read(self.player + ARMOR)
+    }
+
+    pub fn set_armor(&self, armor: u16) {
+        self.mem.write(self.player + ARMOR, &armor)
+    }
+}
+
+fn main() {
+    env_logger::Builder::from_env(Env::default().default_filter_or("info")).init();
+
+    let pid = 1284855;
+    let mem = ExternalMemory::new(pid);
+
+    let player = Player::new(mem);
+    log::info!("health: {}", player.health());
+    log::info!("armor: {}", player.armor());
+
+    player.set_health(1337);
+    player.set_armor(1337);
 }