Dungeon Tools - EasterEggProductions/adventure-mode-godot GitHub Wiki

Table of Contents

Purpose

Dungeon Tools is a system building dungeon levels, as well as managing the synchronization of dungeon-specific data between players. Levels are contained in a separate Godot scene from the overworld, and are linked together using doors with transition triggers.

Dungeon Objects

Spawnpoint3D: Defines a point in a scene where players will spawn in. This could be an initial entry point, or become a target for an Exit Zone. There are three Spawnpoint subtypes: Default, Multiplayer, and "Walk-in."

ExitZone3D: Defines a 3D area in a scene where players will transition from one scene to another. When an ExitZone3D is created, a target scene and Spawnpoint3D should be selected in the editor to set it up.

Editor Gizmos

Another component of the Dungeon Tools module are the editor gizmos. Gizmos are helpful graphical elements within the Godot editor for the purpose of debugging and communicating information about nodes. As of the time of writing, there are currently two gizmos in Dungeon Tools:

  • Dungeon Button: Draws a yellow line between a dungeon button and the door it is connected to.
  • Spawnpoint3D: Draws a 3D orange ring that changes shape depending on the Spawnpoint's subtype.
Below is a screenshot showcasing both gizmos within the Godot editor:

Goals for Dungeon Tools

  • Generalized state synchronization between clients for all dungeon objects
  • Synchronization among the different dungeon scenes so that players in different rooms maintain the same game state.
  • A good selection of dungeon objects that can be used to construct interesting dungeon levels
  • A modular design that allows the user to expand upon the template, creating their own specialized dungeon objects.
⚠️ **GitHub.com Fallback** ⚠️