Skip to content

Latest commit

 

History

History
83 lines (64 loc) · 3.35 KB

README.md

File metadata and controls

83 lines (64 loc) · 3.35 KB

THIS README AND THE WIKI ARE UNDER CONSTRUCTION.

YAP IS AN EARLY WORK IN PROGRESS.

MOST COMMITS WILL BUILD AND RUN.

 

Introduction

Yap is a project-agnostic dialogue engine running on FlowGraph. It is being built by studying games like Monkey Island to try and recreate their capabilties. It is usable via any combination of blueprint or C++, although you will need a C++ project to build this plugin.

Visit the wiki for detailed documentation.

Feature Overview

Dialogue nodes

  • Talk mode or Player Prompt mode
  • Activation limits
  • Configurable entrance conditions
  • Gameplay tag for lookup
  • Multiple dialogue fragments
  • Fragment run control (run all, select one, run til failure)
  • Normal flow output pin for normal talk mode
  • Individual output pins for player prompt mode
  • Bypass output pin (becomes available if there is a chance of the node or all fragments failing to activate)

Speech fragments

  • Selectable speaker
  • Selectable focus character (speech "directed at" character)
  • Mood tag
  • Written text dialogue
  • Title text (usually used for player prompts)
  • Activation limits
  • Configurable entrance conditions
  • Audio asset property
  • Automatic audio ID string
  • Configurable speaking time based on:
    • Audio asset length
    • Text length (word count ✕ project settings playback speed)
    • Manual time entry
  • Extra post-speech padding delay time
  • Optional child-safe data
  • Controllable progression settings
    • Automatic vs manual progression to next fragments
    • Skippable vs forced duration
  • Extra fields for dialogue text and title text to enter extra description for translators
  • Extra field for audio asset to enter stage directions for voice artists
  • Extra optional output pins to run more for when speaking begins and when speaking ends

Other general features:

  • Automatic hookup of audio assets to dialogue fragments (requires audio assets to include audio ID string in their name)
  • Uses an interface you can apply to any object in your game to make it respond to dialogue events
  • Uses a "broker" class you can set up to interact with things from your game, such as:
    • Reading maturity settings
    • Reading dialogue playback settings
    • Interacting with 3rd party audio engines like WWise or FMod for editor functionality
  • Clear indicators on fragments for invalid settings, such as:
    • Missing child-safe data
    • Missing or invalid audio asset data
  • Character assets which can contain one or more portraits (optionally one portrait for each mood tag)
  • Extensively configurable in project settings
  • Relies on normal Unreal localization system (FText for text and localizable assets for audio)

Planned/Missing features:

  • .PO Exporter for better localization - Short-term planned (by mid-2025).
  • Savegame support - Long-term planned. All runtime data in Yap is naturally serialized (UPROPERTY) so this should not be difficult.
  • Multiplayer features and support - Not currently planned, but may support in the future.

 

The Dialogue Node

image

image

 

Graph Sample

image