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. Enhanced 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
• Settings: A full settings system including both the UI and save/load logic
• Dialogue System: A full dialogue system with support for different participants, choices and branches
• Inventory Management: Manage multiple inventories with save data integration
• 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
• Characters: Character controllers with lots of features
  • First and Third person characters
  • Shadow decals to make platforming easier
  • Double jumping
  • Variable jump height
  • Coyote time
  • Smooth crouching with crouch jumping
  • Stomping with stomp jumping
  • Leaning with procedural animations
• Weapons System: A customizable weapon system with support for recoil, multiple fire types, fire rates and projectile types
• Menu system: A customizable menu system with support for controllers and complex menu layouts
• Config Utils: Extract information from different config files
• Platform Utils: Easily detect different platform types and architectures
• Project Utils: Extract project information like name, description and version

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

Credits

• Generic Graph by jinyuliao
• Comic Helvetic Font by Alexander Pravdin
• Menu Sound Effects by Broumbroum
• Land & Jump Sound Effects by Felixyadomi
• Item Sound Effects by Scrampunk
• Slide Sound Effects by Aquafeniz
• Music by InAudio

Contribution Guidelines

If you would like to contribute to the Ultimate Starter Kit, please follow our Contribution Guidelines. These guidelines provide detailed information on how to create branches, make changes, test, document, commit, and open pull requests. We welcome contributions from the community and look forward to your valuable input.

Support

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