Warudo

https://docs.warudo.app/docs
Admin
Warudo is a feature-rich and flexible avatar animation software designed for 3D VTuber...
Tokens:71,085
Snippets:459
Trust Score:6.6
Update:11 months ago
Show doc for...
Tokens:
Raw
### Toggle Headphone Mesh with Hotkey Blueprint

Source: https://docs.warudo.app/docs/blueprints/tutorials/toggle-meshes

Similar to toggling a jacket, this blueprint demonstrates toggling a headphone mesh using a different hotkey. It highlights the ease of copying and pasting existing node setups and modifying them for new functionalities, reducing repetitive setup.

```blueprint
On Keystroke Pressed (Hotkey: Ctrl+Shift+H)
  -> Toggle Character Meshes (Character: [Your Character], Meshes: [Headphones Mesh])
```

--------------------------------

### Basic Data Input for Asset Reference

Source: https://docs.warudo.app/docs/scripting/api/ports-and-triggers

This is a fundamental example of declaring a data input field that references a `CharacterAsset`. In the editor, this will present a dropdown list for the user to select a character asset from the current scene.

```csharp
[DataInput]
public CharacterAsset MyCharacter;
```

--------------------------------

### Load Unity Assets in C#

Source: https://docs.warudo.app/docs/scripting/api/plugins

This C# code shows how to load Unity assets within a Warudo plugin using the ModHost. It provides examples for loading a prefab GameObject and a TextAsset (like a JSON file) from the plugin's mod folder. These assets are essential for extending plugin functionality with custom resources.

```csharp
var prefab = ModHost.LoadAsset<GameObject>("Assets/MyModFolder/MyPrefab.prefab");
```

```csharp
var text = ModHost.LoadAsset<TextAsset>("Assets/MyModFolder/MyText.json");
```

--------------------------------

### Randomize Character Dance Animation

Source: https://docs.warudo.app/docs/blueprints/tutorials/dance

This setup allows the character to play a random dance animation from a predefined list when triggered. It utilizes the 'Get Random Character Animation' node, which selects an animation from the 'Character Animations' list before playing it via 'Play One Shot Overlay Animation'.

```Warudo Node Editor
On Twitch Channel Points Redeemed -> Get Random Character Animation (Character Animations: ["Short Dance 1", "Short Dance 2", "Short Dance 3"]) -> Play Character One Shot Overlay Animation (Animation: Output Animation)
```

--------------------------------

### Create a Basic 'Hello World' Node in C#

Source: https://docs.warudo.app/docs/scripting/creating-your-first-script

This C# code defines a simple Warudo node that displays a 'Hello World!' message when its 'Enter' flow input is triggered. It requires the Warudo.Core and Warudo.Core.Attributes namespaces. The node has an 'Enter' input and an 'Exit' output.

```csharp
using Warudo.Core;
using Warudo.Core.Attributes;
using Warudo.Core.Graphs;

[NodeType(Id = "c76b2fef-a7e7-4299-b942-e0b6dec52660", Title = "Hello World")]
public class HelloWorldNode : Node {

    [FlowInput]
    public Continuation Enter() {
        Context.Service.PromptMessage("Hello World!", "This node is working!");
        return Exit;
    }
          
    [FlowOutput]
    public Continuation Exit;
      
}
```

--------------------------------

### Load Unity Asset in C# for Warudo Plugin

Source: https://docs.warudo.app/docs/scripting/creating-your-first-plugin-mod

This C# script demonstrates loading and instantiating a Unity GameObject prefab from a plugin mod's assets folder within Warudo. It includes logic for spawning, displaying, and destroying the prefab multiple times based on a multiplier, and managing its lifecycle within the Warudo asset system.

```csharp
using System;
using Cysharp.Threading.Tasks;
using UnityEngine;
using Warudo.Core.Attributes;
using Warudo.Core.Scenes;
using Object = UnityEngine.Object;
using Random = UnityEngine.Random;

[AssetType(Id = "82ae6c21-e202-4e0e-9183-318e2e607672", Title = "Cookie Clicker")]
public class CookieClickerAsset : Asset {

    [Markdown]
    public string Status = "You don't have any cookies.";

    [DataInput]
    [IntegerSlider(1, 10)]
    [Description("Increase me to get more cookies each time!")]
    public int Multiplier = 1;

    private int count;
    private GameObject particlePrefab; // New field to store the particle prefab

    [Trigger]
    public async void GimmeCookie() { // Note the async keyword
        count += Multiplier;
        SetDataInput(nameof(Status), "You have " + count + " cookie(s).", broadcast: true);

        // Spawn the particle prefab Multiplier times
        for (var i = 0; i < Multiplier; i++) {
            var particle = Object.Instantiate(particlePrefab, Random.insideUnitSphere * 2f, Quaternion.identity);
            particle.SetActive(true);
            Object.Destroy(particle, 3f); // Automatically destroy the cloned particle after 3 seconds

            await UniTask.Delay(TimeSpan.FromSeconds(0.2f)); // Delay 0.2 seconds before spawning the next particle
        }
    }

    protected override void OnCreate() {
        base.OnCreate();
        SetActive(true);

        // Load the particle prefab from the mod folder. Change this path if your prefab is in a different folder
        particlePrefab = Plugin.ModHost.Assets.Instantiate<GameObject>("Assets/HelloWorldPlugin/Particle.prefab");
        // Disable it so that it doesn't show up in the scene
        particlePrefab.SetActive(false);
    }

}
```

--------------------------------

### Randomizing Plushie Props with Get Random Prop

Source: https://docs.warudo.app/docs/blueprints/tutorials/buried

This snippet illustrates how to randomize the props spawned by the Throw Prop At Character node. By connecting the output of the Get Random Prop node to the Prop Source input of the Throw Prop At Character node, different props from a specified collection are spawned on each iteration of the loop.

```blueprint
Get Random Prop (Collections: ["Quirky Animals"])
  -> Prop Source
Throw Prop At Character
```

--------------------------------

### Prop Asset Resource Query in C#

Source: https://docs.warudo.app/docs/scripting/api/resource-providers-and-resolvers

This C# code snippet shows how a Warudo asset, specifically a 'Prop' asset, queries for compatible resources. The `[AutoCompleteResource("Prop")]` attribute on the `Source` string property indicates that this asset needs resources that respond to the 'Prop' query.

```csharp
// In the prop asset class
[AutoCompleteResource("Prop")]
public string Source;
```

--------------------------------

### Define Custom Event in C#

Source: https://docs.warudo.app/docs/scripting/api/events

Defines a custom event class by inheriting from Warudo.Core.Events.Event. This example shows how to create a simple event with a string message property.

```csharp
public class MyEvent : Event {
    public string Message { get; }
    public MyEvent(string message) {
        Message = message;
    }
}
```

--------------------------------

### Add Dependencies to manifest.json

Source: https://docs.warudo.app/docs/modding/sdk-installation

This JSON snippet shows the dependencies to be added to the `Packages/manifest.json` file in a Unity project. It includes various Unity packages and Git URLs for external packages like UniVRM and UniTask.

```json
{
  "dependencies": {
    "com.unity.burst": "1.7.2",
    "com.unity.cinemachine": "2.8.9",
    "com.unity.collections": "1.4.0",
    "com.unity.postprocessing": "3.2.2",
    "com.unity.nuget.newtonsoft-json": "3.0.2",
    "com.vrmc.gltf": "https://github.com/vrm-c/UniVRM.git?path=/Assets/UniGLTF#v0.107.0",
    "com.vrmc.univrm": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM#v0.107.0",
    "com.vrmc.vrmshaders": "https://github.com/vrm-c/UniVRM.git?path=/Assets/VRMShaders#v0.107.0",
    "com.cysharp.unitask": "https://github.com/Cysharp/UniTask.git?path=src/UniTask/Assets/Plugins/UniTask"
    // ...
  }
}
```

--------------------------------

### Create and Set Structured Data (C#)

Source: https://docs.warudo.app/docs/scripting/api/structured-data

Demonstrates how to create a new structured data instance using StructuredData.Create<T>() and set its properties. It also shows how to add new random transform data to an existing list and update it.

```csharp
public override void OnCreate() {  
    base.OnCreate();  
      
    // Create a new structured data instance  
    var mySampleData = StructuredData.Create<MyTransformData>();  
    mySampleData.Position = new Vector3(1, 2, 3);  
    // Or equivalently  
    // var mySampleData = StructuredData.Create<MyTransformData>(sd => sd.Position = new Vector3(1, 2, 3));  
      
    SetDataInput(nameof(MyTransforms), new [] { mySampleData }, broadcast: true);  
}  
  
[Trigger]  
public void AddNewRandomTransform() {  
    var newTransform = StructuredData.Create<MyTransformData>();  
    newTransform.Position = new Vector3(Random.value, Random.value, Random.value);  
    newTransform.Rotation = new Vector3(Random.value, Random.value, Random.value);  
    newTransform.Scale = new Vector3(Random.value, Random.value, Random.value);  
      
    var newTransforms = new List<MyTransformData>(MyTransforms);  
    newTransforms.Add(newTransform);  
      
    SetDataInput(nameof(MyTransforms), newTransforms.ToArray(), broadcast: true);  
}

```

--------------------------------

### Add Localized Strings via LocalizationManager in C#

Source: https://docs.warudo.app/docs/scripting/api/localization

Provides an example of how to add localized strings directly using Warudo's `Context.LocalizationManager` in C#. This method allows programmatic setting of localized strings for different languages.

```csharp
var localizationManager = Context.LocalizationManager;
localizationManager.SetLocalizedString("MY_STRING", "en", "My String");
localizationManager.SetLocalizedString("MY_STRING", "zh_CN", "我的字符串");
localizationManager.SetLocalizedString("MY_STRING", "ja", "私の文字列");
```

--------------------------------

### Prompt User for Structured Data Input (C#)

Source: https://docs.warudo.app/docs/scripting/api/structured-data

Demonstrates how to prompt the user for structured data input using Context.Service.PromptStructuredDataInput<T>. It shows handling the user's response, displaying a success toast, and setting the input data.

```csharp
[Trigger]  
public async void PromptUserInput() {  
    var sd = await Context.Service.PromptStructuredDataInput<MyTransformData>("Customize Your Transform");  
    if (sd == null) return; // The user clicked cancel  
      
    Context.Service.Toast(ToastSeverity.Success,   
        "Thank you for your input!",  
        "Your new transform is: " + sd.GetHeader());  
    SetDataInput(nameof(MyTransform), sd, broadcast: true);  
}

```

--------------------------------

### Load Text Asset from Plugin Mod in C#

Source: https://docs.warudo.app/docs/scripting/api/io

Explains how to load text assets, such as JSON files, from a plugin mod's folder at runtime. The example demonstrates using ModHost.Assets.Load to access a specified asset path.

```csharp
protected override void OnCreate() {
    base.OnCreate();
    var json = ModHost.Assets.Load<TextAsset>("Assets/MyModFolder/Animations.json"); // Change the path to match your mod folder structure
}
```

--------------------------------

### Update 'Hello World' Node with Input and Hot Reload in C#

Source: https://docs.warudo.app/docs/scripting/creating-your-first-script

This C# code updates the existing Warudo node to include an integer input for a 'Lucky Number' and modifies the message to display this number. It demonstrates Warudo's hot-reloading capability, allowing changes to be reflected without restarting the application. The node still requires Warudo.Core namespaces.

```csharp
using Warudo.Core;
using Warudo.Core.Attributes;
using Warudo.Core.Graphs;

[NodeType(Id = "c76b2fef-a7e7-4299-b942-e0b6dec52660", Title = "Hello World")]
public class HelloWorldNode : Node {

    // New code below
    [DataInput]
    [IntegerSlider(1, 100)] 
    public int LuckyNumber = 42;
    // New code above

    [FlowInput]
    public Continuation Enter() {
        // Changed code below
        Context.Service.PromptMessage("Hello World!", "This node is working! My lucky number: " + LuckyNumber);
        return Exit;
    }
          
    [FlowOutput]
    public Continuation Exit;
      
}
```

--------------------------------

### Set Character Rotation with Specific Angles

Source: https://docs.warudo.app/docs/blueprints/tutorials/spinning

This node sets the rotation of the character asset to specific Euler angles (X, Y, Z). It's used here to demonstrate a direct rotation, for example, to face the back of the chair.

```Warudo Nodes
Set Asset Rotation (Rotation: (0, 180, 0))
```

--------------------------------

### C# Plugin Script for Warudo

Source: https://docs.warudo.app/docs/scripting/creating-your-first-plugin-mod

This C# script defines a plugin for Warudo, inheriting from the base 'Plugin' class. It uses attributes to specify plugin metadata like ID, name, version, and the types of assets and nodes it provides. The 'OnCreate' method logs a message when the plugin is enabled. Dependencies include UnityEngine and Warudo core libraries.

```csharp
using UnityEngine;
using Warudo.Core.Attributes;
using Warudo.Core.Plugins;

[PluginType(
    Id = "hakuyatira.helloworld",
    Name = "Hello World",
    Description = "A simple plugin that says hello to the world.",
    Version = "1.0.0",
    Author = "Hakuya Tira",
    SupportUrl = "https://docs.warudo.app",
    AssetTypes = new [] { typeof(CookieClickerAsset) },
    NodeTypes = new [] { typeof(HelloWorldNode) })]
public class HelloWorldPlugin : Plugin {

    protected override void OnCreate() {
        base.OnCreate();
        Debug.Log("The Hello World plugin is officially enabled! Hooray!");
    }

}
```

--------------------------------

### Instantiating Assets and Nodes in Warudo

Source: https://docs.warudo.app/docs/scripting/api/scene

This C# code snippet shows how to add new assets (e.g., CharacterAsset) to the scene, either by type or by a specific type ID. It also demonstrates how to add new nodes to an existing blueprint, again by type or type ID, and how to broadcast scene updates.

```csharp
var newCharacterAsset = scene.AddAsset<CharacterAsset>(); // Instantiate a new character asset
var newCharacterAssetByTypeId = scene.AddAsset("726ab674-a550-474e-8b92-66526a5ad55e"); // Instantiate a new character asset by type ID

var blueprint = scene.GetGraphs().Values.First(); // Get the first blueprint in the scene
var newNode = blueprint.AddNode<ToggleCharacterMeshesNode>(); // Instantiate a new node
var newNodeByTypeId = blueprint.AddNode("e931f780-e41e-40ce-96d0-a4d47ca64853"); // Instantiate a new node by type ID

Context.Service.BroadcastOpenedScene(); // Send the updated scene to the editor

```

--------------------------------

### Implement Custom Type Converter in C#

Source: https://docs.warudo.app/docs/scripting/api/nodes

Shows how to create a custom type converter by inheriting from DataConverter<T1, T2>. This example converts a float to an int by truncation. Custom converters enable automatic data type conversion between connected nodes.

```csharp
public class MyFloatToIntConverter : DataConverter<float, int>
{
    public override int Convert(float data) => (int) data;
}
```

--------------------------------

### Read/Write Files with Persistent Data Manager in C#

Source: https://docs.warudo.app/docs/scripting/api/io

Illustrates using the Context.PersistentDataManager to interact with a restricted file system for non-serializable data. It provides examples for reading and writing byte arrays to a specified path within the data folder.

```csharp
var bytes = await Context.PersistentDataManager.ReadFileBytesAsync("MyPlugin/MyProfileImage.png");
await Context.PersistentDataManager.WriteFileBytesAsync("MyPlugin/MyProfileImage.png", bytes);
```

--------------------------------

### Create Cookie Clicker Custom Asset (C#)

Source: https://docs.warudo.app/docs/scripting/creating-your-first-script

Defines a custom asset for Warudo that simulates a cookie clicker game. It uses attributes like AssetType, Markdown, DataInput, and Trigger to define its properties, appearance, and functionality. The asset increments a cookie count based on a multiplier when the 'GimmeCookie' method is triggered.

```csharp
using Warudo.Core.Attributes;  
using Warudo.Core.Scenes;  
  
[AssetType(Id = "82ae6c21-e202-4e0e-9183-318e2e607672", Title = "Cookie Clicker")]  
public class CookieClickerAsset : Asset {  
  
    [Markdown]   
    public string Status = "You don't have any cookies.";  
  
    [DataInput]   
    [IntegerSlider(1, 10)]  
    [Description("Increase me to get more cookies each time!")]  
    public int Multiplier = 1;  
  
    private int count;
  
    [Trigger]  
    public void GimmeCookie() {  
        count += Multiplier;  
        SetDataInput(nameof(Status), "You have " + count + " cookie(s).", broadcast: true);  
    }  
  
    protected override void OnCreate() {  
        base.OnCreate();  
        SetActive(true);  
    }  
  
}
```

--------------------------------

### Spawning Multiple Plushies with For Loop

Source: https://docs.warudo.app/docs/blueprints/tutorials/buried

This snippet demonstrates how to use a For Loop to repeatedly trigger an action, specifically spawning and throwing a prop at a character. It sets up a hotkey to initiate the process and configures the For Loop to run 100 times with a small interval, resulting in a rapid succession of thrown props.

```blueprint
On Keystroke Pressed (Ctrl+Shift+Z)
  For Loop (Last Index: 100, Interval: 0.01)
    Throw Prop At Character (Prop Source: Tiger, From: Above Character Head)
```

--------------------------------

### Continuous Character Rotation using On Update

Source: https://docs.warudo.app/docs/blueprints/tutorials/spinning

This setup utilizes the 'On Update' node to continuously apply rotation to the character every frame, creating a smooth, automatic spinning effect. The increment value can be adjusted to control speed.

```Warudo Nodes
On Update -> Set Asset Rotation (Rotation: ... (logic for incremental rotation))
```

--------------------------------

### Get Localized String in C#

Source: https://docs.warudo.app/docs/scripting/api/localization

Demonstrates how to retrieve a localized string using the `Localized()` extension method in C#. This method requires the `Warudo.Core.Localization` namespace. It falls back to English if the string is not found in the current language, and returns the string ID if not found in English.

```csharp
using Warudo.Core.Localization; // Import the namespace that contains the extension method
  
// Assume the user language is set to English  
"FACE_TRACKING".Localized() // "Face Tracking"
"ALIVE_TIME_DESCRIPTION".Localized() // "The prop will be destroyed after this time."
```

--------------------------------

### Auto-Complete Resource Selection for String Inputs

Source: https://docs.warudo.app/docs/scripting/api/ports-and-triggers

Demonstrates using `[AutoCompleteResource]` to provide a dropdown list of available resources of a specified type for string data inputs.

```csharp
public class ExampleEntity
{
    [DataInput]
    [AutoCompleteResource("CharacterAnimation", defaultLabel: "Select Animation")]
    public string CurrentAnimation = "Idle";
}

```

--------------------------------

### Manually Trigger Flow Output with InvokeFlow

Source: https://docs.warudo.app/docs/scripting/api/nodes

This C# example demonstrates how to manually trigger a flow output at a later time or conditionally using the 'InvokeFlow' method. It uses an asynchronous method to delay the invocation of a specified flow output port (e.g., 'Exit') after a certain duration.

```csharp
[FlowInput]
public Continuation Enter() {
    async void TriggerExitLater() {
        await UniTask.Delay(TimeSpan.FromSeconds(5));
        InvokeFlow(nameof(Exit)); // Start a new flow from the "Exit" output port
    }
    return null; // You still need to return a Continuation. Since *this* flow technically ends here, we return null
}
```

--------------------------------

### Auto-Complete Dropdown List from Method

Source: https://docs.warudo.app/docs/scripting/api/ports-and-triggers

Explains how to use `[AutoCompleteList]` to populate a dropdown menu for string data inputs based on the results of a specified method, supporting asynchronous methods and forced selection.

```csharp
using System;
using System.Linq;
using System.Threading.Tasks;

public class AutoCompleteList
{
    public static AutoCompleteList Single(IEnumerable<AutoCompleteEntry> entries) => new AutoCompleteList { Entries = entries.ToArray() };
    public AutoCompleteEntry[] Entries { get; set; }
}

public class AutoCompleteEntry
{
    public string label;
    public string value;
}

public class ExampleEntity
{
    private string[] vipNames = { "Alice", "Bob", "Charlie" };

    [DataInput]
    [AutoCompleteList(nameof(AutoCompleteVipName), forceSelection: true)]
    public string VipName = "Alice";

    protected async Task<AutoCompleteList> AutoCompleteVipName() {
        return AutoCompleteList.Single(vipNames.Select(name => new AutoCompleteEntry {
            label = name,  // This is what the user sees
            value = name   // This is the actual value stored
        }));
    }
}

```

--------------------------------

### Reset Character Bone Scale

Source: https://docs.warudo.app/docs/blueprints/tutorials/squashing

This setup allows resetting the character's head bone scale back to its original size. It utilizes a 'Set Character Bone Scale' node connected to an 'Enter' flow input, which can be triggered manually or via a hotkey.

```Blueprint
Set Character Bone Scale -> Head Bone -> Scale (1, 1, 1)
```

--------------------------------

### Displaying Data Inputs as Markdown Text

Source: https://docs.warudo.app/docs/scripting/api/ports-and-triggers

Illustrates how to display string data inputs as non-editable Markdown text using the `[Markdown]` attribute, with an option for primary display.

```csharp
public class ExampleEntity
{
    [DataInput]
    [Markdown]
    public string WelcomeMessage = "# Welcome to Warudo!";

    [DataInput]
    [Markdown(primary: true)]
    public string ImportantInfo = "## Important Announcement";
}

```

--------------------------------

### Toggle Mesh on YouTube Super Chat Event

Source: https://docs.warudo.app/docs/blueprints/tutorials/toggle-meshes

This blueprint example shows how to use an event node, specifically 'On YouTube Super Chat Received', to trigger the toggling of a character mesh. This illustrates the 'if X, then Y' paradigm where an external event (Super Chat) leads to an in-game action (toggling a mesh).

```blueprint
On YouTube Super Chat Received
  -> Toggle Character Meshes (Character: [Your Character], Meshes: [Jacket Mesh])
```
Tokens:
Raw