Skip to content

Setup

Welcome to the hammer build tool setup guide. You can also view our video tutorial here as well.

Why do I need this?

Some of our tools require additional dependencies that we are not allowed to be re-distributed with our code. However, these dependencies can be complex to compile. That's why we created this build tool. You can run a GitHub workflow and compile all the dependencies needed for our tools yourself. Once you have it configured, it makes it super easy!

1

What are the dependencies?

  1. You must be a part of the Poly Hammer GitHub org. Individuals, Small Teams, and Enterprise customers can purchase access for a particular build workflow and gain access to the Poly Hammer Org.

  2. You must be a part of the Epic Games GitHub org. The build tool needs to be able to pull down Unreal Engine source code, so it can compile parts of it for you and your tools.

  3. Copy the template repo and configure its permissions.

What are the steps?

Join Poly Hammer GitHub Org

  1. Purchase a product from the Poly Hammer website and open the confirmation email.

  2. Verify your GitHub account by clicking on the GitHub Verification button.

GitHub verify
  1. Authorize the Poly Hammer org to read your primary email tied to your GitHub account.
GitHub authorize

Warning

Your email tied to your GitHub account must match the one you used when you purchased the product from the Poly Hammer website.

  1. After a successful authorization, you will see the page below.
GitHub authentication success
  1. Now check your email and accept the invitation to join the GitHub Poly Hammer Org.
GitHub join organization

Your GitHub account has been verified and you are now a member of the Poly Hammer Org!

Join Epic Games GitHub Org

  1. Here is a detailed guide on how to get access to the Epic Games GitHub Org.
  2. Verify that you can now access the source code for Unreal Engine.

Warning

If you receive a 404 when clicking on this link while you are logged into GitHub, then your account is not linked correctly to the Epic Games Org, and the build tool will fail.

Copy the Template Repo

  1. Go to the Template repository and click on the Use this template button and select the Create a new repository option.
Use template example
  1. Give your repo a name, select Private on the visibility section, then hit the Create repository button.
Create new repository
  1. Now create a GitHub access token that gives the build tool the proper permissions. To make things simple, you can use this pre-configured link to generate a classic token. Copy your token and hold on to it for a future step.

  2. Add your newly generated GitHub Token as a secret in your build tool's repo settings.

Repository settings

Navigate to Secrets and variables > Actions > New repository secret.

GitHub actions tab

Give your token the name GH_PAT and paste in your personal access token that you created in step 3 and click on Add secret.

Create actions secret

You now have an actions secret named GH_PAT.

GitHub actions secret

Start Building!

😕 If you still need help configuring your build tool after reading this guide, try watching our video about it, which goes through the process step by step.

Whew! 😅 If you have made it this far, congratulations! You are ready to start creating your own releases!