Dialog editor

From Post-Apocalyptic RPG wiki

Jump to: navigation, search

Deprecated code proposal.png This article features a deprecated code proposal.

Deprecated Proposals are no longer considered for implementation. This does not necessarily mean that they are completely rejected but for now have been set aside.

Yet another proposal for a dialog editor

Contents

Goals

  • read and write valid YAML files to be parsed by the dialog engine
  • provide a user with multiple ways to view and edit the content:
    • source editor with syntax highlighting
    • flow chart to help visualize the flow of the dialog
    • intuitive point-and-click style editor
  • edit multiple dialogs at once in an organized fashion
  • cross platform
  • flexible and highly configurable interface

Rationale

Currently, there exists no functional dialog editor for PARPG. While the syntax of the dialog YAML files is arguably straight forward, editing raw text can be intimidating. Furthermore, a tool to help facilitate the creation of these files would speed up their production by making the editor's work flow more efficient. The tool I have in mind wouldn't simply cater to a specific style of editing, but to an array of different styles.

Code

The work in progress dialog editor code currently resides in an external git repository. See: http://gitorious.org/personal-projects/parpg-dialog-editor/trees/master

GUI Overview

Dialog editor ui r2.png

  • A: This is simply a list of currently open dialog files. Clicking on a file listed here will select that file and update all views/modes accordingly. Files may be added individually, or a director may be selected to recursively add dialog files from
  • B: This is the context pane. Depending on which view is selected, its content will change dynamically, as follows:
    • source: In this mode, the content panel will show a hierarchy of objects present in the source code. Clicking on one of these objects will jump to the corresponding line of code.
    • Chart: In this mode, the content panel becomes a toolbox, with icons representing dialog sections, those sections' responses, and arrows that dictate the dialog's flow.
    • Table: In this mode, the context panel will show a hierarchy of dialog elements, such as section names and those sections' responses. By clicking on a section, the selected section is scrolled to in the main view port and highlights all of the sections that could potentially follow the selected one. Clicking on a response would scroll to that response in the main view port and highlight the section that follows that response.
  • C: This is the main view port. depending on the view selected (denoted by tabs above), the content will change (see: Editing Modes).

Editing Modes

This section will cover in brief detail the three main modes (or styles) of editing dialogs.

Source

This mode will resemble closely the current style of editing dialogs. As with many editors, this mode will present the raw YAML file to the user with syntax highlighting, line numbering, and automatic indentation. Unlike existing editors, this mode will offer auto-complete and quick access to help.

Chart (tentatively named)

Chart mode will provide the user with a graphical representation of the current dialog. By dragging and dropping the appropriate icons, dialog sections and their respective responses should be a snap to create. To change the flow of a dialog, a user would then need simply drag arrows to the section to follow that response.

Table (most definitely tentatively named)

This mode is a bit difficult to explain. Once development progresses a little further, it should be easier to expound upon this by showing the mode in action.

Visual Changelog

This section will be a dumping ground for screenshots displaying the many iterations of development

v.0.1.1

2010-12-21-122414 800x600 scrot.png

Changes

  • source editor now recognizes keywords and punctuation
  • auto-complete now works for keywords

Other dialog/conversion editors

Personal tools