How do I get started with the World Building Toolkit (Unity Uploader)?

Note: The World Building Toolit is a community project run by our awesome friend, Anthony Madden, with support from us. If you're interested, please join the World Building Discord and specifically the "world-building-toolkit" channel. We do not support Mac right now.

The Uploader allows you to use a Unity scenes as Template for your Worlds. You can bring in a haunted house for Halloween or your favorite creation from Minecraft. If you can import it into Unity, you can probably get it into Altspace this way. Here are a few example Worlds.

Part 1: Setup

1. Join the SDK Slack - Friends don't let friends build Worlds alone.
2. Read our World-Building Getting Started Guide for the basics
3. Install Unity Hub and install Unity 2018.1.9f2. The Uploader will not work unless you match this version exactly. You'll need a free Unity account if you don't have one and choose "Personal" since you're doing this for fun! During the install, make sure you check the "Android Builds" option and disable auto-update.
4. Download the latest Unity Uploader
5. Create a Template on our website. Name it "Hello World Template".
6. Create a World and name it "Hello World". Select "Hello World Template" as the Template.
   

Part 2: Upload Your Scene

1. Open Unity Hub and create a new Unity 2018.1.9f2 project.
2. With your project open, import the Uploader by double-clicking the the file you downloaded (it's a Unity package). You should now see a new tab called "AltspaceVR". Note that you will need to import the package for every Unity project you want to use with Altspace
3. Open Menu > AltspaceVR > Build Settings
4. Sign in with your Altspace account credentials
5. Click "Load Templates" and then select "Hello World Template"
6. Add a cube to your scene and save.
7. Check "Build for Windows?" and uncheck "Build for Android?"
8. Click "Upload". In about a minute you should see "Upload" complete. 
9. Join "Hello World" by launching Altspace and entering from Menu > Worlds > Mine
10. Reset the World from Menu > Settings > Moderate > Reset
11. You should see the cube. If you do it fast like in the video above, you might be able to see changes within as little as 10 sec

What's Supported?

• Yes: models, collision, animations, particle effects, audio, skyboxes, etc.
• No: scripts. For security purposes, uploads containing scripts will be rejected
• Maybe: fancy stuff like dynamic global illumination
• Upload scenes for different platforms separately or together
• ...see Featured Worlds, many were built using the Uploader

Tips

• Join the Slack
• On the Template page on the left side, we show you the latest uploads by platform. If it was successful you'd see "1-2mins ago".
• You can be in-World when you update. The moment the Uploader says "Upload Complete" you can reset the World to see the changes.
• Building for PC-only with a simple scene should take less than 1 minute to see a change in Altspace
• Set your World to be private to avoid distractions
• Place a cube at the origin so you can see where people will spawn by default. Hide the cube when uploading

Troubleshooting

• I'm falling or can't teleport onto anything
  • You need to add collision to objects to be able to teleport onto it
• Nothing changed
  • Did you save the scene in Unity?
  • Did you choose the platform you're testing on?
  • Are you in the right World? Did you choose the right Template in the Uploader AND in the World form?
  • Did you check the Template page stats?
• Upload fails or times out
  • Most common upload error is having the wrong Unity version. It must match the required version exactly. 
  • Your upload might be too big. Try to keep PC scenes < 100MB. Start small and build up. Optimize, optimize, optimize. 
  • Try with a fresh project with a simple cube
  • Dn't' force quit during a build--it can corrupt your scene. Try reuploading
• It's a really slow process
  • We recommend building for PC only while iterating and for Android later
  • Try removing unused files. For whatever reason Unity gets overzealous sometimes
• I can't sign in with my Altspace credentials
  • Emails are case-sensitive
  • Try with a new project
  • Make sure your Altspace account is in good standing

Helpful Links

• Unity Learn
• Unity Forums