Get Started

This documentation guides you through setting up a server or getting started loading the core into your own resources for development.

Introduction

The TMC FiveM framework is a popular roleplay server framework for FiveM. It provides a fast, flexible, modular & optimised base for developing custom GTA RP servers.

Good to know: The TMC framework is inspired by QBCore. It's been built in such a way that conversion from QBCore to TMC is an easy process.

The TMC framework makes use of a feature called Kuzzle. You can find more about it here: Kuzzle. Make sure you have your Kuzzle instance created prior to creating your server. To save you hassle you can purchase a pre-made Kuzzle instance here: TMC Kuzzle Index.

Creating a server

Creating a TMC server is simple! Once you've purchased the framework from TMC's Tebex store you can get started.

1. Follow the CFX guide to setting up a server using txAdmin.

2. When choosing a template select "Remote URL Template" and enter: https://tmc.bj/recipe .

3. Follow the instructions and continue to set up your server.

4. You will be prompted to fill in additional variables for the template to use. Some helpful information can be found below:

   1. server_type : This tells the TMC framework what type of server you are running. This helps disable things such as hunger and thirst in the dev servers. Valid values are DEV & LIVE.

   2. kuzzle_host : This is the public host domain/IP of your Kuzzle server.

   3. kuzzle_port : This is the port you connect to the Kuzzle instance on. If you've proxied the Kuzzle instance this will be either 80 or 443 depending on your SSL status.

   4. kuzzle_ssl : This should be 1 or 0 to indicate if SSL should be enabled. We highly recommend setting up SSL for security.

   5. kuzzle_index : The Kuzzle index to connect to.

   6. kuzzle_key : The API Key used by the server to connect to Kuzzle. This should not be shared.

   7. kuzzle_playerProfile : The name of the profile created in Kuzzle that will be assigned to the player credentials in order to access Kuzzle data.

5. Once the server is up and running you'll need to download your tmc2-base asset from https://portal.cfx.re/ and extract it into your [resources] folder.

6. Restart the server and get started!

Make sure to let yarn run fully before restarting the server. It may take multiple restarts to get the server up and running between steps.

Loading the framework

The core object allows you access to all the helper functions TMC contains.

We recommend loading the TMC core object from within a "shared" script (one that is available to both your server and client scripts. I.e. a config.lua).

Lua

TMC = exports.core:getCoreObject()