Code Monkey home page Code Monkey logo

ue-gjapi-core's Introduction

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

ue-gjapi-core's People

Contributors

freezernick avatar dependabot[bot] avatar redcraft86 avatar realdlps avatar imgbotapp avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.