HacknPlan Integration

HacknPlan

HacknPlan is a project management service for game development. It divides work into projects. Each project has a board of work items, and a work item can have comments, attachments and subtasks. LadyBug Tracker reports bugs as work items in one HacknPlan project.

The free plan of HacknPlan has no limit on the number of users.

Authentication

HacknPlan uses API keys. In the login window, enter this value:

• Api Key — a key that you make in your HacknPlan account.

To get a key, open Settings > API in HacknPlan (https://app.hacknplan.com/settings?section=api), then make a key. In the login window, the Create API Key button opens this page.

The key must have these two scopes. If the key does not have them, the plugin cannot list anything that it can use:

• Workspaces Read
• Projects Read

The login window does not ask for a user name, because the key alone identifies the account.

Host

The host address is always https://api.hacknplan.com. The plugin does not accept a different address. It tells you about a different address when it verifies the project. Thus it does not fail later, with an address that cannot answer. This is the API address. It is not app.hacknplan.com, which is the web interface.

Project setup (HacknPlan service)

The plugin uses one HacknPlan project. It shows the projects that your key can see. The plugin shows a project only if these two conditions are true:

• The project is not closed. The plugin does not show a project that has a closing date.
• The Work Items module is enabled in the project. The plugin reports bugs as work items. Thus a project without this module has no place for them.

If a project is not in the list, the cause is almost always one of these two conditions. You can change both of them in the project settings of HacknPlan. You can also let the plugin make a project for you.

Where the position is stored

Each bug that you report keeps the level and the camera from which you reported it. HacknPlan work items have no custom fields. Thus the plugin writes these two values into the work item description, and reads them from there. The values are part of the description. If you edit the description manually in HacknPlan, you can lose them.

Integration capabilities

• You can add, view and delete attachments. The plugin gets the attachments when you open an issue, not with the list.
• You can add, view and delete comments. The plugin gets them in the same way.
• Subtasks appear as a checklist that you can edit. The name of the checklist is Subtasks. A work item has only one checklist.
• The plugin downloads issues 100 at a time. The issues with the newest activity come first.

Known limitations

• Custom fields are not available. HacknPlan work items have no user-defined fields. This is why the level and the camera are in the description.
• Issue history is not available. The History tab stays empty.
• Status transitions are not available. The plugin sets the completed state directly. It does not move an item through a workflow.
• The free plan gives 500 MB of storage in total, and 5 MB for each file.

Project setup (Unreal Engine)

Open Project Settings > Plugins > LadyBug Tracker. Then do these steps:

1. Provider — select HacknPlan.
2. Host — keep https://api.hacknplan.com.
3. Change Login Settings — paste your API key.
4. Project — select the project that gets the bug reports.

The plugin keeps these settings in Config/DefaultBugTracker.ini. You can share them with the team. The plugin keeps your key separately for each user. It keeps the key only when Remember Me is enabled.