59 lines
2.5 KiB
Markdown
59 lines
2.5 KiB
Markdown
# 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 without manual coding. Users can configure narrative sequences through visual connections that mirror the action-attachment functionality of the underlying cutscene system.
|
|
|
|
## 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)
|
|
- **Parallel Execution**: Special Parallel Group nodes for simultaneous actions
|
|
- **Connection System**: Visual connections for sequential and parallel execution flow
|
|
- **Property Editing**: Inline parameter editing within nodes
|
|
- **Real-Time Preview**: Immediate visualization of cutscene execution
|
|
- **Undo/Redo System**: Comprehensive action reversal capabilities
|
|
- **Save/Load Functionality**: Persistent storage of cutscene designs
|
|
|
|
## 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)
|
|
- **ParallelGroup Node**: Groups actions for simultaneous execution (Orange)
|
|
|
|
## 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
|
|
|
|
## 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:
|
|
- Documentation: [https://example.com/docs](https://example.com/docs)
|
|
- Issues: [https://github.com/example/cutscene-editor/issues](https://github.com/example/cutscene-editor/issues) |