Ultimate To-Do List

Author: Tomasz Klin

Version: 2.0.1

Introduction

The Ultimate To-Do List plugin for Unreal Engine is an efficient task management tool that allows users to create, view, and edit tasks directly from the editor. The plugin features Sticky Notes that allow you to view tasks on a level, and a "Go to" button for quick access to the task location. Additionally, the plugin includes powerful sorting and filtering options and the ability to capture and edit screenshots. Users can also add comments and utilize a draft mode for completing new task details before submitting.

Your tasks stay in the service your team already uses. Ultimate To-Do List works with Trello, YouTrack, Jira Software, Asana, HacknPlan, ClickUp and Notion, each of which has a free plan, and the comparison below shows what each one gives you (see Integrations comparison). Whichever you pick, the plugin stores nothing of its own: tasks live in that service, so the rest of your team keeps working with them in a browser or a mobile app, and what you change in the editor is what they see.

Features list

• Creating new tasks from the editor and game.
• Sticky Notes. Display tasks on a level.
• "Go to" button. One-click to open the level associated with the task location.
• Editing task in place details. All changes are automatically saved
• Filtering task.
• Sorting tasks by column.
• Capturing screenshots.
• Editing screenshots.
• Adding comments.
• Draft mode. Complete new task details before submitting.
• Integration with Trello, YouTrack, Jira Software, Asana, HacknPlan, ClickUp and Notion.
• Collaboration with your team members.

Getting Started

Enabling Plugin

In order to enable the plugin go to Edit -> Plugins, select Other category and check Enabled for Ultimate To-Do List

Opening Tool Window

Ultimate To-Do List is available as a tab for Unreal Editor. The tab can be accessed from the Window menu.

Supported Integrations

The Ultimate To-Do List is designed to support many services

Trello

• Integration Documentation
• https://trello.com/
• Free up to 15 users
• Very popular software in game dev

YouTrack

• Integration Documentation
• https://www.jetbrains.com/youtrack/

• Free up to 10 users
• Project management tool

Jira Software

• Integration Documentation
• https://www.atlassian.com/software/jira
• Free up to 10 users
• Project management tool

Asana

• Integration Documentation
• https://asana.com
• Free up to 10 users
• Project management tool

HacknPlan

• Integration Documentation
• https://hacknplan.com/
• Unlimited users

ClickUp

• Integration Documentation
• https://clickup.com/
• Free plan available
• Project management tool. On a free plan the Level and Camera values are stored in the task description instead of custom fields

Notion

• Integration Documentation
• https://www.notion.so/
• Free plan available
• Workspace and documentation tool.

---

Integrations comparison

¹ Available in the paid version of the service

² Feature not provided by the service

³ Not yet implemented

⁴ Notion applies a 1,000-block limit once a workspace has more than one member

Interface

The Ultimate To-Do List user interface is made up of the following components:

1. Toolbar
2. Tasks List
3. Task Details
4. Output

Toolbar

1. Project Task - Create a new task
2. Level Task - Create a new task with a sticky note on level
3. Delete Completed - Delete all completed tasks
4. Refresh - Reinitialize the connection to the server and refresh task list
5. Settings - open the Plugin Settings window.
6. Login Settings - open the Login window.
7. Sticky Notes - show/hide sticky notes in the Level Viewport (see Sticky Notes)

Tasks List

After successfully downloading all tasks from the server, they will be displayed on the task list. You can narrow down the entries to the ones of your interest by filtering the tasks. The Task List filter allows you to search for tasks using an advanced syntax similar to the Content Browser. This advanced search syntax enables you to perform sophisticated search queries and look for tasks based on key-value pairs from their properties. For more information, please refer to the Advanced Search Syntax page.

Example usage:

Task Details

Tasks Details panel presents all the information available for the selected task.

1. A link that navigates to the selected task in the web browser
2. Property list (see Property List)
3. Toolbar

Property List

Contains all the most crucial information for the selected task.

General

Standard properties are available by default in the Mantis.

Attachments

The Attachments section presents a list of attachments. For images in PNG, BMP, and JPG formats, the plugin can display thumbnails.

Comments

The Comments section presents all notes added to the issue. Here you can also add new notes.

Output

The Output panel is the central hub for gathering the log output of plugin operations. In case of any troubles, this is the first place where you should look for causes.

Message Log

The same logs that appear in the Output panel you can also find in the Message Log tab in the Ultimate To-Do List section. You can increase logs verbose in the project settings in the section “Debug”

Login Dialog Box

This window may be different dependent on chosen provider.

Project Settings

Ultimate To-Do List settings can be edited in the Editor Settings tab. Or directly from the main tool window. Settings are divided into three sections

General Settings

1. Provider - for now, only Trello is available
2. Host - Address to service.
3. Test - Test connection to the host.

1. Change Login Settings - Open login window (see Login Dialog Box).
2. Logged user details
3. Project - Here you can select an available project for the logged-in user.
4. Constructor Class - Task constructor class (see Issue Constructor)
5. Profiles default values for each of the task types (see the Profiles section of the settings).
6. Additional columns definition
7. Task item size. Small, Medium, Large, and Large Detailed.

Sticky Notes Settings

Provider Settings

Level Tasks

When a level task is created, the plugin automatically adds the level name, location, and orientation to the task. Each task that has this information is marked on the Tasks List in a column with

a symbol.

Thanks to the location information stored in a task, we can jump very fast to the level in the location associated with the task. To do this, just click the button

on the details panel toolbar.

Sticky Notes

All task markers associated with the currently opened level can be displayed in the level viewport. To enable this feature check

in Toolbar.

Selecting a sticky note on the level viewport opens the issue in the Details panel. Double-click on a marker jumps to the sticky note location.

Editing Screenshots

Before submitting an task, all screenshots can be edited in a user-defined image editor e.g paint.

By checking Upload checkbox you can decide what files should be attached.

Reporting Automation

To increase QA team efficiency, some of the tedious work can be done automatically for them.

Task Constructor

Task Constructor is a blueprint class that can modify any task parameters. E.g. you can add additional information like current quest name or player character skills.

To create your own Task Constructor you need to create a blueprint that inherits from TaskConstructor and overrides Construct Task function. Function Construct Task will be called for all taskss just after the issue will be reported.

In the example below for all tasks added in the game, information about the current level, the game time, and some steps to reproduce will be added.

To set your Task Constructor, select an TaskConstructor class from the combo box in Project Settings.

---