Natuna FiveM Framework

FiveM® TypeScript based framework with single resources handler system that runs on the JavaScript & NodeJS runtime.

© 2022 Natuna Framework by Runes. Runes and its associates are not affiliated with or endorsed by Rockstar North, Take-Two Interactive or other rightsholders. Any trademarks used belong to their respective owners.

Links:

1. Getting Started (Installing, Updating, FAQ, etc.)
2. Building Documentation (See how to build to framework)
3. Code Documentation (Functions, Variable, Classes, Interface, Type, etc.)
4. Contributing Guide
5. Discord Server (Need Help?)
6. Donation, Additional Informations (Feeling Generous?)

Summary

This project was created with the intention of enlivening the FiveM Javascript community. Most people use other frameworks like ESX or QB-Framework but most of them are written in LUA language, so because of that, I was interested in making something completely different from the community.

Before You Start, Read This

This framework is not created for people who do not understand programming languages. There are a few skill requirements including:

1. Command line usage
2. JavaScript/TypeScript
3. Understanding module bundlers (Webpack)
4. Node.JS Package Managers (e.g. npm / yarn)
5. Being confident in your learning / reach in order to understand how this framework is working
6. Know to not ask the developer(s) for support if the instructions were clearly stated in the documentation.
7. KNOW HOW TO RESPECT OTHER PEOPLE'S HARD WORK & TO NOT STEAL!

This framework is still far from perfect, so if you you could help me developing this framework, that would be great!

Features

Instead of the same thing all over and over again, we aim to give you something different by providing this framework, such as:

1. Single Handler System Based

With Natuna, all ticks, event, variables are handled with this framework itself.

2. Typescript is Better

1. IntelliSense Ready
   Learn more about VSCode IntelliSense on Here.

   

2. JSDoc Ready
   Learn more about JSDoc.

   

3. Safety Checks
   Learn more about why should we use TypeScript.

   

3. Wrapper

1. Database Wrapper
   You don't need to write old traditional query language to do get or update things on your database.

   db.tableName.create({
       data: {
           column_1:  value_1,
           column_2:  value_2,
           column_3:  value_3
       }
   })
   

2. Command Wrapper
   You may registering command using RegisterCommand FiveM native, but for us, that is boring.

   registerCommand(
       // Name
       'hello',
       // Handler
       (src, args) => {
           return  console.log('Hello!');
       },
       // Configuration
       {
           description:  "Say Hello"
       }
   });
   

3. Multi NUI Wrapper
   Wanted to use multi NUI system? NOT A PROBLEM! This framework also contain it own built in NUI system so you don't need to create like 100+ resources for 100 NUI, instead, using 1 resources, this framework, would be enough to handle all of that.

4. Event Wrapper
   Natuna wrap all events to be handled on single event loop.

   

4. And Many Other Features In the Future!

Expect more from us in the future! We would give you something different and something more great above your expectation.

Interested with this framework?

Buckle up! Let's go to Installation Documentation to setup this framework on your server.

1. We're Fully Open Sourced!

You can be a part of our big journey in the future, please create and develop this framework by doing Fork and Pull Requests on this repository.

You can also contribute even if only by providing suggestions or reporting problems with this framework in the issues section of this repository, or in the support link listed in the help section.

See Our Contributing Guide

2. Need Help?

If you have tried your best in overcoming every problem but to no avail, don't hesitate to discuss with us at our Discord Server.

3. Feeling Generous?

This project is 100% free to use. Either you just wanted to use it or modified it, it's up to yourself. You don't even need license key, subscription or whatsoever that related to money.

If you want to help us, the core developers, in finance, or help the infrastructure of this project to cover monthly expenses and so on, you can become our donor via the link below:

• Ko-fi
• Paypal

Please understand that sponsors will receive special content from us as a token of our gratitude, however, we will continue to run this project as an open source project without any mandatory fees.