Installation

Get Kard into your project, compiled, and confirmed working. Kard is a local-first plugin — once it’s installed, you’re ready to go. No account or server required.

Before you begin

You need:

• Unreal Engine 5.7 (Windows / Win64).
• A project you can add a plugin to and compile — Kard ships C++ modules, so it builds the first time the editor opens it.

TODO

Confirm the compiler toolchain end users need to build Kard’s C++ modules on a binary UE install (e.g. the required Visual Studio version and workloads). Not specified in the plugin source.

Requirements at a glance

Requirement	Detail
Engine	Unreal Engine 5.7
Platform	Windows (Win64)
Plugin type	Code plugin — compiles on first load
Required plugin	SQLiteCore (ships with the engine; enabled automatically)
Optional plugins	Niagara, Level Sequence Editor, PCG, Electra Player

The optional plugins unlock extra features (effects, sequencer, PCG, and inline video). Kard loads each integration only if that plugin is enabled — if one is off, Kard still works; you just don’t get that integration.

Note

Kard currently supports Win64 only. macOS and Linux are not listed as supported targets.

Step 1 — Add Kard to your project

1. Close the Unreal Editor.
2. Copy the Kard folder into your project’s Plugins directory, so the layout is: YourProject/Plugins/Kard/Kard.uplugin.
3. If your project has no Plugins folder yet, create one first.

TODO

Write the exact acquisition + unzip steps once the distribution format is final (download artifact name, where it unzips). Kard is not yet on Fab — the marketplace listing and one-click install path will be added at release.

Step 2 — Build and open

1. Open your project. The editor detects the new plugin and compiles Kard’s modules — this can take a few minutes the first time.
2. If prompted to rebuild missing modules, accept.

TODO — Screenshot

The “missing modules — would you like to rebuild?” prompt, so users recognize it and know to click Yes.

Step 3 — Confirm the plugin is enabled

1. In the editor, open Edit → Plugins.
2. Search for Kard (it’s in the Editor category).
3. Make sure it’s enabled. If you just enabled it, restart the editor when prompted.

TODO — Screenshot

The Plugins browser filtered to “Kard”, showing the enabled checkbox and the Editor category — this is the canonical “is it installed?” visual.

TODO

Confirm whether Kard is enabled by default when dropped into Plugins/, or whether the user must tick it here and restart. Behavior is engine-governed; not asserted in the plugin descriptor.

Step 4 — Open Kard and verify

Kard adds three ways to open it. Any one confirms a healthy install:

• Toolbar — click the Kard button in the level editor toolbar.
• Window menu — choose Window → Kard.
• Kard menu — use the top-level Kard menu in the menu bar (Open Tasks / Pages / Notes / Dashboard).

Kard opens as a single dockable tab titled Kard.

TODO — Screenshot

The level-editor toolbar with the Kard button highlighted — the fastest “did it work?” check.

Note

There’s no default keyboard shortcut for opening Kard. You can assign one under Editor Preferences → Keyboard Shortcuts → Kard Plugin.

Check your version

To see which version you installed, open the Kard toolbar dropdown and choose Help → About Kard. It shows the installed version and the Kivibyte copyright.

Where your data lives

Kard stores every card as a standard asset (.uasset) inside your project’s Content folder. That means:

• Cards are version-controlled like any other asset — commit them with your project.
• Nothing leaves your machine; there’s no external service to configure.

A hosted cloud sync backend is in development for a future release.

Next steps

• Quick start — create your first card in a couple of minutes.
• Settings — tune folders, viewport, and more.
• FAQ — storage, source control, and troubleshooting.