Decentraland Explorer
This is the decentraland explorer official repository.
This repository covers mainly the Kernel component of the explorer product.
Kernel component responsibility includes running the SDK scenes, handling back-end business logic and more. This said, you can clone this repo and run the browser version of Explorer. If you want to contribute to our renderer, please check out the unity-renderer repo: https://github.com/decentraland/unity-renderer/pulls. Unity-renderer repo outputs a npm package that's used on this one for publishing the Explorer.
Before you start
Running the Explorer
Make sure you have the following dependencies:
- Latest version of GNU make, install it using
brew install make - If you are using Windows 10, you must enable the Linux subsystem and install a Linux distro from Windows Store like Ubuntu. Then install all tools and dependecies like nodejs, npm, typescript, make, etcetera.
- Node v10 or compatible installed via
sudo apt install nodejsor nvm
IMPORTANT: If your path has spaces the build process will fail. Make sure to clone this repo in a properly named path.
When all the dependencies are in place, you can start building the project.
First off, we need the npm package dependencies. In most of the cases this should be done only once:
npm install
By now, you can run and watch a server with the kernel build by typing:
make watch
The make process will take a while. When its finished, you can start debugging the browser's explorer by going to http://localhost:8080/
Update local renderer build version
The unity build used when accessing through localhost can be changed with several commands:
-
make update-rendererdownloads the renderer build for the master branch and installs it, overwriting the previous build.
Keep in mind that a make watch should be run and keep the server up before updating the local build, otherwise it will be replaced by the make watch command.
Run kernel tests
To see test logs/errors directly in the browser, run:
make watch
Now, navigate to http://localhost:8080/test
Troubleshooting
Missing xcrun (macOS)
If you get the "missing xcrun" error when trying to run the make watch command, you should download the latest command line tools for macOS, either by downloading them from https://developer.apple.com/download/more/?=command%20line%20tools or by re-installing XCode
Testing your branch using automated builds
When any commit is pushed to a branch on the server, a build is generated and deployed to:
https://play.decentraland.zone/branch/<branch-name>/index.html
If the CI succeeds, you can browse to the generated link and test your changes. Bear in mind that any push will kick the CI, and there's no need to create a pull request.
Technical how-to guides and explainers
- How to create new SDK components
- How to debug with local test parcels and preview scenes
- How to use Unity visual tests
- Kernel-unity native interface explainer and maintenance guide
- How to create typescript workers
- How to add/update protobuf-compiled components
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.