Improbable Icon

Notes about bugs/errors from a first time user

unity
docs-issue

#1

Hi!

I’m really loving SpatialOS, and the documentation and tutorials are fantastic.

So there are some things I noticed while going through the Pirates tutorial on SpatialOS SDK v10:

  1. Building workers from within Unity hangs the UI and makes Unity unusable due to spatial.exe detecting a newer version and asking if it should update, requiring a Y/N keypress on the background process.

  2. I have multiple versions of Unity installed, all on drive D:
    Installing the version SpatialOS requires doesn’t help unless it’s installed specifically to “C:\Program Files\Unity”, as the registry setting for the Unity path is seemingly ignored.

  3. The Pirate tutorial documentation, https://docs.improbable.io/reference/10.4/tutorials/pirates/pirates-command

  • The ACL has a ; halfway through the new lines
  • A bunch of lines are missing a . between new Class.Data
  • Should be a uint in “return new AwardResponse((int)request.amount)”
  • Never explicitly mentions that you should add TrackScore to PlayerShip (mentions it as a passing note later)
  • “ScoreCanvas”, not “Canvas” in “scoreCanvasUI = GameObject.Find(“Canvas”).GetComponent();”
  1. Deploying to cloud tutorial never mentions that you require a Linux build.
    It also assumes you’ll make a macOS build.
    Despite those 2 failing, the deployment “succeeds” and shows up on the cloud control panel, but you’re never able to launch a game (no server).

  2. You can stop laughing now, but the control panel doesn’t work in EDGE, it just constantly shows “connecting”

Then, some general notes that are just musings, not errors:

  1. In game, the score doesn’t show until you’ve sunk at least one ship.

  2. No way to run cloud launch from the Unity UI. Having only 1 command you have to run from the terminal is weird.
    spatial cloud launch MyPiratesAssembly default_launch.json piratestutorial --snapshot=snapshots/default.snapshot --cluster_region=eu

  3. It’s also weird that you cannot see a deployment in the deployments panel online… until you launch one using the command above.
    It’s not the end of the world, but (maybe) it’d be nice to run the deployment from Unity, see it appear in the control panel, and from there you could launch it, instead of running the command line above.

Number 1 is the only one I feel strongly about, as it ruins the automatic workflow I have set up.

So yeah, thanks a lot, and I hope this has been useful!


#3

Thanks so much for this @NoshBar, this is enormously useful. We care about feedback from all of our users (including EDGE cases :stuck_out_tongue:) and are actively working to improve our tutorials! Hopefully you’ll see fixes for these soon :slight_smile:


#4

Hey @NoshBar, thanks for the feedback!

We have an interim workaround while we work on the proper fix: https://forums.improbable.io/t/unity-freezing-at-building-dev-workers-from-within-unity/2358/9

You can set the UNITY_HOME environment variable to hint spatial to the correct version: https://docs.improbable.io/reference/11.0/workers/unity/worker-setup#multiple-versions-of-unity

I hope that helps!
-J