Installation -
Rust Oxide Plugin

Install and configure the Nexus Donate plugin for Rust servers

Overview

The Nexus Donate Rust Oxide plugin allows your server to communicate with your donation store and execute commands when players make purchases.

Prerequisites

  • Rust server with Oxide/uMod installed
  • Server with internet access
  • Nexus Donate API key

1. Extracting the plugin

  1. Download the latest Nexus Donate Rust Oxide plugin
  2. Extract the plugin file to your server's oxide/plugins/ directory
  3. The plugin file should be named NexusDonate.cs
  4. Ensure Oxide/uMod is properly installed and running

2. Upload to your server and configure

After uploading the plugin, configure it by editing the oxide/config/NexusDonate.json file:

Code
{

  "APIKey": "your_api_key_here",

  "StoreURL": "https://yourstore.com",

  "CheckInterval": 30,

  "Debug": false,

  "ServerName": "Your Server Name",

  "ServerIP": "your.server.ip",

  "ServerPort": 28015

}

Configuration Options

  • APIKey: Your Nexus Donate API key from the web panel
  • StoreURL: The URL of your Nexus Donate store
  • CheckInterval: How often the plugin checks for new donations (in seconds)
  • Debug: Enable debug messages in console
  • ServerName: Your server's display name
  • ServerIP: Your server's IP address
  • ServerPort: Your server's port number

3. Restart your server

  1. Restart your Rust server to load the plugin
  2. Check the server console for "Nexus Donate loaded successfully" message
  3. Look for any error messages related to the plugin
  4. Verify the plugin appears in your server's plugin list

Verification

To verify the installation is working:

  1. Check the server console for successful plugin loading
  2. Use the command oxide.plugins to see if Nexus Donate is listed
  3. Test the connection by making a test donation
  4. Check that commands execute properly when donations are processed

Commands

The plugin provides the following commands:

  • oxide.reload NexusDonate - Reload the plugin configuration
  • nexusdonate.status - Check the plugin status and connection
  • nexusdonate.test - Test the API connection

Permissions

The plugin uses the following permissions:

  • nexusdonate.admin - Access to admin commands
  • nexusdonate.status - Access to status commands

Troubleshooting

Common issues and solutions:

  • Plugin not loading: Check if Oxide/uMod is properly installed
  • API connection failed: Verify your API key and store URL
  • No donations detected: Check the check interval and server connectivity
  • Commands not executing: Verify the command syntax and player permissions
Note: Make sure your server has internet access to communicate with the Nexus Donate API.