Skip to content

Installing Nickel

Mod Installer (Recommended)
Manual

Log in to your Vyper Hosting panel.
Select your BeamMP server and click Mods.
Set the dropdown to Server and search for Nickel.
Click Install.
Restart your server from the Console tab.

Nickel will create its data directory at Resources/Server/Nickel/ on first run.

Download the latest Nickel release from github.com/boubouleuh/Nickel-BeamMP-Plugin. For the optional in-game GUI, also grab Nickel-Interface.
Upload the Nickel/ folder to Resources/Server/ via the Files tab or SFTP.
Restart the server.

Verifying Installation

After restarting, check the Console tab for:

[NICKEL] Thanks for using Nickel!
[NICKEL] Nickel version: 3.0.17-STABLE (dev)

If you see errors, confirm the file is in Resources/Server/ and not a subdirectory level deeper than expected.

File Structure After Install

DirectoryResources/
- DirectoryServer/
  - DirectoryNickel/
    Directorydatabase/
    …
    Directoryextensions/
    …
    main.lua
    NickelConfig.toml

NickelConfig.toml - plugin configuration (roles, whitelist, welcome message, Discord webhooks)
database/ - persistent player data, stored in SQLite or MySQL depending on your config

Initial Configuration

In your panel, go to Files → Resources → Server → Nickel.
Open NickelConfig.toml.
Adjust the settings for your server. The key sections for a first-time setup are:

Guest & Whitelist - guest controls whether players without an account can join. whitelist restricts the server to approved players only:
```
[conditions]
guest = false
whitelist = false
```
Join message - customise the message shown when a player connects:
```
[misc]
join_message = "[{Role}] {Player} joined the server"
```
Discord webhooks - paste webhook URLs to log chat, player joins/leaves, or vehicle events:
```
[discord]
chat_webhook = ""
player_webhook = ""
vehicle_webhook = ""
```
Save the file and restart the server.

Next Steps

Usage & Commands Whitelist management, player statistics, and all available commands.