Skip to content

Installation

Setting up EEnE Rewards on your server is quick and easy. Follow the steps below to get started.


1. Add the Resource

Place the eee-rewards folder inside your server's resources directory.


2. Import the Database Tables

Use the SQL file provided to set up the required tables.

Path:

bash
eee-rewards/database/db-sql.sql

You can import this file using tools like phpMyAdmin, HeidiSQL, or the command line.

SQL Preview (for reference):

sql
CREATE TABLE `eee_user_achievements` (
  `id` int(11) NOT NULL,
  `identifier` varchar(255) NOT NULL,
  `achievement_name` varchar(255) NOT NULL,
  `is_completed` tinyint(1) DEFAULT 0,
  `is_claimed` tinyint(1) NOT NULL DEFAULT 0
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;

CREATE TABLE `eee_user_achievement_steps` (
  `id` int(11) NOT NULL,
  `identifier` varchar(255) NOT NULL,
  `user_achievement_id` int(11) NOT NULL,
  `achievement_name` varchar(255) NOT NULL,
  `step_id` int(11) NOT NULL,
  `count_progress` int(11) DEFAULT 0,
  `is_completed` tinyint(1) DEFAULT 0,
  `is_claimed` tinyint(1) DEFAULT 0
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;

ALTER TABLE `eee_user_achievements`
  ADD PRIMARY KEY (`id`),
  ADD UNIQUE KEY `unique_achievement` (`identifier`,`achievement_name`),
  ADD KEY `idx_achievement_name` (`achievement_name`);

ALTER TABLE `eee_user_achievement_steps`
  ADD PRIMARY KEY (`id`),
  ADD KEY `user_achievement_id` (`user_achievement_id`);

ALTER TABLE `eee_user_achievements`
  MODIFY `id` int(11) NOT NULL AUTO_INCREMENT;

ALTER TABLE `eee_user_achievement_steps`
  MODIFY `id` int(11) NOT NULL AUTO_INCREMENT;

ALTER TABLE `eee_user_achievement_steps`
  ADD CONSTRAINT `eee_user_achievement_steps_ibfk_1` FOREIGN KEY (`user_achievement_id`) REFERENCES `eee_user_achievements` (`id`) ON DELETE CASCADE;

COMMIT;

3. Start the Resource

Make sure to add the following line to your server.cfg, after ox_lib and es_extended:

cfg
ensure eee-rewards

⚠️ Required dependencies: ox_lib and es_extended

✅ Done!

Your system is now ready to use.