Skip to content

freezernick/ue-gjapi-core

Repository files navigation

GameJolt API for Unreal Engine Blueprints & C++

This Unreal Engine plugin allows easy use of GameJolt's GameAPI.

Installation

Blueprint-only Project

  1. Download the Plugin from one of these sources
  2. Put the files in YOUR_ENGINE_DIR/Engine/Plugins/Marketplace/GameJoltAPI
    You may need to create the Marketplace folder yourself
  3. Start the Editor and enable the Plugin

C++ Project

  1. Grab the source by
    • cloning the repository directly
    • setting up a submodule
    • or download the repository as a zip.
  2. Active the plugin by
    • starting the Editor and using the UI
    • adding the following lines to your .uproject file
    "Plugins": [
        {
             "Name": "GameJoltAPI",
             "Enabled": true
        }
    ]
  3. 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.

Unreal Engine Blueprint Graph

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

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy