Skip to content

Installation

Jump to bottom
Colin Basnett edited this page Oct 12, 2024 · 17 revisions

This page will guide you through the basic setup steps in order to start using the BDK.

Prerequisites

  • Windows 10 or higher

Instructions

The BDK requires a custom fork of Blender for it's full functionality.

Install BDK (Blender)

  1. Download the BDK installer from the here.
  2. Run the installer program to install the BDK.

Install Extensions

  1. Run the BDK (Blender).
  2. Open the Preferences dialog by navigating to Edit > Preferences... or press Ctrl+,.
  3. Navigate to the Get Extensions tab.
  4. Search for the Unreal PSK/PSA (.psk/psa) extension and install it.

Installing the BDK Add-on

There are two ways to install the BDK add-on. The recommended way is to install from disk using the archive found in the latest release. The other is intended for power users familiar with Git that want to be directly plugged into the latest development version.

Option 1: Install from Disk (Recommended)

  1. Download the latest add-on archive (i.e., bdk_addon-<...>.zip) from the latest release.
  2. Click the v icon in the top right of the Get Extensions tab and select Install from Disk....
  3. Navigate to and select the add-on archive that you just downloaded and press Install from Disk.

Option 2: Install from Git repository (Advanced users)

  1. Open a new Command Prompt in Administrator Mode and execute the following:
git clone https://github.com/DarklightGames/bdk_addon.git C:\dev\bdk\repositories\bdk_addon
mkdir C:\dev\bdk\addons
cd C:\dev\bdk\addons
mklink /D bdk_addon C:\dev\bdk\repositories\bdk_addon\bdk_addon
  1. In the BDK, in the Get Extensions tab, click the Repositories button in the top right.
  2. Press the + button and select Add Local Repository.
  3. For the Name, enter BDK (optional).
  4. Check the Custom Directory checkbox and enter C:\dev\bdk\addons.
  5. Click Create.
  6. Navigate to the Add-ons tab.
  7. Locate the Unreal BDK add-on in the list and check the checkbox to enable the add-on.

Now, when you want to get the latest development version of the add-on, you can simply do a git pull on the repository.

After this, to update the add-on while running the BDK (Blender), you can run the Reload Scripts operator. Alternatively, the next time you launch the BDK (Blender), the latest add-on will be loaded.

Next Steps

Now that the BDK program and required add-ons are installed, the next step is to turn your game's assets into assets usable by Blender.

You can learn about how to do that at the Repository Management guide.

Clone this wiki locally