Skip to main content

Introduction

Alas! You've made it, and we've been expecting you. This is where you find all the useful information on how to use the Phynix framework. But - what's Phynix?

Phynix, previously known as Hypaste, was an incredibly successful roleplay community developed nearly three years around an entirely custom-built framework and codebase. After closing our doors, we have decided to release the hundreds of implementations and features that were provided to our community so that our passion, pride and commitment can live on. We believe that development is at the core of what makes the roleplay experience truly immersive and premium.

Our team has years of experience in the FiveM community, and we pledge to offer our packages at a competitive price with regular updates and support. The mission of the Phynix Project is to offer the best closed-source roleplay framework on the FiveM platform, leaps ahead of anything you've experienced before - QBCore, ESX or VRP. The thousands of hours dedicated into building our project means we can offer a complete multiplayer roleplay experience with all fundamental features and mechanics.

Getting Started

First things first, you will need a configured FXServer provided by the Cfx.re/FiveM team. Thankfully, FiveM already offers an amazing guide on how to setup a basic server. You can find out more here.

Base Framework

Below is a step-by-step guide on starting up the base framework. Please follow these steps carefully, as a small mistake can cause a headache! The package page includes a list of dependencies, these are free, open-source, and can be downloaded directly from their respective GitHub repositories.

You will have to ensure these resources so they run on startup. Make sure they are in your /resources directory. In the FXServer directory you will find a server.cfg file, add these lines along before any other resources are started:

ensure mysql-async
ensure PolyZone
ensure warmenu
What about the default FXServer resources?

The base Cfx.re resources are started by default, so you shouldn't need to ensure these!

Great! Now, you will need a MySQL or MariaDB database. For this example, we will use MySQL. You can download an installer from the official MySQL website, by clicking here. We recommend the MySQL 5.8 implementation, as the average query speed is much faster using mysql-async (a dependency you downloaded). Go through the installation process and take a note of your credentials!

Okay. All done? We now need to add a new variable to the server.cfg file, so that mysql-async can connect to your database. Let's take a look:

set mysql_connection_string "server=localhost;uid=[UID];password=[PWD];database=[DB];charset=utf8mb4_general_ci;connectTimeout=60000;acquireTimeout=60000;"

Make sure you replace [UID] with your database username, [PWD] with your password and [DB] with your database name. That's it! The database is all done.

Lastly, simply drag-and-drop the core resources you have purchased into the /resources directory, and ensure them - similarly to how we did the dependencies. Add these lines after the dependencies in your server.cfg file:

ensure phynix
ensure px_chars
ensure px_banking
ensure px_needs
ensure px_utils
ensure px_inventory
ensure px_hud
ensure px_scoreboard
ensure px_weapons
ensure px_time
ensure px_clothing
ensure px_barber

That's it - I promise. Now simply start your server and watch the magic unveil before you. Thank you for choosing Phynix.