leonmrbonnie / framework Goto Github PK

This codebase provides a suite of tools and libraries to simplify the development of multi-player modifications and ensure consistency across all of them. The primary goal is to provide a common foundation and interface, in regards to shared functionality and data. It covers many fields we found important during the development of multi-player mods, such as:

• Networking: The core of the framework, it provides all the necessary tools to synchronize data between players.
• Scripting: The Node.js scripting layer provides an easy way to create and manage resources used on game servers. It also provides a common interface accross all multi-player mods, making it easy to create and manage shared resources between games.
• Logging: It is always important to log actions and errors, so the framework provides a simple way to do so.
• GUI: It also provides a simple way to create and manage GUI elements using the Chromium Embedded Framework library.
• Sentry: The framework provides a simple way to report errors and exceptions to the Sentry service.
• Firebase: It is used to easily store and retrieve data from the Firebase service. Including stats, player data, and more.
• Integrations: This layer is used to integrate with other services, such as Discord and Steam.
• Utils: It provides a collection of useful functions and classes that are used throughout the framework.

MafiaHub Services are NOT part of this project, but our framework provides a simple way to integrate them. Feel free to ask us for more information about this service, so we could provide the resources and a license to use it.

We're always looking for new contributors, so if you have any ideas or suggestions, please let us know and we'll see what we can do to make it better. You can either reach us at our Discord server MafiaHub, or by raising an issue on our repository.

If you're interested in development, please read our Contribution Guidelines.

We use CMake to build our projects, so you can use any of the supported build systems. We support Windows, Linux, and MacOS operating systems at the moment. You can follow this guide to get started:

# Clone the repo
git clone [email protected]:MafiaHub/Framework.git
cd Framework

# OPTIONAL: Generate project files
# NOT NECESSARY FOR CLION DEVS

# Configure CMake project
# On Windows (x86)
cmake -B build -A Win32
# On other platforms
cmake -B build

# Build framework
cmake --build build

# Run framework tests
cmake --build --target RunFrameworkTests

Multi-player modifications are cloned into the code/projects directory and automatically picked up by the framework. We use this approach so that we can easily manage the projects and their dependencies, perform mass changes and general maintenance during the development.

# Create and navigate to folder
mkdir -p code/projects
cd code/projects

# Clone a MP repo that uses the framework
git clone [email protected]:<your-awesome-username>/<your-amazing-project>.git

# e.g.
git clone [email protected]:MafiaHub/fw-sandbox.git

# Re-generate CMake project
cd ../..
cmake -B build

Now you can access your targets and build them within the framework.

The guide on how to set up the project files for CLion is available here.

The code is licensed under a modified BSD 5-Clause license.

The 5th clause was added to ensure that the work can focus primarily on this repository, as we provide an access to the framework and its services. This is important to ensure that the framework is not used for other purposes, such as the creation of other projects, that would diverge from the framework. This approach guarantees that the changes are directly made to the framework itself, having a healthy ecosystem in mind.