JRS COREドキュメント
はじめに

インストール

RedM サーバーに JRS Core をインストール

必要なもの#

  • txAdmin 付き RedM サーバー(最新 artifacts)
  • MariaDB または MySQL データベース
  • portal.cfx.re のサーバーキー
  • OneSync を有効化

txAdmin setup guide

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

  1. txAdmin を開き Remote URL Template を選びます。
  2. レシピのリンクを貼り付けます:
text
https://raw.githubusercontent.com/NQ3Z/jrscore/main/recipe/jrscore.yaml
  1. txAdmin がスクリプトをダウンロードし、DB を作成し、server.cfg を書き込みます。
  2. サーバーを起動します。
  1. INSTALL.bat を実行します。
  2. サーバーフォルダ、MySQL 情報、サーバーキーを入力します。
  3. インストーラーがスクリプトをコピーし、DB を作成し、server.cfg を書き込みます。
  4. txAdmin で Server Data Folder をそのフォルダにし、OneSync を有効にします。
  1. resources フォルダをサーバーにコピーします。
  2. sql/jrscore.sql を空のデータベースにインポートします。
  3. server.cfg をコピーし {{ }} の値を編集します。

データベース(XAMPP、HeidiSQL、または XAMPP なし)#

JRS Core はキャラクター、アイテム、お金を MariaDB / MySQL に保存します。起動方法をひとつ選び、sql/jrscore.sql をインポートして接続文字列を設定します。

  1. Download and install XAMPP. It includes MariaDB.
  2. Open the XAMPP Control Panel and press Start next to MySQL. Apache is not needed.
  3. Download and install HeidiSQL, the program used to manage the database.
  4. 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.
  5. Right click the empty left panel, Create new > Database, name it jrscore and use the collation utf8mb4_general_ci.
  6. 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.

  1. Install one database server: MariaDB Server (recommended) or MySQL Community Server. Write down the root password you choose.
  2. 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;
  1. 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).

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

  1. Create a database jrscore and a user for it in the provider panel.
  2. Allow the IP address of your game server only.
  3. Import sql/jrscore.sql with HeidiSQL connected to that host.
  4. 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:change_this_password@127.0.0.1:3306/jrscore?charset=utf8mb4"

With XAMPP and the root user without password it is mysql://root@127.0.0.1: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.

自分をオーナーにする#

jrs_core/config/config.lua の Config.CoreOwners に Steam を追加:

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

または jrs_users テーブルの group を owner か admin にします。

読み込み順#

cfg
ensure oxmysql
ensure jrs_core
ensure jrs_inventory
ensure jrs_character

付属の server.cfg はすでに正しい順序です。

Warning

ensure 行の末尾に # コメントを付けないでください。fxmanifest.lua は BOM なし UTF-8 で保存します。

JRS Core · 無料のオープンソース RedM フレームワーク · JRS TEAM 制作