Installation

Requirements

FXServer with OneSync

ug-core declares /onesync as a dependency and refuses to start without it.

oxmysql

The only resource ug-core depends on. Start it before ug-core.

MySQL 8.0 or MariaDB 10.6+

Older servers abort boot with a clear message.

Lua 5.4

Every resource that imports UgCore MUST set lua54 'yes'.

Install

Download ug-core

Clone or download the repository into your resources folder:

cd resources/[ug]
git clone https://github.com/ugcore-project/ug-core.git

Configure server.cfg

Add the database connection, start oxmysql before ug-core, and let ug-core manage ACEs:

server.cfg

set mysql_connection_string "mysql://user:password@localhost:3306/ugcore"

ensure oxmysql
ensure ug-core

# Lets the permissions module apply grants as ACEs.
add_ace resource.ug-core command allow

# Lets admins use the `ug` console command in game.
add_ace group.admin ug.admin allow

Without add_ace resource.ug-core command allow, permission grants cannot be applied. ug-core reports it in red at boot.

Start the server

On the first start, ug-core prints its banner, generates every config file and creates its tables:

Server console

  _   _  ____    ____
 | | | |/ ___|  / ___|___  _ __ ___
 | | | | |  _  | |   / _ \| '__/ _ \
 | |_| | |_| | | |__| (_) | | |  __/
  \___/ \____|  \____\___/|_|  \___|

 ug-core v1.0.0 · LuaGLM 5.4 · OneSync on

[INFO] Config: generated config/core.lua.
[INFO] Config: generated config/modules.lua.
...
[INFO] Database: connected to MariaDB 10.11.6.
[INFO] Database: applied identity v1.0.0.
...
[INFO] ug-core v1.0.0 ready in 61 ms. 10 modules enabled.

Check it

Run these inspection commands from the server console:

ug modules
ug database
ug config core

See The ug console for every subcommand.

What happens on first boot

Config files are generated

Every missing config/<name>.lua is written with each option’s description, type, limits and default. ug-core never edits these files again. Delete one to restore its defaults.

Tables are created

Each enabled module applies its migrations in version order. Applied versions are tracked in ug_migrations.

Connections wait for Ready

Players who connect during boot see “The server is starting. Please wait.” until ug-core is ready, for at most 60 seconds.

If boot fails

ug-core collects every configuration and database error, prints them all, then stops cleanly:

[ERROR] config/core.lua: debug MUST be a boolean, got "yes"
[ERROR] Boot aborted: 1 error(s).
[INFO] Lifecycle: Stopping (3 ms)
[INFO] Lifecycle: Stopped (0 ms)

Fix the reported values and run restart ug-core. See Troubleshooting for common errors.

Next: build your first resource

Write a resource that uses UgCore in five minutes.

Getting started

For server owners

For developers

Concepts

Requirements

FXServer with OneSync

oxmysql

MySQL 8.0 or MariaDB 10.6+

Lua 5.4

Install

What happens on first boot

If boot fails

Next: build your first resource

​Requirements

FXServer with OneSync

oxmysql

MySQL 8.0 or MariaDB 10.6+

Lua 5.4

​Install

​What happens on first boot

​If boot fails

Next: build your first resource

Requirements

Install

What happens on first boot

If boot fails