Skip to main content

TPNRP Core Documentation

Welcome to the TPNRP Core documentation! TPNRP Core is a comprehensive roleplay framework for FiveM built on top of Helix.

What is TPNRP Core?​

TPNRP Core is a modular FiveM resource that provides essential functionality for roleplay servers. It includes:

  • Player Management: Complete player entity system with client and server-side components
  • Inventory System: Weight-based inventory management with slots
  • Equipment System: Clothing and equipment management
  • Data Access Layer: Database abstraction layer with DAO pattern
  • Shared Utilities: Common utilities and configuration shared between client and server

Features​

  • ✅ Client-Server Architecture
  • ✅ Entity-Based Design
  • ✅ Database Integration
  • ✅ TypeScript-style Type Annotations (Lua)
  • ✅ Export System for Resource Integration
  • ✅ Modular Structure

Architecture Overview​

TPNRP Core follows a clean architecture pattern:

tpnrp-core/
├── client/          # Client-side entities and logic
├── server/          # Server-side entities, services, and types
└── shared/          # Shared configuration and utilities

Getting Started​

To get started with TPNRP Core, check out the Installation Guide.

Resources​