Skip to content
/ rglua Public

Toolkit for garrysmod development with the source sdk and lua c api

License

Notifications You must be signed in to change notification settings

Vurv78/rglua

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rglua Release Shield Linux Build Status License github/Vurv78

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

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 and an example can be found at the bottom of this file.

Usage

Add this to your Cargo.toml file

[lib]
crate-type = ["cdylib"] # This tells rust we want to create a .dll file that links to C code.

[dependencies]
rglua = { git = "https://github.com/Vurv78/rglua" }

Building

After installing rust, just run cargo build --release.

If you are building to 32 bit for srcds or non x64 garrysmod, first do:
rustup target add i686-pc-windows-msvc in order to make rust download any 32 bit libraries needed to compile this.

And finally run:
cargo build --release --target=i686-pc-windows-msvc

Also do this if you have never compiled to 32 bit, to get rustup to install 32 bit versions of everything you need
rustup target add i686-pc-windows-msvc

Notes

  • I have never tested this outside of Windows and won't. If there are any issues on other platforms, I will gladly accept any PRs you may make but I won't be able to help you myself.

  • The nature of this crate is super unsafe and sort of defeats the purpose of rust's safety because of the interfacing you require to unsafe C code and the nature of linking to them.

Example Module

use rglua::{
	types::{ LuaState, CharBuf },
	cstring,
	lua_shared::*
};

#[no_mangle]
pub extern fn gmod13_open(state: LuaState) -> i32 {
	lua_getglobal( state, b"print\0".as_ptr() as CharBuf );
	lua_pushstring( state, cstring!("Hello from rust!") );
	lua_call( state, 1, 0 );
	0
}

#[no_mangle]
pub extern fn gmod13_close(_state: LuaState) -> i32 {
	0
}

Acknowledgements

This is heavily based off of garrysmod_common, in how we export the lua_shared functions and trying to replicate everything from the Lua C Api.