GameBaseFramework

Overview

GameBaseFramework is a minimal framework built on top on UE's game framework to add quality of life improvements that apply toi any game.

Installation

You can download these sources directly and put them in your project's Plugins folder Or you can add the plugin as a submodule git submodule add [email protected]:FishingCactus/UEGameBaseFramework Plugins/GameBaseFramework

Dependencies

• OnlineSubsystem
• OnlineSubsystemUtils
• GameplayAbilities
• ModularGameplayActors
• CommonGame
• GameplayTagsExtensions
• ModularGameplay

Quick Start

Basic Setup

1. Enable the Plugin

   • Navigate to Edit → Plugins
   • Search for "GameBaseFramework" and check the enabled box
   • Restart the editor

2. Configure the project

   • Open Edit → Project Settings
   • Go the section Engine - General Settings
     • Change the Local Player Class to GBFLocalPlayer
     • Change the World Settings Class to GBFWorldSettings
   • Open your PlayerController blueprint
     • Change the Cheat Manager Class to GBFCheatManager
   • Change your GameMode blueprint parent class to AGBFGameMode
   • Open your GameMode blueprint
     • Change the Game State Class to GBFGameState
     • Change the Player Controller Class to GBFPlayerController
     • Change the Player State Class to GBFPlayerState
     • Change the Game Session Class to GBFGameSession

Documentation

Core Classes

AGBFGameMode

TODO

AGBFGameState

• This class owns a GameplayAbilitySystem you can use to activate abilities that should act on your worlds.
• It also has an instance of UGBFPlayerSpawningManagerComponent to help use the AGBFPlayerStart in your levels

AGBFPlayerController

TODO

AGBFPlayerState

TODO

AGBFWorldSettings

This class has a property GameplayTags that you can use to give tags to your worlds.

Editor

• Open Edit → Editor Preferences
• Go to the section Gamebase Framework
  • You can add maps in the property Common Editor Maps to display a dropdown in your editor for quick access to those maps.
  • You can also add Cheats to run on each Player Controller that is created by the game mode.

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

1. Fork this repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Clone to your UE project's Plugins folder
4. Make your changes and test thoroughly
5. Submit a pull request

Coding Standards

• Follow Unreal Engine Coding Standards
• Use clear, descriptive variable and function names
• Comment complex algorithms and public APIs

Support

Getting Help

• Documentation: Full documentation

Reporting Issues

Please report bugs and feature requests through GitHub Issues.

When reporting issues, please include:

• Unreal Engine version
• Plugin version
• Platform (Windows/Mac/Linux)
• Steps to reproduce
• Expected vs actual behavior
• Relevant log files

FAQ

Q: Can I use this in commercial projects? A: Yes! See the LICENSE file for details.

Q: How do I update the plugin? A: Download the new version and replace the plugin files, then recompile your project.

Changelog

See CHANGELOG.md for complete version history.

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with ❤️ for the Unreal Engine community

If this plugin helped you, consider giving it a ⭐ on GitHub!