Unity implementation of Decentraland Client


Keywords
unity-editor, decentraland
License
Apache-2.0
Install
npm install @dcl/unity-renderer@1.0.7792

Documentation

Decentraland Unity Renderer

This repository contains the Unity part of decentraland explorer. This component works alongside Kernel to produce an Explorer build.

Before you start

  1. Contribution Guidelines
  2. Coding Guidelines
  3. Code Review Standards

Running the Explorer

Main Dependencies

This repo requires git lfs to track images and other binary files. https://git-lfs.github.com/ . So, before anything make sure you have it installed by typing:

git lfs install
git lfs pull

Debug using Unity

Take this path if you intend to contribute on features without the need of modifying Kernel. This is the recommended path for artists.

Steps

  1. Download and install Unity 2020.3.0f1
  2. Open the scene named InitialScene
  3. Within the scene, select the WSSController GameObject.
  4. On WSSController inspector, make sure that Base url mode is set to Custom and Base url custom is set to https://play.decentraland.zone/?
  5. Run the Initial Scene in the Unity editor
  6. A browser tab with explorer should open automatically and steal your focus, don't close it!. Login with your wallet, go back to Unity and explorer should start running on the Game View.
  7. As you can see, WSSController has other special options like the starting position, etc. You are welcome to use them as you see fit, but you'll have to close the tab and restart the scene for them to make effect.

Troubleshooting

Missing git lfs extension

If while trying to compile the Unity project you get an error regarding some libraries that can not be added (for instance Newtonsoft Json.NET or Google Protobuf), please execute the following command in the root folder:

git lfs install
git lfs pull

Then, on the Unity editor, click on Assets > Reimport All


Testing your branch using automated builds

To test against a build made on this repository, you can use a link with this format:

https://play.decentraland.zone/index.html?renderer=urn:decentraland:off-chain:renderer-artifacts:<branch-name>

Note that using this approach, the Unity builds will run against kernel master HEAD.

If you want to test your Unity branch against a specific kernel branch, you'll have to use the renderer url param like this:

https://play.decentraland.zone/branch/<kernel-branch-name>/index.html?renderer=urn:decentraland:off-chain:renderer-artifacts:<unity-branch-name>

If the CI for both branches succeeds, you can browse to the generated link and test your changes. Bear in mind that any push will kick the CI. There's no need to create a pull request.


Advanced debugging scenarios

Debug with Unity Editor + local Kernel

Use this approach when working on any features that need both Kernel and Unity modifications, and you need to watch Unity code changes fast without the need of injecting a wasm targeted build in the browser.

When the steps are followed, you will be able to test your changes with just pressing the "Play" button within Unity. This will open a tab running the local Kernel build and Unity will connect to it using websocket.

This is the most useful debugging scenario for advanced feature implementation.

Steps

  1. Make sure you have the proper Unity version up and running
  2. Make sure you have Kernel repository cloned and set up.
  3. Make sure you are running kernel through make watch command.
  4. Back in unity editor, open the WSSController component inspector of InitialScene
  5. Make sure that the component is setup correctly
  6. Hit 'Play' button

Debug with browsers + local Unity build

This approach works when your Unity modifications run well in the wasm targeted unity build, but you don't want to wait for the CI to kick in. This is also useful for remote profiling.

When the steps are followed, you will be able to run the local Unity build by going to localhost:3000 without the need of CI.

Steps

  1. Make sure you have the proper Unity version up and running
  2. Make sure you have Kernel repository cloned and set up.
  3. Make sure you are running kernel through make watch command.
  4. Produce a Unity wasm targeted build using the Build menu.
  5. When the build finishes, only copy all the files with the unityweb extension to static/unity/Build folder within the kernel project.
  6. Run the browser explorer through localhost:3000. Now, it should use your local Unity build.
  7. If you need a Unity re-build, you can just replace the files and reload the browser the without restarting the make watch process.

Technical how-to guides and explainers

For more advanced topics, don't forget to check out our Architecture Decisions Records (ADR) repository.

Copyright info

This repository is protected with a standard Apache 2 license. See the terms and conditions in the LICENSE file.