78 releases (9 stable)
16.2.2 | Sep 18, 2024 |
---|---|
16.1.0 | Jun 2, 2024 |
16.0.0-dev.1 | Dec 29, 2023 |
15.1.0 | Oct 22, 2023 |
0.2.0 |
|
#127 in Development tools
227 downloads per month
440KB
9K
SLoC
Server-side alt:V API for Rust
altv::events::on_player_connect(|event| {
let name = event.player.name()?;
altv::log!("player with name: {name} connected!");
Ok(())
});
New server-side Rust module for alt:V platform
Big thanks to the creator of the first Rust module, as their work helped me understand how to start my own module
Client-side part
At first it was native implementation using wasmtime without JavaScript. It worked, but because alt:V does not allow you to use custom client-side modules (.dll) in production without approval, integration into the client core, constant maintenance and more than 0 people using this module, I switched to a more realistic approach, JavaScript WASM
Docs
API documentation can be found here
How to use
Before all this, you need to install LLVM
[!WARNING] Currently on Windows latest version of LLVM doesn't work with Rust module, you need to install 17.0.1, for example with winget you can do it using this command
winget install LLVM.LLVM --version 17.0.1
(add--force
if it fails)
[!IMPORTANT] On Windows set LIBCLANG_PATH as an environment variable pointing to the bin directory of your LLVM install. For example, if you installed LLVM to D:\programs\LLVM, then you'd set the value to be D:\programs\LLVM\bin. You also need to have installed Visual Studio with MSVC compiler (usually installed with Rust using Rustup)
[!NOTE] If you have similar error:
src/alt_bridge.h:5:10: fatal error: 'memory' file not found
when installing or building altv_internal_sdk, try this
Video format of this tutorial if you are more into video tutorials
-
Create new cargo package with
cargo new altv-resource --lib
-
Configure cargo to compile your crate as
cdylib
in yourCargo.toml
[lib]
crate-type = ['cdylib']
-
After that you can install
altv
crate with:cargo add altv
-
Next step will be to add main function to your resource (
src/lib.rs
)
use altv::prelude::*; // Entity, WorldObject traits
#[altv::main] // This is required
fn main() -> impl altv::IntoVoidResult {
altv::log!("~gl~hello world");
}
-
Now you can build your resource with
cargo build
-
In
target/debug/
you should see the.dll
or.so
you just compiled (if you don't see it, make sure you setlib.crate-type
to["cdylib"]
, see step 2) -
Create new alt:V resource, in
resources
directory of your server -
Copy compiled
.dll
or.so
to resource directory -
Create
resource.toml
with this content:
type = 'rs'
main = 'example.dll' # your compiled .dll or .so
-
Don't forget to add resource to
server.toml
-
Now you can download rust-module
.dll
or.so
from latest release or withcargo-altvup
-
Copy it to
modules
directory of your server (if you do not usecargo-altvup
) -
Add
rust-module
toserver.toml
like that:
modules = ['rust-module']
- Now if you have done everything correctly, you should see green "hello world" message in server console
Dependencies
~3–14MB
~179K SLoC