Unity Quick Start

<aside> 💡 This article is written for developers of all experience levels. However, it may be helpful to understand the basics of the Unity editor.

</aside>

Introduction

<aside> 💡 Prerequisites: Unity 2021 or higher

</aside>

ConvoGen is a powerful dialogue editor tool that allows users to create dynamic dialogue trees for their games (and other media, too!). Its easy-to-use API can be easily integrated into projects and consumed with only a few lines of code.

The Unity Asset Store contains a package that makes it trivial to include your ConvoGen projects into your Unity games.

Instructions

1. Asset Store

First, we will add the project from the Unity Asset Store.

  1. Find the package on the asset store.
  2. Click Add to My Assets.
  3. Click Import.

Voila! The ConvoGen prefab and sample scene are now accessible to your project.

Alternatively, the Unity package is available for direct download from the Downloads page.

2. Sample Scene

  1. Navigate to the ConvoGen\Samples folder within Assets.
  2. Double-click ConvoGenQuickStart.unity.
  3. If a notification about TextMeshPro shows up, import that as well.
  4. Run the project. The sample scene will load a sample .cvg export file and begin to navigate its dialogue contents.

3. Customization

Click on the ConvoGen GameObject in the Hierarchy view. In the Inspector panel, the Dialogue Manager script will be shown with its configuration properties.

Untitled

To run your own projects, first export them from the ConvoGen editor to a place accessible by your project. Then change the Project Path property to that location and run the project. Your ConvoGen project will now be loaded instead of the sample project.

Here you can change stylistic options, such as colors.

The Dialogue Manager script can be easily modified to interact with any existing code, or used as-is.