DISCLAIMER
Nothing in this is completely set in stone. I am a solo developer on this project and still working on this project on my free time. Just wanted to setup more of a preview and have a place to put updates to get eyes on and get some opinions etc.
What is STAX?
I have been working on STAX for a long long time. Through multiple iterations of designs and structures and even overall end goals for what it could be used for. I have went through iterations of direct “Roleplay Framework” to “Zombie Framework” etc etc etc… until I finally came to the conclusion why couldn’t it be used for any of those through a plugin based framework that can handle any of those types of servers.
I have been working on a lot of different things built into the core framework specifically to honestly just make working with the game itself and the framework a lot easier.
Features
STAX is still in a pretty early development aside from the fact its been in development a long time mainly because of it being reiterated and rebuilt many times due to massive design flaws on my part.
Some of its core features will include
- Plugin System
- Scoped config system to plugins
- Scoped localization system to plugin
- Database migrations
- Uses a managers / singletons / class design
- Uses Lua Language Server for code intellisense as well with a FiveM LLS package that implements CFX natives and some custom packages to support promises / msgpack / json / fxmanifest definitons / event handlers / convars / citizen methods / http methods / etc.
Future Features
I plan to keep the core framework as core as I possibly can and create plugins that will at the ened be able to be used to create the servers everyone enjoys.
- Character System
- Inventory System
- Honestly any plugin that could make up a gamemode style server!
I recommend if you would like to see everything as far as base features I am going for check out the github repository as STAX will be completely open source and open to any eyes that would like to check it out.
The organization github
Organization
I would love to answer any questions yall have because honestly I plan for this to support so much. Basically plan to wrap a lot of core systems to make things easier (such as discord and mumble) and a lot of other systems that could help make development just overall easier and quicker.
an example of that would be instea of writing discord webhook http requests to send webhooks you could use STAX’s API to handle the http request and all you have to do is call the methods
FXMANIFEST
server_script { "@stax_core/libs/server/classes/singletons/discordmanager.lua" }
USAGE
local DiscordManager = Stax.DiscordManager()
DiscordManager.SendMessage("your_config_key_channel", "your_custom_message")
DiscordManager.SendEmbed("your_config_key_channel, { "embed_data" }[])
local roles = DiscordManager.GetRoles("user_discord_id")
and honestly that is just the tip of the ice berg as far as usage and systems… That is just one example of a system I have wrapped and people like. Thats not even showing classes / and manager usage.
I did start working on the documentation however. Not a whole lot is on here at the moment but a couple pages have been documented (such as Input’s and Cameras) but you can check those pages out to see kinda how the documentation is going to be and can even see all the pages of systems and classes I have NOT even documented yet…
Honestly I could go on and on and on this post demonstrating more usage and all of that but its honestly just best to leave links to code and future documentation cause as a solo dev there is just too much to talk about at the moment.
Just wanted to kinda put out my current project and see if anyone had any comments or questions. I will do my best to answer anything the best I can. I do work a fulltime job outside of this project so its a slow process but 
I do my best 