Skip to content
This repository was archived by the owner on Nov 12, 2025. It is now read-only.

Commit b47267c

Browse files
authored
Update README.md
1 parent 1777f36 commit b47267c

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
1-
# rglua ![TravisCI Status](https://www.travis-ci.com/Vurv78/rglua.svg?branch=main)
1+
# rglua ![TravisCI 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://discordapp.com/api/guilds/824727565948157963/widget.png)](https://discord.gg/epJFC6cNsw)
22

3-
This is a Rust library that contains bindings for garrysmod binary module creation that gives you complete access to the lua c api through bindings from dlopen.
4-
It uses rust-dlopen
3+
4+
This is a Rust library that contains bindings for tinkering with the lua c api in garrysmod through bindings using rust-dlopen.
5+
Can be used for either binary modules or just manual injections into gmod, like with [Autorun-rs](https://github.com/Vurv78/Autorun-rs)
56

67
More information on binary modules: https://wiki.facepunch.com/gmod/Creating_Binary_Modules
78

8-
An example module made with rglua is below
9+
An example module can be found below.
910

1011
## How to build
1112

12-
Add this to your Cargo.toml
13+
Add this to your Cargo.toml.
1314
```toml
1415
[lib]
1516
crate-type = ["cdylib"] # This tells rust we want to create a .dll file that links to C code.
1617

1718
[dependencies]
18-
rglua = { git = "https://github.com/Vurv78/rglua", branch = "main" } # This gives you all of the good stuff w/ bindings
19+
rglua = { git = "https://github.com/Vurv78/rglua", branch = "main" }
1920
```
2021

2122
Make sure you build to 32 bit if you want to use the module with srcds / on a local server.
@@ -24,11 +25,11 @@ Make sure you build to 32 bit if you want to use the module with srcds / on a lo
2425
Also do this if you have never compiled to 32 bit, to get rustup to install 32 bit versions of everything you need
2526
``rustup target add i686-pc-windows-msvc``
2627

27-
Note:
28+
## Notes
2829
The nature of this crate is super unsafe.
2930
Using rust sort of defeats the purpose because of the sheer amount of times you'll have to convert strings from and to C, and call lua c api functions.
3031

31-
Also, 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 can't help you myself.
32+
Also, 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.
3233

3334
## Example Module
3435
```rust

0 commit comments

Comments
 (0)