Installation

Step-by-step guide to install the Rust language module and set up the necessary environment to start using it.

The Rust Language Module can be installed in two ways: manually downloading the release or using the Plugify package manager. This guide explains both methods and provides step-by-step instructions.

Method 1: Manual Installation

Download the Release

  1. Go to the Rust Language Module repository.
  2. Navigate to the Releases section.
  3. Download the archive for your platform: plugify-module-rust-<version>-linux_64.tar.bz2, win_64 or osx_arm64.

Extract the Package

  1. Create a new folder inside addons/plugify/envs, for example envs/rust.
  2. Extract the archive into it. The manifest plugify-module-rust.pmodule must end up in the root of that folder.

Verify Installation

  1. Run plg load in the server console, or restart the server.
  2. Run plg modules: the module is listed as rust_module.

Method 2: Installation via Package Manager

Open the Server Console

The mamba command is built into the server console, so nothing has to be installed first. Package operations run while Plugify is unloaded: plg unload before them and plg load after. See Commands.

Install the Module

  1. Run the following commands in the server console: 
    plg unload
mamba install -n modules -c "https://untrustedmodders.github.io/plugify-module-rust/" plugify-module-rust
plg load
    Enter the commands one at a time, as described in Commands.

Verify Installation

  1. Run plg modules: the module is listed as rust_module.

Folder Structure

After installation, the Rust Language Module should have the following folder structure:

Explanation

  • addons/plugify/envs/modules: The root folder for the Rust Language Module.
  • bin: Contains the compiled module binaries (.dll for Windows, .so for Linux, etc.).
  • plugify-module-rust.pmodule: The module manifest file that describes the module and its language.

Prerequisites

Before using the Rust Language Module, ensure you have the following installed:

Rust Toolchain

The Rust Language Module requires the Rust compiler and Cargo (Rust's package manager).

Install Rust

  1. Visit https://rustup.rs/
  2. Follow the instructions to install rustup, the Rust toolchain installer
  3. Verify installation: 
    rustc --version
cargo --version

Install Required Targets (Optional)

For cross-platform development, you may need to install additional targets:

# For Windows
rustup target add x86_64-pc-windows-msvc

# For Linux
rustup target add x86_64-unknown-linux-gnu

# For macOS
rustup target add x86_64-apple-darwin

Troubleshooting

Module Not Found

  • Ensure the repository URL is correct and accessible.
  • Verify that the module files are placed in the correct envs folder.

Installation Fails

  • Check your internet connection.
  • Ensure you have the latest version of Plugify installed.

Rust Toolchain Not Found

  • Make sure Rust is properly installed and available in your system PATH.
  • Try restarting your terminal or IDE after installing Rust.
Edit this page on GitHub
Quick start
Quick start with Rust language module.
First Plugin
Learn how to create your first plugin with the Rust language module, including basic syntax and setup.