tes3mp-plugin

Crates.iotes3mp-plugin
lib.rstes3mp-plugin
version0.1.2
sourcesrc
created_at2020-02-25 17:39:03.682274
updated_at2020-02-25 22:55:58.97842
descriptionStubs for creating a TES3MP server plugin
homepagehttps://git.cijber.net/teamnwah/tes3mp-rs
repository
max_upload_size
id212478
size334,840
eater (the-eater)

documentation

README

tes3mp-plugin

A crate for helping you make tes3mp plugins in Rust

How to use

Because Rust won't allow you to re-export symbols from other crates, this crate can't be used like normal crates, the advised manner of using this crate is the following:

cd crate-dir
git status || git init
mkdir extern
git submodule add https://git.cijber.net/teamnwah/tes3mp-rs.git extern/tes3mp-rs
ln -s ../extern/tes3mp-rs/tes3mp-plugin/src/plugin src/plugin

This will make the plugin like it's part of your crate, which allows us to export the C symbols

in your Cargo.toml make sure the following is included

[lib]
crate-type = ["staticlib", "cdylib"]

This will make sure you get a shared library which can be loaded by TES3MP

Using the code is now rather simple, write in your lib.rs

use crate::plugin::Events;

mod plugin;

struct Server;

impl Events for Server {
    fn new() -> Self {
        Server
    }

    fn on_server_init(&self) {
        plugin::log_message(plugin::LOG_WARN, "Hello from Rust :3");
    }
}

use_events!(Server);

the Events trait has all the events that exist for the server, implement as needed

Commit count: 0

cargo fmt