Files
experiment-adventure-ai/addons/cutscene_editor/README.md
2025-08-01 08:34:51 -07:00

3.1 KiB
Executable File

Cutscene Editor Plugin

A visual graph-based editor for designing point-and-click adventure game cutscenes in Godot 4.

Overview

The Cutscene Editor Plugin provides a node-based interface for creating complex cutscene sequences. Instead of generating code, the editor now manages cutscene resources that can be directly loaded and executed by the game engine. Users can configure narrative sequences through visual connections that are stored as structured data.

Features

  • Visual Node-Based Interface: Drag-and-drop nodes for creating cutscenes
  • Action Representation: Visual nodes for all core action types (Move, Turn, Dialogue, Animation, Wait)
  • Connection System: Visual connections for sequential execution flow
  • Property Editing: Inline parameter editing within nodes
  • Real-Time Preview: Immediate visualization of cutscene execution
  • Undo/Redo System: Comprehensive action reversal capabilities
  • Resource Management: Save/Load cutscene designs as structured resources

Node Types

  • Entry Node: Starting point for cutscenes (Light Green)
  • Exit Node: Ending point for cutscenes (Red)
  • MoveAction Node: Moves characters to specific positions (Blue)
  • TurnAction Node: Rotates characters to face targets (Green)
  • DialogueAction Node: Displays character dialogue (Yellow)
  • AnimationAction Node: Plays character animations (Purple)
  • WaitAction Node: Creates time delays (Gray)

Installation

  1. Download the plugin package
  2. Extract the contents to your Godot project's addons folder
  3. Enable the plugin in Project Settings > Plugins
  4. Restart Godot

Usage

  1. Creating Nodes: Right-click on the graph canvas and select a node type
  2. Connecting Nodes: Drag from output connection points to input connection points
  3. Editing Parameters: Select a node and modify parameters in the Properties Panel
  4. Previewing: Click the Preview button to see your cutscene in action
  5. Saving: Use File > Save to store your cutscene design as a resource
  6. Loading: Use File > Open to load existing cutscene resources

Resource Structure

Cutscenes are stored as structured resources with:

  • Nodes: Each node has a unique ID, type, position, and parameters
  • Connections: Each connection has a unique ID, source node/port, and target node/port
  • Metadata: Version and timestamp information

Runtime Execution

To execute a cutscene at runtime:

# Load the cutscene resource
var cutscene_resource = preload("res://path/to/your/cutscene.tscn")

# Generate actions from the resource
var generator = CutsceneGenerator.new()
var cutscene_manager = generator.generate_cutscene(cutscene_resource)

# Add to scene and start
add_child(cutscene_manager)
cutscene_manager.start()

Requirements

  • Godot Engine 4.3 or later
  • OpenGL 3.3 or Vulkan compatible graphics card

License

This plugin is released under the MIT License. See LICENSE file for details.

Support

For support, please visit: