A fully automated txAdmin recipe to install and run Hades Framework — a modern, full-featured FiveM server framework built to streamline roleplay server development.
This txAdmin recipe simplifies the process of deploying a Hades Framework-based FiveM server by:
- Cloning the latest version of the framework from GitHub.
- Setting up all required folder structures (
resources,configs, etc.). - Automatically importing the framework’s SQL schema into your database.
- Moving optional files like configuration templates and logos.
- Ensuring compatibility with txAdmin deployment validation.
This recipe is ideal for developers or server owners looking to get started with Hades Framework quickly, without needing to manually configure or move files.
- Open your txAdmin panel.
- Go to the Recipe Deployer tab.
- Use the following URL to deploy this recipe: https://raw.githubusercontent.com/HadesStudios/txAdminRecipe/main/hades-stable.yaml
- Follow the prompts to configure your database credentials and deployment options.
- After deployment:
- Ensure dependencies (MongoDB, MariaDB, Node.js, and pnpm) are installed
- Update your
server.cfg
- ✅ Automatic GitHub download of the latest Hades Framework
- ✅ Database setup and schema import
- ✅ Optional config templates included
- ✅ Resource folder validation for txAdmin
- ✅ Minimal manual configuration post-deployment
Hades Framework is a modern FiveM roleplay server framework written in TypeScript, Node.js, and Lua. It is designed to be modular, scalable, and developer-friendly, supporting key features like:
- Full support for TypeScript backends
- Built-in support for MariaDB and MongoDB
- Configuration-driven design for environments and resources
- Hot-reload capable development environment using
pnpmandvite
📘 More info and full documentation:
➡️ HadesStudios GitHub
To run the Hades Framework successfully after deployment, ensure you have the following installed:
- Node.js (latest LTS recommended)
- pnpm (
npm install -g pnpm) - MongoDB (running locally or remotely)
- MariaDB (or compatible MySQL DB)
Heads up!
If you encounter errors related to Fuel or Inventory systems when launching the server for the first time, don’t worry — this is normal.
🛠️ Solution:
Simply restart the server once, and the issues should be resolved automatically. These errors typically occur only during the very first launch due to initial resource registration or dependency order.
- You can customize
resources.cfgto match your server setup.
If you encounter any issues with the recipe or want to contribute improvements, feel free to open an issue or PR on the Hades txAdmin Recipe GitHub.
Happy deploying! 🚀