/UltimateStarterKit

The Ultimate Starter Kit plugin to speed up development of Unreal Engine games

Primary LanguageC++The UnlicenseUnlicense

Ultimate Starter Kit

The Ultimate Starter Kit plugin to speed up development of Unreal Engine games

Requirements

The Ultimate Starter Kit plugin is only available for Unreal Engine 4.27 and newer. The plugin also depends on the following plugins:

  1. Niagara
  2. Enchanced Input

Installation

  1. Download the latest release from GitHub
  2. Navigate to C:\Program Files\Epic Games\UE_{VERSION}\Engine\Plugins
  3. Create a Marketplace folder if needed
  4. Extract the release and copy to the Marketplace folder
  5. Open Unreal Engine
  6. Click on Edit > Plugins
  7. Enable the plugin under the Built-in > Other category
  8. Restart Unreal Engine

Features

The Ultimate Starter Kit plugin comes with the following features:

  • Logger: A system used to easily log info to file and via on-screen messages
  • Save data management: A system used to easily save/load game data with support for multiple save slots
  • Input Indicators: A system used to easily detect different input devices and update the UI to display the correct indicators
  • Currency: A system that is used to easily manage different types of currency
  • Audio: A system used to manage the basic properties of audio files
  • Stats: A system used to easily manage character stats with an optional regenerate ability
  • 3D platformer character: Basic 3D platformer character and animation template
  • Menu system: A customizable menu system with support for controllers and complex menu layouts

Documentation

  • The full documentation is available here
  • The Markdown documentation is also included in the repo under the docs directory for offline use. Or checkout the docs branch for the full HTML documentation
  • Each release contains the full HTML documentation and a PDF for that specific version
  • Each function is fully documented in the C++ source code
  • The demo project contains an example of each system in Blueprints

Roadmap

I'm planning on expanding this plugin and adding a bunch of new features. This includes:

  • Settings system with save data integration
  • Inventory management
  • Basic dialogue system

Credits

Support

If you have any questions, feel free to contact me through Twitter or Mastodon. You can also send me an email at henryjooste95@gmail.com. The Discussions or Issues tab on GitHub can also be used to discuss problems/features or report any issues