Installation - JRS Core

Voraussetzungen#

RedM-Server (neueste Artifacts) mit txAdmin
MariaDB- oder MySQL-Datenbank
Server-Key von portal.cfx.re
OneSync aktiviert

docs.fivem.net - the official step by step guide to install txAdmin and create a server.

txAdmin öffnen und Remote URL Template wählen.
Den Recipe-Link einfügen:

text

https://raw.githubusercontent.com/NQ3Z/jrscore/main/recipe/jrscore.yaml

txAdmin lädt die Skripte, legt die Datenbank an und schreibt server.cfg.
Server starten.

INSTALL.bat ausführen.
Serverordner, MySQL-Daten und Server-Key eingeben.
Der Installer kopiert die Skripte, legt die Datenbank an und schreibt server.cfg.
In txAdmin den Server Data Folder auf diesen Ordner setzen und OneSync aktivieren.

Den Ordner resources in den Serverordner kopieren.
sql/jrscore.sql in eine leere Datenbank importieren.
server.cfg kopieren und die Werte in {{ }} anpassen.

Datenbank (XAMPP, HeidiSQL oder ohne XAMPP)#

JRS Core speichert Charaktere, Items und Geld in einer MariaDB / MySQL-Datenbank. Wähle einen Weg sie zu starten, importiere sql/jrscore.sql und setze den Verbindungsstring.

Download and install XAMPP. It includes MariaDB.
Open the XAMPP Control Panel and press Start next to MySQL. Apache is not needed.
Download and install HeidiSQL, the program used to manage the database.
In HeidiSQL press New, set Network type to MariaDB or MySQL (TCP/IP), host 127.0.0.1, user root, port 3306, and press Open.
Right click the empty left panel, Create new > Database, name it jrscore and use the collation utf8mb4_general_ci.
Select jrscore, choose File > Run SQL file... and pick sql/jrscore.sql.

Warning

XAMPP starts with the user root and no password. That is fine on your own PC. On a public server create a dedicated user with a password (see the SQL below) and never open port 3306 to the internet.

Install one database server: MariaDB Server (recommended) or MySQL Community Server. Write down the root password you choose.
Create the database and a user. Open HeidiSQL or the command line and run:

sql

CREATE DATABASE jrscore CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;
CREATE USER 'jrs'@'localhost' IDENTIFIED BY 'change_this_password';
CREATE USER 'jrs'@'127.0.0.1' IDENTIFIED BY 'change_this_password';
GRANT ALL PRIVILEGES ON jrscore.* TO 'jrs'@'localhost';
GRANT ALL PRIVILEGES ON jrscore.* TO 'jrs'@'127.0.0.1';
FLUSH PRIVILEGES;

Import the tables:

bash

mariadb -u jrs -p jrscore < sql/jrscore.sql

(with MySQL the program is called mysql). Or use HeidiSQL: File > Run SQL file.... 4. Manage it with HeidiSQL or DBeaver (works on Windows, Linux and macOS).

Install Laragon (the Full version has MySQL). It is a lighter alternative to XAMPP.
Press Start All. MySQL listens on 127.0.0.1:3306, user root, no password.
Create the database jrscore and import sql/jrscore.sql with HeidiSQL (Laragon has a Database button that opens it).

Install Docker, then start a MariaDB container:

bash

docker run -d --name jrs-db --restart unless-stopped \
  -e MARIADB_ROOT_PASSWORD=change_this_password \
  -e MARIADB_DATABASE=jrscore \
  -p 127.0.0.1:3306:3306 \
  -v jrs-db:/var/lib/mysql \
  mariadb:11

Import the tables (works in any shell):

bash

docker cp sql/jrscore.sql jrs-db:/jrscore.sql
docker exec jrs-db sh -c "mariadb -uroot -pchange_this_password jrscore < /jrscore.sql"

The image page: hub.docker.com/_/mariadb. The 127.0.0.1: in -p keeps the database private to the machine.

Any MariaDB or MySQL host that your game server can reach works (a managed database, or a database on another VPS).

Create a database jrscore and a user for it in the provider panel.
Allow the IP address of your game server only.
Import sql/jrscore.sql with HeidiSQL connected to that host.
Use the host name in the connection string below instead of 127.0.0.1.

Then tell the server how to connect. Put this line in server.cfg above ensure oxmysql:

cfg

set mysql_connection_string "mysql://jrs:[email protected]:3306/jrscore?charset=utf8mb4"

With XAMPP and the root user without password it is mysql://[email protected]:3306/jrscore?charset=utf8mb4. If the password has special characters (@, :, /, #) replace them with their percent code (@ = %40) or choose a simpler password.

Tip

To check the connection start the server and look for [oxmysql] Database server connection established in the console. Not there? Check that MySQL is running, the port is 3306 and the database name is exact.

Owner werden#

Trage deine Steam-ID in Config.CoreOwners (jrs_core/config/config.lua) ein:

lua

Config.CoreOwners = {
    ['steam:110000xxxxxxxxx'] = true,
}

Oder setze group auf owner oder admin in der Tabelle jrs_users.

Ladereihenfolge#

cfg

ensure oxmysql
ensure jrs_core
ensure jrs_inventory
ensure jrs_character

Die mitgelieferte server.cfg hat bereits die richtige Reihenfolge.

Warning

Keine #-Kommentare am Ende einer ensure-Zeile und fxmanifest.lua als UTF-8 ohne BOM speichern.