Skip to content

Getting Started with PJKT SDK ​

πŸ” Prerequisites ​

🌐

Basic Unity setup

Make sure you are setup with the VCC and basic Unity setup for VRChat creation.

πŸ› οΈ

Editor Creator Companion (VCC)

Download from the official VRChat website if needed

πŸ“ Step-by-Step Guide ​

1

Add SDK Repository to VCC

Click the button below to add the PJKT SDK repository to your VCC:

ℹ️Your browser may ask for permission to open VCC
2

Create New World Project

Set up a new Unity world project in VCC:

  1. Open the "Projects" tab
  2. Click "Create New Project"
  3. Select "Unity 2022 World" project type
  4. Choose "Unity 2022 Worlds Project"
  5. Enter your project name
  6. Click "Create Project"
ℹ️Make sure to give your project a descriptive name related to your booth.
3

Project Creation and Package Import

Wait for VCC to create your project and download necessary packages.

⏳This process may take a few minutes.
4

Add the SDK Package

  1. Find your project in the VCC project list
  2. Click "Manage Project" to access package management
  3. Locate "Projekt: Community SDK" in the package list
  4. Click the "Add" button next to the package
ℹ️Don't forget to come back to this step occasionally to check for updates.
5

Unity Editor Launch

Unity will automatically launch and begin initial setup.

⏳This process may take a few minutes.
⚠️If Unity opens in "Safe Mode", click the "Exit Safe Mode" button in the top-right corner and confirm the prompt asking if you're sure. This is normal for first-time setup, due to PJKTSDK scripts compiling before VRChat SDK.
6

Explore Unity Scene

You'll be presented with a blank Unity scene - your canvas for creation!

7

Handle Initial Console Messages

You may see some console messages during first-time setup.

πŸ’‘Initial ⚠️warnings are common, press the clear in your console. If everything dissapears, everything is good.

πŸŽ‰ Congratulations! ​

🎯

Your PJKT Booth Project is Ready!

You can now start building your booth in Unity.

πŸ”œ Next Steps ​

Made with 🐦 and β˜•.

🚧 Documentation is WIP