ue-gjapi-core
ue-gjapi-core copied to clipboard
GameJolt API Integration for Unreal Engine Blueprints
GameJolt API for Unreal Engine Blueprints & C++
This Unreal Engine plugin allows easy use of GameJolt's GameAPI.
Installation
Blueprint-only Project
- Download the Plugin from one of these sources
- Put the files in
YOUR_ENGINE_DIR/Engine/Plugins/Marketplace/GameJoltAPI
You may need to create theMarketplace
folder yourself - Start the Editor and enable the Plugin
C++ Project
- Grab the source by
- cloning the repository directly
- setting up a submodule
- or download the repository as a zip.
- Active the plugin by
- starting the Editor and using the UI
- adding the following lines to your
.uproject
file
"Plugins": [ { "Name": "GameJoltAPI", "Enabled": true } ]
- Recompile!
Usage
These examples will show you, how to get started using the plugin. For more in-depth examples, explore the documentation.
Introduction to Subsystems
The plugin implements a custom subsystem. You can find more information about subsystems here.
Blueprints
Before you can call any other node of the plugin, you have to call the "Initialize"-node. There you can set your game's id and private key.
C++
The plugin subsystem (see above) is called UGameJoltSubsystem
and is accessible from the GameInstance
#include "GameJoltSubsystem.h"
[...]
// To get started you have to call the `Setup` function of the subsystem
// to provide your game's id and private key.
GetGameInstance()->GetSubsystem<UGameJoltSubsystem>()->Setup(12345, "coolPrivateKey");
Then you can use the async-actions provided by the plugin to interact with GameJolt. For an API-Reference for the plugin please refer to the header files.
Contributing
Pull requests are welcome. =)
License
BSL-1.0 License