Getting Started

Installation

Requirements

  • FiveM Server

  • OneSync Enabled (recommended)

Standard Installation

  1. Download the latest release from our GitHub repository

  2. Extract the b2-sleeknotify folder to your server's resources directory

  3. Add the following to your server.cfg:

    ensure b2-sleeknotify

  4. Restart your server

Development Installation

  1. Clone the repository:

    git clone https://github.com/B2DevUK/b2-sleeknotify.git

  2. Navigate to the UI directory:

    cd b2-sleeknotify/ui

  3. Install dependencies:

    npm install

  4. Build the UI:

    npm run build

  5. Ensure the resource in your server.cfg

Verifying Installation

Run the test command in-game to verify the installation:

/testnotif

You should see a test notification appear on your screen.

PreviousIntroductionNextFeatures

Last updated