{"id":15036199,"url":"https://github.com/chanyavrc/vrcosclib","last_synced_at":"2025-04-09T23:21:28.450Z","repository":{"id":38086406,"uuid":"461860683","full_name":"ChanyaVRC/VRCOscLib","owner":"ChanyaVRC","description":"The OSC library for VRChat (.NET Standard)","archived":false,"fork":false,"pushed_at":"2025-03-08T10:13:28.000Z","size":291,"stargazers_count":50,"open_issues_count":3,"forks_count":2,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-24T01:11:42.381Z","etag":null,"topics":["csharp","csharp-library","osc","vrc","vrchat","vrchat-osc"],"latest_commit_sha":null,"homepage":"https://chanyavrc.github.io/VRCOscLib/","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ChanyaVRC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-21T12:53:24.000Z","updated_at":"2025-03-17T12:32:43.000Z","dependencies_parsed_at":"2024-09-24T20:30:33.578Z","dependency_job_id":null,"html_url":"https://github.com/ChanyaVRC/VRCOscLib","commit_stats":{"total_commits":171,"total_committers":5,"mean_commits":34.2,"dds":0.0292397660818714,"last_synced_commit":"39a0b566888213a44948e083dd07472589ef4359"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChanyaVRC%2FVRCOscLib","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChanyaVRC%2FVRCOscLib/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChanyaVRC%2FVRCOscLib/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChanyaVRC%2FVRCOscLib/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ChanyaVRC","download_url":"https://codeload.github.com/ChanyaVRC/VRCOscLib/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248126370,"owners_count":21051910,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csharp","csharp-library","osc","vrc","vrchat","vrchat-osc"],"created_at":"2024-09-24T20:30:29.449Z","updated_at":"2025-04-09T23:21:28.418Z","avatar_url":"https://github.com/ChanyaVRC.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eVRCOscLib\u003c/h1\u003e\n\u003ch2 align=\"center\"\u003eThe OSC library for VRChat (.NET Standard)\u003c/h2\u003e\n\u003cp align=\"center\"\u003e\u003ca href=\"https://discord.gg/u2BE6W5NMy\"\u003e\u003cimg alt=\"Discord\" src=\"https://img.shields.io/badge/Discord-Buildsoft%27s%20Discord%20Server-blue?logo=discord\"\u003e\u003c/a\u003e\u003c/p\u003e\n\n**VRCOscLib is now released!**\n\n## How to Install\n\nDownload \u0026 import the .nupkg from the [Releases](https://github.com/ChanyaVRC/VRCOscLib/releases) page.\n\nI can also download from [NuGet Package Manager](https://docs.microsoft.com/nuget/quickstart/install-and-use-a-package-in-visual-studio). See [nuget.org](https://www.nuget.org/packages/VRCOscLib/) for the NuGet package latest version.\n\n\n## Usage in code\nPlease check the `Sample` for the combination with the actual application.\n\n### About avatar parameters\nIf you want to control avatar parameters, use classes in `BuildSoft.VRChat.Osc.Avatar`.\n\n#### e.g.) Get and use avatar config model\n\n```cs\nusing System;\nusing BuildSoft.VRChat.Osc.Avatar;\n\n// get avatar config by avatar id.\nvar config = OscAvatarConfig.Create(\"avtr_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\")!;\n\nforeach (var parameter in config.Parameters.Items)\n{\n    Console.WriteLine($\"{parameter.Name}: \" +\n        $\"input {(parameter.Input != null ? \"○\" : \"×\")}, \" +\n        $\"output {(parameter.Output != null ? \"○\" : \"×\")}\"\n    );\n}\n```\n\n#### e.g.) Get current avatar config model\n\n```cs\nusing System;\nusing BuildSoft.VRChat.Osc.Avatar;\n\nvar config = OscAvatarConfig.CreateAtCurrent();\nif (config == null) {\n    Console.WriteLine(\"Failed to get the current avatar, Do \\\"Reset Avatar\\\" or start VRChat.\");\n}\n\n// Wait until you can get an avatar config.\nconfig = await OscAvatarConfig.WaitAndCreateAtCurrentAsync();\n```\n\n#### e.g.) Send avatar parameter\n\n```cs\nusing BuildSoft.VRChat.Osc.Avatar;\n\nvar config = await OscAvatarConfig.WaitAndCreateAtCurrentAsync();\n\nconfig.Parameters[\"IntParameterName\"] = 1;\nconfig.Parameters[\"FloatParameterName\"] = 12.2f;\nconfig.Parameters[\"BoolParameterName\"] = true;\n```\n\nor\n\n```cs\nusing BuildSoft.VRChat.Osc;\n\nOscParameter.SendAvatarParameter(\"IntParameterName\", 1);\nOscParameter.SendAvatarParameter(\"FloatParameterName\", 12.3f);\nOscParameter.SendAvatarParameter(\"BoolParameterName\", true);\n```\n\n#### e.g.) Get received avatar parameter\n\n```cs\nusing System;\nusing System.Threading.Tasks;\nusing BuildSoft.VRChat.Osc.Avatar;\n\nvar config = await OscAvatarConfig.WaitAndCreateAtCurrentAsync();\n\nawait Task.Delay(1000);\n\nConsole.WriteLine($\"parameterName = {config.Parameters[\"parameterName\"]}\");\n```\n\n### About button input\nIf you want to use button input with OSC, use classes in `BuildSoft.VRChat.Osc.Input`.  \nThere are 2 kinds of input, `OscAxisInput` can send a float value, and `OscButtonInput` can send a boolean value, press or release.\n\n#### e.g.) Send Input\n\n```cs\nusing System.Threading.Tasks;\nusing BuildSoft.VRChat.Osc.Input;\n\nOscAxisInput.LookVertical.Send(0.2f);\nawait Task.Delay(1000);\nOscAxisInput.LookVertical.Send(0f);\n\nOscButtonInput.Jump.Press();\nawait Task.Delay(1000);\nOscButtonInput.Jump.Release();\n```\n\n### About Chatbox\nIf you want to use button input with OSC, use classes in `BuildSoft.VRChat.Osc.Chatbox`.  \n\n#### e.g.) Send a string to Chatbox\n```cs\nusing BuildSoft.VRChat.Osc.Chatbox;\n\nOscChatbox.SendMessage(\"some message\", direct: true);\n```\n\n#### e.g.) Send a string to Chatbox UI\n```cs\nusing BuildSoft.VRChat.Osc.Chatbox;\n\nOscChatbox.SendMessage(\"some message\", direct: false);\n```\n\n#### e.g.) Act like typing\n```cs\nusing BuildSoft.VRChat.Osc.Chatbox;\nusing System.Threading.Tasks;\n\n// typing during 3 second.\nOscChatbox.SetIsTyping(true);\nawait Task.Delay(3000);\n\nOscChatbox.SendMessage(\"some message\", direct: true);\n```\n\n### How to change an avatar\nCan be changed an avatar by one of the following methods.\n* use `OscAvatarUtility.ChangeAvatar(id)`\n* use `OscAvatarConfig.Change()`\n* use `OscAvatar.Change()`\n\n#### e.g) Change avatar\n```cs\nusing BuildSoft.VRChat.Osc.Avatar;\n\nOscAvatarUtility.ChangeAvatar(\"avtr_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\");\n```\nor\n```cs\nusing BuildSoft.VRChat.Osc.Chatbox;\nusing System.Threading.Tasks;\n\nvar avatar = await OscAvatarConfig.WaitAndCreateAtCurrentAsync();\n\nawait Task.Delay(1000);\n\navatar.Change();\n```\n\n\n\u003c!-- ## Contact\n* Twitter: [@ChanyaVRChat1](https://twitter.com/ChanyaVRChat1)\n* Discord: [Chanya#0386](https://discord.com/channels/@me/924538047373115392) --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchanyavrc%2Fvrcosclib","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchanyavrc%2Fvrcosclib","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchanyavrc%2Fvrcosclib/lists"}