keystone
A lightweight, modular framework core, designed for efficiency, scalability, and customization.
The core is still in early BETA stages, some bugs are to be expected.
🌍 Overview
Keystone is a comprehensive and adaptable server framework for FiveM. Originally developed as boii_core for a personal server however, as it developed, it began consuming more time than anticipated, diverting attention from other work. Due to this the decision was made to transition it into a open-source project.
It's important to clarify that Keystone was not developed to compete with established "roleplay frameworks." Instead, it's designed to be modular and flexible, easily adaptable not just for roleplay but also for survival, racing, or any other type of server with minimal tweaks.
The focus here isn't on packing in every possible feature; it's about creating something enjoyable and sharing it with the community.
🌐 Features
Player Management: Class-based player objects with a wide range of useful functions.
Integrated Resources: Includes a built-in loading screen, HUD, multi-character system, character customization, and grid-based inventory.
UI Builder: A simple and flexible tool for creating uniform UIs, both internally and externally.
Player Roles: Uses a role-based system instead of jobs or groups, with role types allowing for broader functionality.
Usable Items: Built-in support for consumables, weapons, and more, with integrated animations, props, and interaction handling.
Status System: A complete system for tracking player flags, effects, and injuries.
Grid Based Inventory: A fully integrated grid-based inventory system with hover tooltips and keypress actions for item interactions.
Additional Systems: Integrated with
fivem_utils, our open-source library, providing access to additional features such as player skills and reputation.
Some additional feature details to follow:
Player Classes
Keystone uses the following player object classes:
Player: Handles core player functions, e.g.,
save_player,get_player_data,set_player_data.Accounts: Handles player account functions, e.g.,
add_money,remove_money,get_account.Effects: Handles player effect functions, e.g.,
get_effects,set_effects,clear_effects.Flags: Handles player flag functions, e.g.,
get_flag,set_flag,reset_flags.Identity: Handles player identity functions, e.g.,
get_identifier,get_full_name,change_name.Injuries: Handles player injury functions, e.g.,
get_injuries,set_injury,clear_injury.Inventory: Handles player inventory functions, e.g.,
get_inventory,add_item,remove_item.Roles: Handles player role functions, e.g.,
get_role,has_role,add_role,remove_role.Spawns: Handles player spawn functions, e.g.,
get_spawns,set_spawn,clear_spawns.Statuses: Handles player status functions, e.g.,
get_status,set_status,reset_statuses.Styles: Handles player customization functions, e.g.,
get_styles,set_style,add_outfit,remove_outfit.
Modules
Modules extend player classes:
Characters: Handles character functions, e.g.,
get_characters,create_character,delete_character.Accounts: Handles additional accounts functions, e.g.,
log_transaction.Player: Handles additional player functions, e.g.,
save_all_players.
UI Builder
The UI Builder allows for easy creation of user interfaces across the server. It can be used interally or externally to create a variety of different UI's, this has been showcased in a few places throughout the core. The intention here is to try and keep everything uniform.
What you can do with it:
UI Elements: Create cards, tables, lists, and input groups. Customize the element layouts, content, and actions.
Header: Divided into three sections—left for server/player data, center for navigation tabs, and right for displaying information like cash or ID.
Footer: Footer holds a key container lower right that can be used for key press actions e.g, disconnect, exit.
Inventory: Use a grid-based inventory system, complete with item images, descriptions, and interactive tooltips.
Cards: Use cards for displaying items with details on hover, providing information and action options.
Tables: Display structured data clearly with headers and multiple rows.
Lists: Display items in a straightforward list format.
Input Groups: Collect input through fields grouped by type, with customizable labels and settings.
The cores multi-character, clothing, and inventory have all been created through the builder.
Inventory
The core includes a full grid-based inventory system, designed for flexibility and ease of use.
Grid Layout: Items are placed in a grid based style to create a inventory management system.
Hover Tooltips: Displays item details when hovered over.
Keypress Actions: Items can be interacted with using configurable key presses on hover.
Item Metadata: Supports item quality, rarity, and additional custom data.
Drag & Drop Support: Allows item movement within the inventory or between inventories.
Split & Stack Items: Split stacks or merge them as needed.
Weight System: Items contribute to a total inventory weight..
Multi-Inventory Support: Handles multiple inventories, such as player, vehicle, or stash storage.
🚀 Why Choose Keystone?
Structured & Scalable: Uses a class-oriented approach to keep code organized and easy to expand.
Lightweight: Designed with a simple and easy-to-use API, featuring full export support.
Uniform UI System: The built-in UI builder ensures a consistent design across all core elements.
Customizable: Ideal for those wanting to "do their own thing" instead of relying on widely adopted frameworks.
Final Thoughts
If you’re looking for a fresh alternative to mainstream frameworks or want a lightweight, modular foundation for your server, Keystone is worth exploring. It’s not for everyone, but it offers a different approach for those ready to experiment.
💹 Dependencies
📝 Notes
This is currently in beta, so features and functionality may change as development progresses.
While it’s open for use, it’s recommended to test thoroughly before deploying on live servers.
As the core is actively developed, some parts of the documentation might be outdated or incomplete. Always refer to the latest code for accuracy.
🤝 Contributions
This project is open source, and contributions are welcome! Whether it’s submitting a pull request, reporting issues, or sharing ideas for improvements, your input is valued.
If contributing, ensure your code is clean, well-documented, and aligns with the project’s style..
📩 Support
Last updated