Home / .NET / Miscellaneous

.NET Roslyn Analyzer for VRChat Udon and UdonSharp.

.NET Roslyn Analyzer for VRChat Udon and UdonSharp.
Information
Category: .NET / Miscellaneous
Watchers: 1
Star: 16
Fork: 0
Last update: Apr 29, 2021
Resource links
https://github.com/mika-f/UdonRabbit.Analyzer

UdonRabbit.Analyzer

Experimental .NET Roslyn Analyzer for VRChat Udon and UdonSharp.
This analyzer accelerates your Udon development with UdonSharp.
Check out the list of analyzers defined in this project.
Not enough types of analyzers in UdonRabbit.Analyzer?
You can check out the list of missing analyzers or create a new issues.

Features

  • It reports the part of the behaviour that doesn't work well on VRChat as an error in editor
  • It reports an error in the editor that about the syntax that cannot be compiled by the UdonSharp
  • etc

Getting Started

Requirements

  • Microsoft Visual Studio 2019 or IDE that supports Roslyn Analyzer
  • VRCSDK3 that supports Udon
  • UdonSharp

Development

Requirements

  • .NET 5
  • Visual Studio Version 16.8+ or Visual Studio for Mac 8.8+
  • Unity Project that containing VRCSDK3 and UdonSharp

How to develop

  1. Open Source/UdonRabbit.Analyzer.sln in your Visual Studio
  2. Start UdonRabbit.Analyzer.VSIX as debug profile
  3. After the Visual Studio Experimental Instance starts, open the Unity project that has VRCSDK3 and UdonSharp installed
  4. Open any source file that inherits from UdonSharp.UdonSharpBehaviour

Create a new analyzer

  1. Open Source/UdonRabbit.Analyzer.sln in your Visual Studio or other IDE
  2. Build UdonRabbit.Analyzer.CodeGen
  3. Run dotnet ./UdonRabbit.Analyzer.CodeGen.dll -i IDENTIFIER -l "CLASS_NAME" -t "TITLE" -d "DESCRIPTION" -m "MESSAGE_FORMAT" -c CATEGORY -s SEVERITY -w ../ in ROOT/bin
  4. Rebuild ResX in Visual Studio or run ResGen.exe
  5. Start Coding!

Testing

Requirements

  • .NET 5
  • Visual Studio Version 16.8+
  • Unity Project that containing VRCSDK3 and UdonSharp

How to test

  1. Configure the following environment variables in Source/UdonRabbit.Analyzer.Test/bin/Debug/net5.0/UdonRabbit.runsettings
    • UDONRABBIT_ANALYZER_TEST_PROJECT : Unity 2018.4.20f1 Test Project Location (.csproj)
      • Default: null (Current Directory)
      • I recommended to reference to Assembly-CSharp.csproj because it has all references to DLLs.
      • If you are not want to reference to Assembly-CSharp.csproj, add the following external references:
        • TextMeshPro
        • UdonSharp.Runtime
    • UDONRABBIT_ANALYZER_TEST_UDON_SHARP : UdonSharp.Runtime.dll Location
      • Default: null (Current Directory)
  2. Run dotnet test

Analyzer Documents

See https://docs.mochizuki.moe/udon-rabbit/packages/analyzer/ (ja-JP)

ScreenShots

Troubleshooting

I found a bug on VS/VS Code/Rider/Analyzer

If you find a bug, feel free to create a new issue!

Analyzer is not worked on UdonSharpBehaviour

You cannot run multiple UdonRabbit.Analyzer instances in the same Unity workspace.
Therefore, if you are running Analyzer in multiple editors, disable one.
If that doesn't work, we recommend restarting your PC.

License

MIT by @6jz

Third Party Notices

This project contains some code from the following project.
See method comments for details.

Links

Discord Server : https://discord.gg/h42BzsFtD2
Patreon : XXX

Contents

    MerlinVR USharpVideo - a basic video player made for VRChat using Udon and UdonSharp
    chsienki An In-Memory version of the Roslyn compiler that can be used to debug components in the Roslyn pipeline
    Vard-and-Temmie An interactive vinyl record player for vrchat
    bharatdwarkani Awesome collection of .NET Core Static Analyzers using the .NET Compiler Platform (Roslyn).
    platomav Intel Engine Firmware Analysis Tool
    Terri00 Udon 8 ball pool game / physics engine
    Microsoft Attack Surface Analyzer can help you analyze your operating system's security configuration for changes during software installation.
    dotMorten A Roslyn-based cross-platform tool that generates an object model diagram from a set of C# source files or assemblies
    dotnet The Roslyn .NET compiler provides C# and Visual Basic languages with rich code analysis APIs.
    conan-roslyn Lightweight fork of the .NET Compiler Platform ("Roslyn") by adding a compiler plugin infrastructure
    fantasticmao A lightweight (simplistic) log analyzer for Nginx.
    Preetam MySQL JSON Explain Analyzer
    cxaiverb A MelonLoader mod for VRChat to change your in-game reticle
    PiMaker GI Joe - Fake realtime GI for VRChat video players
    Testura Testura.Code is a wrapper around the Roslyn API and used for generation, saving and compiling C# code. It provides methods and helpers to generate classes, methods, statements and expressions.
    giggio A source generator for C# that uses Roslyn (the C# compiler) to allow you to generate your dependencies injection during compile time.
    Flangvik YouTube/Livestream project for obfuscating C# source code using Roslyn
    Jalalx HttpClientGenerator is a tool that uses the Roslyn code generator feature to write boilerplate HttpClient code for you.
    xoofx A lightweight utility library to create a Roslyn AdhocWorkspace from an existing solution or a csproj
    kzu Exposes project and assembly level information as constants in the ThisAssembly class using source generators powered by Roslyn.
    MiniProfiler A simple but effective mini-profiler for ASP.NET (and Core) websites
    Share this repo

    Related Repos


    Miscellaneous
    4
    Um Navegador Simples e leve para assistir vídeos ou escutar musicas!
    HiotyNi Minimal-Browser Um Navegador Simples e leve para assistir vídeos ou escutar musicas! Criado em C# Feito com a ideia de ser usado para ver videos e esc
     
    Miscellaneous
    108
    Process Ghosting in C#
    Wra7h SharpGhosting Process Ghosting (x64 only) in C# https://www.elastic.co/blog/process-ghosting-a-new-executable-image-tampering-attack Compile options:
     
    Miscellaneous
    17
    Telegraph app for desktop.
    New-dev0 Telegraph App made in CSharp in .NET [WPF] using Telegraph Api. Download Todo Good UI and screen gestures. Dark Mode? UWP ?? Good (Un)Installer ? Fix
     
    Miscellaneous
    202
    A parallel neural net microframework
    modern-fortran neural-fortran A parallel neural net microframework. Read the paper here. Features Getting started Building with fpm Building with CMake Examples Crea
     
    Miscellaneous
    6
    AspnetMicroservices See the overall picture of implementations on microservices with .net ...
    EduartHajko AspnetMicroservices See the overall picture of implementations on microservices with .net tools on real-world e-commerce microservices project;
     
    Miscellaneous
    5
    This repository detects a system vulnerable to CVE-2022-21907 and protects against this vu...
    mauricelambert CVE-2022-21907 Description This repository detects a system vulnerable to CVE-2022-21907 (CVSS:3.1 9.8) and protects against this vulnerability if des
     
    Miscellaneous
    4
    A Minecraft account checker
    D1og0 AerisChecker | https://discord.gg/e7uQY6SPtb A open-source Minecraft account checker FAQ Q: What features do you have? A: We have capes check (Optifin
     
    Miscellaneous
    3
    Resources for DFIR Professionals Responding to the Whispergate
    cado-security DFIR_Resources_Whispergate On Saturday January 15th 2022, Microsoft released a blog titled “Destructive malware targeting Ukrainian organizations”. Mi
     
    Miscellaneous
    3
    A Mac dev tool that streams the relative position/rotation of the headset and the controll...
    pascalbros Oculus Linkintosh There's no support for Oculus Quest 2 (and the old one) on Mac for development. The only way to test your game is to build and run d
     
    Miscellaneous
    3
    A small utility library to encode/decode Bech32 addresses
    Nano-Digital Bech32 A small utility library to encode/decode bech32 addresses with source code taken from https://github.com/guillaumebonnot/bech32 to encode/decod
     
    Miscellaneous
    3
    A simple procedural skybox which has day and night in unity universal render pipeline
    FlowingCrescent SimpleProceduralSkybox A simple procedural skybox which has day and night in unity universal render pipeline Unity version：2019.4.13f, URP 7.3.1 Pleas
     
    Miscellaneous
    3
    An example of using Polly's RateLimit policy in a ASP.NET Core Minimal API
    martincostello Polly Rate-Limiting with ASP.NET Core Introduction A sample application using ASP.NET Core Minimal APIs that demonstrates usage of the Rate-Limit poli
     
    Miscellaneous
    190
    Deep extensions to nn
    Element-Research dpnn : deep extensions to nn This package provides many useful features that aren't part of the main nn package. These include sharedClone, which allo
     
    Miscellaneous
    549
    Stanford NLP for .NET
    sergey-tihon Stanford.NLP for .NET Stanford.NLP for .NET is a port of Stanford NLP distributions to .NET. This project contains build scripts that recompile Stanfo
     
    Miscellaneous
    917
    GeneticSharp is a fast, extensible, multi-platform and multithreading C# Genetic Algorithm...
    giacomelli GeneticSharp is a fast, extensible, multi-platform and multithreading C# Genetic Algorithm library that simplifies the development of applications using Genetic Algorithms (GAs).