Merge pull request #42 from Chylum/docs/spawn-networked-props-from-scene-button

Documentation: Add guide on how to add props using a scene button

Author: dooly123

content/docs/avatar/shaders.mdx

@@ -39,3 +39,28 @@ import { Callout } from 'fumadocs-ui/components/callout';
 <Callout type="info">
 These are known to be working/compatible at the time of the latest documentation update.
 </Callout>
+
+
+## How to Make Avatars Which Use Poiyomi Shaders Work in BasisVR/URP
+
+Many avatars use Poiyomi shaders which originally only worked with Unity's Built-in Render Pipeline (BIRP). However, now, Poiyomi shaders are also supported to work with Unity's Universal Render Pipeline (URP), which is the render pipeline used for BasisVR.
+
+Poiyomi shaders support for URP is still in beta. If you have an avatar that was originally designed using BIRP Poiyomi shaders, you can easily convert them to be URP-compatible by following the steps below. To demonstrate how, this example uses uses [Hatsune Miku by Tomarudo](https://boothplorer.com/avatar/3226395).
+
+- Download the latest release from https://discord.gg/poiyomi #urp-release.
+
+- Import your character into the Unity scene. If it the shader looks different from what's expected (e.g., its colours are missing or it has a magenta colour due to missing shaders or similar), you will need to make just a few tiny adjustments to fix things.
+
+![Inspector Window showing button and components](/img/avatars/23.png)
+
+- Select each material in your avatar's folder and change its shader to use Poiyomi Pro URP.
+
+![Inspector Window showing button and components](/img/avatars/24.png)
+
+- After making the changes, your avatar should render as expected.
+
+![Inspector Window showing button and components](/img/avatars/25.png)
+
+<Callout type="info">
+Poiyomi shaders for URP is compatible with both PC and Android devices. 
+</Callout>

content/docs/world/props.mdx

@@ -117,8 +117,76 @@ You can find your key by opening up the Basis application and selecting your pla
 
 - Ensure Persistent is selected so that synced changes persist for late-joining players.
 
+- Click Save XML.
+
 ![Inspector Window for load config](/img/props/5B.png)
 
 - Open up the 'Initialization' scene and press play. This initialises the created scene and network objects. The next time when you load the scene through the server while running the basis application, all players will be able to interact with the network synced cube.
 
-![Desktop Steam two game windows showing synced cube](/img/props/5C.png)
+![Desktop Steam two game windows showing synced cube](/img/props/5C.png)
+
+## How to Spawn a Prop Using a Scene button
+
+The Runtime Loader component will generate any props located in *Basis\Basis Server\BasisServerConsole\bin\Debug\net9.0\initialresources* at runtime. It is also possible to use a button with a scene to generate props. To do so:
+
+- Add a canvas object to your scene. Make sure to attach the relevant components similar to what was shown in the previous sections. Remember to add a Basis Prop component to generate a .bee file for your prop and upload it to a remote server. 
+
+![Inspector Window showing canvas and components](/img/props/6A.png)
+
+- Create a TMP button.
+
+![Inspector Window showing button and components](/img/props/6B.png)
+
+- Add a Basis Prop component, enter an Asset Bundle Name and press the 'Create Prop Bee File' button. The generated .bee files will be used by the Basis Runtime Loader to load the prop into a scene. For this example, we will use the network synced cube from the previous section again.
+
+![Inspector Window showing synced cube and components](/img/props/6B-.png)
+
+- Create an empty Gameobject and attach a Runtime Loader component to it. This will be used to spawn the prop. To avoid props being generated on scene start up, disable the component in the inspector.
+
+![Inspector Window showing Runtime Loader which is disabled](/img/props/6C.png)
+
+<Callout type="info">
+If you want your prop to be network synced, add a networking syncing component to it. For instance, you can use the Basis Object Network Syncing component, as shown previously, to synchronise prop movement. 
+
+You can also create your own network syncing code. For inspiration and to help you get started, you can refer to example packages *Basis Ported Pooltable* and *Basis Vehicles* which you can find inside the project.
+</Callout>
+
+- Select your button and add an onClick() event to it. Assign your Runtime Loader Gameobject, making sure to select BasisRuntimeLoader.LoadNow as the method which your button will call on when clicked.
+
+![Inspector Window showing button event calling RuntimeLoader](/img/props/6D.png)
+
+- Open up the Load Config editor.
+
+- Enter your generated prop password and .bee url.
+
+- Ensure Persistent is selected so that synced changes persist for late-joining players.
+
+- Click Save XML.
+
+![Inspector Window showing load config](/img/props/6E.png)
+
+- If you haven't already, create an empty Gamebject and attach a Basis Scene component to it, filling in the relevant fields. Once set, click 'Create Scene Bee File'.
+
+![Inspector Window showing Basis scene](/img/props/6F.png)
+
+- Open up the Load Config editor again.
+
+- Enter your generated scene password and .bee url.
+
+- Ensure Persistent is selected so that synced changes persist for late-joining players.
+
+- Click Save XML.
+
+![Inspector Window showing button and components](/img/props/6G.png)
+
+- Open up the 'Initialization' scene and press play. This initialises the created scene and network objects. The next time when you load the scene through the server while running the basis application, you should be able to spawn your prop via a button.
+
+![Inspector Window showing button and components](/img/props/6H.png)
+
+<Callout type="info">
+Note: Both local and remote players can spawn cubes!
+</Callout>
+
+<Callout type="info">
+Double note: You can access Basis VR via Steam as well. To get an access key, [join the discord](https://discord.gg/v6ve6WT562)!
+</Callout>