0.8.0

Move around file organization *again*, this time with backwards compatible re-exports

* Added ICVar bindings
* Added IMaterial / IMaterialSystem bindings
* Fix offsets in pretty much all interfaces (mostly engine though)
* Add GetGameDirectory, GetLevelName, IsPlayingDemo, IsRecordingDemo, IsPaused to engine interface
* Add engine example to show off how to use the engine interface.
* Make previously ignored tests compile
* util::dump_stack now returns a string instead of printing to stdout
* Add Vector and Angle types (Currently meant for interfaces, not lua values)

Author: vurvdev

Cargo.toml

@@ -1,9 +1,10 @@
 [package]
 name = "rglua"
-description = "Rust tooling for garrysmod development with the LuaJIT api"
-version = "0.7.1"
+description = "Toolkit for garrysmod development with the source sdk and luajit api"
+version = "0.8.0"
 authors = ["Vurv <[email protected]>"]
 keywords = ["glua", "garrysmod", "lua", "gmod"]
+categories = ["api-bindings", "external-ffi-bindings", "development-tools::ffi", "game-development", "accessibility"]
 readme = "README.md"
 license = "MIT"
 edition = "2021"
@@ -15,9 +16,14 @@ libloading = "0.7.2"
 once_cell = "1.8.0"
 thiserror = "1.0.30"
 
+derive_more = { version = "0.99.17", optional = true }
+
 vtables = { version = "0.1.0", optional = true }
 vtables_derive = { version = "0.1.0", optional = true }
 
 [features]
-default = ["interfaces"]
-interfaces = ["vtables", "vtables_derive"]
+default = ["interfaces", "userdata"]
+
+interfaces = ["vtables", "vtables_derive"]
+
+userdata = ["derive_more"]

README.md

@@ -1,11 +1,9 @@
 # 🌑 ``rglua`` [![cratesio](https://img.shields.io/crates/v/rglua.svg)](https://crates.io/crates/rglua) ![Build Status](https://www.travis-ci.com/Vurv78/rglua.svg?branch=main) [![License](https://img.shields.io/github/license/Vurv78/rglua?color=red)](https://opensource.org/licenses/Apache-2.0) [![github/Vurv78](https://img.shields.io/discord/824727565948157963?label=Discord&logo=discord&logoColor=ffffff&labelColor=7289DA&color=2c2f33)](https://discord.gg/epJFC6cNsw)
 
-This is a crate that contains bindings for using the lua c api in garrysmod through bindings using the rust libloading library.
-Can be used for either binary modules or just manual injections into gmod, like with [Autorun-rs](https://github.com/Vurv78/Autorun-rs)
+This is a crate that allows interop with the luajit c api as well as the source sdk through libloading and vtable bindings.
+You can then use these for binary modules or manually injected code, like with [Autorun-rs](https://github.com/Vurv78/Autorun-rs)
 
-This works by finding a ``lua_shared.dll`` file relative to the currently running program, so you need to make sure your file is either in ``GarrysMod/bin/`` or ``GarrysMod/garrysmod/bin`` for srcds servers. The library will panic if the file is not found.
-
-More information on binary modules can be found on the garrysmod wiki: [Creating Binary Modules](https://wiki.facepunch.com/gmod/Creating_Binary_Modules) and an example [can be found here.](https://github.com/Vurv78/rglua/tree/master/examples/is_even)
+More information on binary modules can be found on the garrysmod wiki: [Creating Binary Modules](https://wiki.facepunch.com/gmod/Creating_Binary_Modules) and examples [can be found here.](https://github.com/Vurv78/rglua/tree/master/examples)
 ## Usage
 If you are targeting 32 bit make sure to install the toolchain and build to it:
 ```bash

examples/engine/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "gmod_engine"
+description = "Binary module that accesses engine.dll"
+version = "0.1.0"
+edition = "2021"
+publish = false
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+rglua = { path = "../.." }
+anyhow = "1.0.51"

examples/engine/README.md

@@ -0,0 +1,20 @@
+# ⚙️ ``iengine``
+Binary module that adds engine functions from IEngineClientV015 to the ``iengine`` library
+
+## iengine.concmd(command: string)
+Runs a concommand on yourself, internally calls ``ExecuteClientCmd``
+
+## iengine.getResolution() -> number, number
+Returns your screen resolution, internally using ``GetScreenSize``
+
+## iengine.getGameDirectory() -> string
+Returns the absolute location of your garrysmod dir, internally using ``GetGameDirectory``
+
+## iengine.getLevel() -> string
+Returns the current level/map name, internally using ``GetLevelName``
+
+## iengine.isRecording() -> boolean
+Returns ``true`` if you are recording a demo, else ``false``, internally using ``IsRecordingDemo``
+
+## iengine.isPaused() -> boolean
+Returns ``true`` if the game is paused, else ``false``, internally using ``IsPaused``

examples/engine/src/lib.rs

@@ -0,0 +1,117 @@
+use rglua::interface::{get_from_interface, get_interface_handle, EngineClient};
+use rglua::prelude::*;
+
+use anyhow::bail;
+
+fn get_iface() -> anyhow::Result<&'static EngineClient> {
+	let handle = unsafe { get_interface_handle("engine.dll")? };
+	let iface = get_from_interface("VEngineClient015", handle)? as *mut EngineClient;
+	match unsafe { iface.as_ref() } {
+		Some(iface) => Ok(iface),
+		None => bail!("Failed to get interface"),
+	}
+}
+
+extern "C" fn concmd(l: LuaState) -> i32 {
+	match get_iface() {
+		Ok(iface) => {
+			iface.ExecuteClientCmd( luaL_checklstring(l, 1, 0) );
+		}
+		Err(e) => printgm!(l, "{}", e)
+	}
+	0
+}
+
+extern "C" fn get_resolution(l: LuaState) -> i32 {
+	match get_iface() {
+		Ok(iface) => unsafe {
+			let (w, h): (*mut _, *mut _) = (&mut 0, &mut 0);
+			iface.GetScreenSize(w, h);
+			lua_pushinteger(l, *w as isize);
+			lua_pushinteger(l, *h as isize);
+			return 2;
+		},
+		Err(e) => {
+			printgm!(l, "Failed to get interface: {}", e);
+		}
+	}
+	0
+}
+
+extern "C" fn get_directory(l: LuaState) -> i32 {
+	match get_iface() {
+		Ok(iface) => {
+			let dir = iface.GetGameDirectory();
+			lua_pushstring(l, dir);
+			return 1;
+		},
+		Err(e) => {
+			printgm!(l, "Failed to get interface: {}", e);
+		}
+	}
+	0
+}
+
+extern "C" fn get_level(l: LuaState) -> i32 {
+	match get_iface() {
+		Ok(iface) => {
+			let level = iface.GetLevelName();
+			lua_pushstring(l, level);
+			return 1;
+		},
+		Err(e) => {
+			printgm!(l, "Failed to get interface: {}", e);
+		}
+	}
+	0
+}
+
+extern "C" fn is_recording(l: LuaState) -> i32 {
+	match get_iface() {
+		Ok(iface) => {
+			let demo = iface.IsRecordingDemo();
+			lua_pushboolean(l, demo as i32);
+			return 1;
+		},
+		Err(e) => {
+			printgm!(l, "Failed to get interface: {}", e);
+		}
+	}
+	0
+}
+
+extern "C" fn is_paused(l: LuaState) -> i32 {
+	match get_iface() {
+		Ok(iface) => {
+			let paused = iface.IsPaused();
+			lua_pushboolean(l, paused as i32);
+			return 1;
+		},
+		Err(e) => {
+			printgm!(l, "Failed to get interface: {}", e);
+		}
+	}
+	0
+}
+
+#[no_mangle]
+extern "C" fn gmod13_open(l: LuaState) -> i32 {
+	printgm!(l, "Loaded engine module!");
+
+	let lib = reg! [
+		"concmd" => concmd,
+		"getResolution" => get_resolution,
+		"getGameDirectory" => get_directory,
+		"getLevel" => get_level,
+		"isRecording" => is_recording,
+		"isPaused" => is_paused
+	];
+
+	luaL_register(l, cstr!("iengine"), lib.as_ptr());
+	0
+}
+
+#[no_mangle]
+extern "C" fn gmod13_close(_: LuaState) -> i32 {
+	0
+}

src/globals.rs

@@ -1,4 +1,5 @@
 #[repr(C)]
+#[allow(non_snake_case)]
 pub struct PlayerInfo {
 	unknown: u64,
 	xuid: u64,
@@ -16,4 +17,4 @@ pub struct PlayerInfo {
 	customFiles: [u64; 4],
 	filesDownloaded: u8,
 	pad: [i8; 304],
-}
+}

src/interface/common.rs

@@ -0,0 +1,28 @@
+use super::prelude::*;
+
+#[repr(C)]
+pub struct ConCommandBase {
+	pub base_vtable: *mut c_void,   // 0
+	pub next: *mut ConCommandBase,  // 4
+	pub registered: bool,           // 8
+	pub name: *const c_char,        // 12
+	pub help_string: *const c_char, // 16
+	pub flags: c_int,               // 20
+}
+
+iface! {
+	/// VEngineCvar007
+	/// vstdlib.dll
+	pub abstract struct ICVar {};
+}
+
+impl ICVar {
+	#[virtual_index(1)]
+	pub fn RegisterConCommand(&self, pCommandBase: *mut ConCommandBase) {}
+
+	#[virtual_index(2)]
+	pub fn UnregisterConCommand(&self, pCommandBase: *mut ConCommandBase) {}
+
+	#[virtual_index(11)]
+	pub fn GetCommands(&self) -> *mut ConCommandBase {}
+}