HacknPlan Integration

HacknPlan

HacknPlan is a project management service built for game development. It organises work into projects, each with a board of work items that can carry comments, attachments and subtasks. LadyBug Tracker reports bugs as work items in a single HacknPlan project.

HacknPlan's free plan has no user limit.

Authentication

HacknPlan uses API keys. In the login window enter:

• Api Key — a key generated in your HacknPlan account.

To generate one, open Settings > API in HacknPlan (https://app.hacknplan.com/settings?section=api) and create a key. The Create API Key button in the login window opens that page for you.

The key has to be granted two scopes, or the plugin cannot list anything to work with:

• Workspaces Read
• Projects Read

No user name is asked for: the key identifies the account on its own.

Host

The host address is fixed to https://api.hacknplan.com and the plugin refuses anything else, saying so when the project is verified rather than failing later against an address that cannot answer. Note that this is the API address, not app.hacknplan.com, which is the web interface.

Project setup (HacknPlan service)

The plugin works against one HacknPlan project, and offers the projects your key can see. A project is only offered when both of these hold:

• it is not closed — a project with a closing date is left out;
• its Work Items module is enabled — the plugin reports bugs as work items, so a project without that module has nowhere to put them.

A project missing from the list is almost always one of those two, and both are changed in HacknPlan's own project settings. You can also let the plugin create a project for you.

Where the position is stored

Every reported bug carries the level it was reported from and the camera it was reported at. HacknPlan work items have no custom fields, so the plugin writes both into the work item description and reads them back from there. They travel with the description: editing it by hand in HacknPlan can lose them.

Integration capabilities

• Attachments can be added, viewed and deleted; they are fetched when an issue is opened rather than with the list.
• Comments can be added, viewed and deleted, and are fetched the same way.
• Subtasks are read and edited as a checklist, shown under the name Subtasks. A work item has one such list rather than several.
• Issues are downloaded 100 at a time, newest activity first.

Known limitations

• Custom fields are not available. HacknPlan work items have no user-defined fields, which is why the level and camera live in the description.
• Issue history is not available. The History tab stays empty.
• Status transitions are not offered. The plugin sets the completed state directly rather than moving an item through a workflow.
• The free plan allows 500 MB of storage in total and 5 MB per file.

Project setup (Unreal Engine)

Open Project Settings > Plugins > LadyBug Tracker and set:

1. Provider — HacknPlan.
2. Host — leave at https://api.hacknplan.com.
3. Change Login Settings — paste your API key.
4. Project — pick the project bugs should be reported to.

These settings are stored in Config/DefaultBugTracker.ini and can be shared with the team. Your key is stored separately, per user, and only when Remember Me is enabled.