Skip to content

Debug Terminal

hugh5 edited this page Sep 8, 2022 · 9 revisions

Introduction

The debug terminal is for developers to run commands while the game is running. When visible, the terminal is displayed in the bottom-left of the screen and commands can be typed into the terminal using the keyboard.

New Position Box Boy
Screenshot 2022-09-08 151214

The terminal uses the Command Pattern to action entered commands.

Key Components

  1. Terminal - Maintains the state of the terminal and actions commands: Terminal.
  2. Terminal Input Component - Processes input and triggers state changes in the terminal:KeyboardTerminalInputComponent.
  3. Terminal Display - Displays the terminal's UI: TerminalDisplay.
  4. Command - Defines actions to be taken when the command is triggered: e.g. DebugCommand.

Usage

The terminal can be toggled in and out of view using the F1 key.

Commands can be triggered by typing into the terminal and pressing enter. When the name of the command followed by valid arguments is entered, the command is actioned. As an example, the "debug" command accepts the arguments "on" and "off". So debug on or debug off would be valid commands.

Commands must be added to the commands map in Terminal.java using addCommand(). They are composed of a name and an instance of the Command interface. The following is an example for adding the debug command:

addCommand("debug", new DebugCommand());

Table of Contents

Home

Game

Game Home

Design Influences

Gameplay Features

Style

Story

Friendly Units
Map
City
Buildings
Unit Selections

Spell

Game User Testing: Theme of Unit Selection & Spell System

UI User Testing

Tutorial

Resource Stats Display

Loading Screen Bar

Health Bars
In Game menu
  • Feature
  • User Testing:In Game Menu

Landscape Tile Design

Landscape Tile Design Feedback

Weather Design

Weather Design Feedback

Camera Movement

Enemy design

Enemy Units

Enemy AI

How Animation Works

Map Flooding

Game Engine

Getting Started

Entities and Components

Service Locator

Loading Resources

Logging

Unit Testing

Debug Terminal

Input Handling

UI

Animations

Audio

AI

Physics

Game Screens and Areas

Terrain

Concurrency & Threading

Settings

Troubleshooting

MacOS Setup Guide

Clone this wiki locally