Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: local build instruction docs #6036

Merged
merged 2 commits into from
Jan 8, 2024
Merged

fix: local build instruction docs #6036

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0526829
fix: local build instruction docs
pravusjif Jan 3, 2024
c5f4685
Merge branch 'dev' into fix/local-build-instruction-docs
pravusjif Jan 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,10 @@ This is the most useful debugging scenario for advanced feature implementation.
### Steps

1. Make sure you have the proper Unity version up and running
3. Make sure you are running browser-interface through `make watch` command on `browser-interface` path.
4. Back in unity editor, open the `DebugConfig` component inspector of `InitialScene`
5. Make sure that the component is setup correctly
6. Hit 'Play' button
2. Make sure you are running browser-interface through `make watch` command on `browser-interface` path.
3. Back in unity editor, open the `DebugConfig` component inspector of `InitialScene`
4. Make sure that the component is setup correctly
5. Hit 'Play' button

## Debug with browsers + local Unity build

Expand All @@ -102,16 +102,16 @@ When the steps are followed, you will be able to run the local Unity build by go
### Steps

1. Make sure you have the proper Unity version up and running
3. Make sure you are running browser-interface through `make watch` command.
4. Produce a Unity wasm targeted build using the Build menu.
5. When the build finishes, copy all the files inside the resulting `/build` folder (`unity.loader.js` is not necessary as we use a modified loader) and paste them inside `browser-interface/node_modules/@dcl/unity-renderer`.
6. Run the browser explorer through `localhost:8080&ENABLE_WEB3`. Now, it should use your local Unity build. Don't mind the white screen at the beginning, that's because the website repo is not being used and it's only loading Browser Interface with the build.
7. If you need a Unity re-build, you can just replace the files and reload the browser without restarting the `make watch` process.
2. Make sure you are running browser-interface correctly by running `npm install`, `make build-unity-local` and `make watch` commands in that directory and leave that server running.
3. Produce a Unity wasm targeted build using the Build menu (the build should be named just "unity" to avoid renamings later).
4. When the build finishes, copy all the files inside the resulting `/build` folder (`unity.loader.js` may not be necessary) and paste them inside `browser-interface/node_modules/@dcl/explorer`.
5. Run the browser explorer through `http://localhost:8080/?ENABLE_WEB3`. Now, it should use your local Unity build. Don't mind the white screen at the beginning, that's because the website repo is not being used and it's only loading Browser Interface with the build.
6. If you need a Unity re-build, you can just replace the files and reload the browser without restarting the `make watch` process.

Alternatively you can go through these 2 steps after step 3 and load the build locally using `localhost:3000`
Alternatively you can go through these steps after step 3 and load the build locally using `localhost:3000`
1. Make sure you have the [explorer website repository](https://github.com/decentraland/explorer-website) cloned.
2. Make sure you have the local website up and running by executing `npm run start:linked` in the cloned repo directory (`npm i` first just in case).
3. When the WebGL build finishes, copy all the files inside the resulting `/build` folder (`unity.loader.js` is not necessary as we use a modified loader) and paste them inside `explorer-website/node_modules/@dcl/unity-renderer`.
3. When the WebGL build finishes, copy all the files inside the resulting `/build` folder (`unity.loader.js` is not necessary as we use a modified loader) and paste them inside `explorer-website/node_modules/@dcl/explorer`.
4. Access using `localhost:3000`

### Troubleshooting
Expand Down Expand Up @@ -147,4 +147,4 @@ If the local WebGL build always fails with the error `System.ComponentModel.Win3
## Copyright info

This repository is protected with a standard Apache 2 license. See the terms and conditions in
the [LICENSE](https://github.com/decentraland/unity-renderer/blob/master/LICENSE) file.
the [LICENSE](https://github.com/decentraland/unity-renderer/blob/master/LICENSE) file.