/arcweave-unreal-plugin

Official plugin for Unreal

Primary LanguageC++MIT LicenseMIT

Arcweave Plugin for Unreal Engine

IMAGE ALT TEXT HERE

This is the official README file for the Arcweave plugin repository, which facilitates the import of Arcweave projects into Unreal Engine (version 5.0 and later). The plugin can import data from an exported Arcweave's JSON fine (available to all Arcweave users) or it can directly utilize Arcweave's web API to fetch data, a feature available to Arcweave Team account owners. You can watch a full video tutorial series on how to install and use the plugin.

Plugin Installation

To install the Arcweave Plugin for Unreal Engine, follow these steps:

  1. Download the plugin from this repository.
  2. Copy the plugin (the downloaded .zip file) into the ProjectRootDirectory/Plugins folder. If this folder does not exist please create it.
  3. Open your project.
  4. If prompted to rebuild the Arcweave plugin, click Yes.

Data Collection Methods

There are two primary methods for collecting Arcweave project data:

JSON Import:

For this method, you'll need to do the following:

  • Export you Arcweave project for Unreal Engine and unzip it.
  • Move the exported JSON file along with all required assets in the Content->ArcweaveExport directory. If this directory does not exist create it.

Web API:

This involves fetching data directly from the Arcweave Web API within Unreal Engine. You will need:

  • Your Arcweave API key and your project's hash (Refer to the Arcweave Documentation for more info on how to find these).
  • Navigate to Project Settings -> Plugins -> Arcweave. Here, you can input your APIToken and the project hash obtained in the previous step.

Important Classes and Functions

The primary class that contains all the blueprint-exposed functions and data is UArcweaveSubsystem. This class is located in the file path Plugins\arcweave\Source\arcweave\Public\ArcweaveSubsystem.h. It provides a range of functions that can be utilized in both Blueprints and C++ to interact with, modify, and retrieve data.

List of Important Functions in UArcweaveSubsystem:

  1. Fetch Data from Arcweave API or local JSON

    • This function allows you to fetch data from the Arcweave API by providing the API token and project hash.

  2. Load Arcweave API Token from Settings

    • This function retrieves the Arcweave API token from the settings.

  3. Save Arcweave API Token to Settings

    • This function saves the Arcweave API token to the settings, using the provided API token and project hash.

  4. Get Arcweave Project Data

    • This function retrieves the Arcweave project data.

  5. Run Transpiler for the Element and Increase Visits Counter

    • This function runs the transpiler for a specific element and increases the visits counter for that element. It requires the object ID as an input.

  6. Run Transpiler for the Condition

    • This function runs the transpiler for a specific condition. It requires the condition ID as an input.

  7. Set Variable

    • This function lets you modify the current variable value outside the dialogue logic. From anywhere in the project. You only need to provide the variable ID.

These functions provide a comprehensive set of tools for interacting with the Arcweave API and managing project data within your Unreal Engine project.

Using the Demo Project

You can explore the plugin implementation and see examples of its usage in our Arcweave demo project. This project includes a demo scene and samples of logic implementation using Arcweave's Web API, showcasing all the capabilities of the plugin.