diff --git a/README.md b/README.md new file mode 100644 index 0000000..d2769c5 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# VNyan node graph debug tool + +![image](https://github.com/user-attachments/assets/ff28ebe5-e3ba-4f05-bd5b-169b21f0f32c) + +This tool aims to make debugging complex node graphs easier by providing a way to log messages in real time from within your node graphs. +Start it from the plugins menu, and then use the two provided functions + +```_lum_dbg_log``` - Log a message to the console. All inputs will be logged +```_lum_dbg_err``` - The same thing, but in red + +## Installation + +Download from https://github.com/LumKitty/VNyan-Debug/releases +Unzip the zipfile into VNyan\Items\Assemblies (no subdirectories) +Yes the .exe is meant to be there. This thing works by spawning an external application and then sending messages to it. This is better than making a Unity UI for two reasons +1) More flexibility on where you put the window +2) Fuck making Unity UIs. If you can avoid doing this, you should + +## https://twitch.tv/LumKitty