https://github.com/tfnrp/framework

PMARP's own framework
https://github.com/tfnrp/framework

fivem fivem-roleplay framework

Last synced: about 1 year ago
JSON representation

PMARP's own framework

• Host: GitHub
• URL: https://github.com/tfnrp/framework
• Owner: TFNRP
• License: apache-2.0
• Created: 2021-09-09T10:02:39.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-12-25T22:50:21.000Z (over 4 years ago)
• Last Synced: 2024-05-01T11:24:19.292Z (almost 2 years ago)
• Topics: fivem, fivem-roleplay, framework
• Language: Lua
• Homepage:
• Size: 235 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
TFNRP Framework












## Table of Contents

- [About](#about)

- [Documentation](#documentation)

  - [Server Convars](#server-convars)

  - [Server Commands](#server-commands)

## About

The framework used by and created for TFNRP

## Documentation

### Server Convars

Server convars which can be used with the framework in order convar usage and convar description.  

You can set a convar with `set some_convar`. Client replication (`setr`) not needed unless specified.

`set reminders_interval `: The interval between each reminder, in minutes. Default: `5`  

`set reminders_prefix `: The reminder's prefix. Default: `'^3^*[System]'`  

`set framework_ServerNotifications_chatPublic `: A Discord webhook to be used with the `chatPublic` notification.  

`set framework_ServerNotifications_chatPrivate `: A Discord webhook to be used with the `chatPrivate` notification.  

`set framework_ServerNotifications_staffPublic `: A Discord webhook to be used with the `staffPublic` notification.  

`set framework_ServerNotifications_staffPrivate `: A Discord webhook to be used with the `staffPrivate` notification.  

`set framework_ServerNotifications_serverPublic `: A Discord webhook to be used with the `serverPublic` notification.  

`set framework_ServerNotifications_serverPrivate `: A Discord webhook to be used with the `serverPrivate` notification.  

### Server Commands

Commands which are used in `server.cfg`, i.e. `add_ace`.  

Not to be confused with in-game commands, but they *can* also be used in-game.  

`reminders_add `: Adds a reminder, can be used instead of editing them via `config.lua`.  

`reminders_remove [integer]`: Removes the last reminder. Can also supply the number of the reminder.