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

Work is being done in this branch.
Will never be published or released because alt:V does not allow you to use custom client-side modules (.dll) in production

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 16.0.6, for example with winget you can do it using this command winget install LLVM.LLVM --version 16.0.6

[!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)

[!INFO] 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

1. Create new cargo package with cargo new altv-resource --lib

2. Configure cargo to compile your crate as cdylib in your Cargo.toml

[lib]
crate-type = ['cdylib']

3. After that you can install altv crate with: cargo add altv

4. 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");
}

5. Now you can build your resource with cargo build

6. In target/debug/ you should see the .dll or .so you just compiled (if you don't see it, make sure you set lib.crate-type to ["cdylib"], see step 2)

7. Create new alt:V resource, in resources directory of your server

8. Copy compiled .dll or .so to resource directory

9. Create resource.toml with this content:

type = 'rs'
main = 'example.dll' # your compiled .dll or .so

10. Don't forget to add resource to server.toml

11. Now you can download rust-module .dll or .so from latest release or with cargo-altvup

12. Copy it to modules directory of your server (if you do not use cargo-altvup)

13. Add rust-module to server.toml like that:

modules = ['rust-module']

14. Now if you have done everything correctly, you should see green "hello world" message in server console