Arcweave Documentation

Appearance

Integration with Unreal Engine ​

Arcweave provides a free plugin for importing your Arcweave projects into Unreal Engine (version 5.0 and later).

The plugin can import data from Arcweave's JSON file (see Export for Unity below—available to all workspaces) or fetch them using Arcweave's web API (see Use Arcweave's Web API below—Team workspaces only).

Plugin installation ​

Complete the following steps, to install the Arcweave plugin for Unreal Engine:

  1. Download the plugin from its GitHub repository.
  2. Extract the contents of the downloaded .zip into the folder:
    ProjectRootDirectory/Plugins
    If this folder does not exist please create it.
  3. Open your project.
  4. If prompted to rebuild the Arcweave plugin, click Yes.

Transferring your data ​

There are 2 ways you can transfer your project's data and access them with the Arcweave Plugin for Unreal Engine:

JSON import ​

This method is available to all workspaces. For this method, complete the following steps:

a. Export from Arcweave ​

In Arcweave:

  1. Go to Export project > Engine
  2. Select Export for Unreal.
  3. Check or uncheck the Include assets checkbox, depending on whether you want to download the project's audio and image assets.
  4. Press the Export button.
  5. Save the downloaded .zip file to your drive.

b. Check the downloaded files & folders ​

The downloaded .zip file should contain the following files & folders:

  • project.json: contains all the data of your Arcweave project.
  • (Optional) cover/cover.jpg: the project cover image.
  • (Optional) assets/Audio/: contains all project audio assets.
  • (Optional) assets/Images/: contains all project image assets.

The files & folders marked as "optional" are included if you have checked the Include assets checkbox.

c. Import to Unreal Engine ​

To import your Arcweave data into your Unreal project, place those files & folders in this directory:

Content/ArcweaveExport

If this directory does not exist, create it.

Web API ​

You can fetch your Arcweave project's data from within Unreal Engine, via Arcweave's web API. This feature is available to Team workspaces only.

To do this, you will need your workspace's API key and your project's hash.

a. Copy your workspace's API key ​

To locate your API key, follow these steps:

  • Go to the API section of your workspace (Team workspaces only).
  • In the list of API keys, locate the one you want to use.
  • In the Keys column, click the clipboard icon to copy the key to your clipboard.

You will paste the API key into your Project Settings, in Unreal Engine (see further below).

b. Copy your project's hash ​

To locate your project's hash, follow these steps:

  • Open your project.
  • In the top menu, click the gear icon, to open Project settings.
  • Select Properties.
  • In the Project hash row, click the clipboard icon to copy the hash to your clipboard.

You will paste the API key into your Project Settings, in Unreal Engine (see below).

c. Paste API key and hash to Project Settings ​

In Unreal Engine, follow these steps to link your Arcweave project:

  • Navigate to Project Settings.
  • Go to Plugins > Arcweave.
  • Paste your API key and 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.