mirror of
https://github.com/MrUnknownDE/vcc-tools.git
synced 2026-04-16 06:23:43 +02:00
74 lines
4.1 KiB
Markdown
74 lines
4.1 KiB
Markdown
# 🛠️ MrUnknownDE VRChat Unity Tools
|
|
|
|
Welcome to the **MrUnknownDE VRChat Unity Tools** repository. This is a collection of customized, lightweight, and high-performance Unity Editor tools designed specifically to improve the workflow of VRChat World Creators.
|
|
|
|
Instead of dealing with standalone applications or command-line interfaces, these tools bring essential DevOps and social features directly into your Unity Editor.
|
|
|
|
---
|
|
|
|
## 📦 Current Tools in this Package
|
|
|
|
### 1. Git Version Control System
|
|
A fully integrated Source Control Panel built directly into Unity. No more context-switching between the editor and external Git clients.
|
|
- **Smart Initialization:** Enter a Gitea/GitHub remote URL, and the tool will automatically handle the `init`, branch setup, and pull/merge existing server data before pushing your local project.
|
|
- **VS Code Style Interface:** Compact overview of modified, added, deleted, and untracked files.
|
|
- **Auto-Save Hook:** Pressing `CTRL+S` in Unity or changing focus automatically refreshes the Git status.
|
|
- **Timestamp Commits:** If you don't provide a custom commit message, the tool gracefully falls back to a clean timestamp format.
|
|
- **Interactive File Explorer:** Double-click any file to open the built-in Code Diff Viewer right inside the Editor.
|
|
- **Revert (Panic Button):** Easily discard all uncommitted changes if an experiment goes wrong.
|
|
|
|
### 2. Discord Rich Presence (RPC)
|
|
Let your community know what you are working on without saying a word.
|
|
- **Live Status:** Shows your current active Unity scene directly on your Discord profile.
|
|
- **Privacy Mode:** Hide the scene name if you are working on an unannounced or secret project.
|
|
- **Custom Status:** Add custom text (e.g., "Baking Lightmaps..." or "Writing Udon Scripts") to your Discord activity.
|
|
|
|
---
|
|
|
|
## ⚖️ ⚠️ Achtung: Law & Order (The German Way)
|
|
|
|
Now it's getting serious—or as we say in Germany: **"Jetzt wird es deutsch!"** 🇩🇪
|
|
|
|
### The "Assets Folder" Rule
|
|
Listen up, because the German Copyright Law (*Urheberrechtsgesetz*) doesn't take jokes lightly.
|
|
|
|
**DO NOT upload your paid Assets, Store-bought Plugins, or copyrighted Prefabs into a PUBLIC Repository.** If you distribute copyrighted material from creators without permission:
|
|
- **Civil Law:** You could face fines (Schadensersatz) that will make your bank account cry.
|
|
- **Criminal Law:** According to § 106 UrhG, unauthorized exploitation of copyrighted works can lead to **up to 3 years in prison** or heavy fines.
|
|
|
|
**Pro-Tip:** Always use a **Private Repository** (e.g., on a private Gitea server or a private GitHub repo) if your project contains paid assets. Your wallet and your freedom will thank you. Don't let the "Abmahnanwalt" be your first beta tester ;)
|
|
|
|
---
|
|
|
|
## 🚀 Installation
|
|
|
|
This tool is installed manually directly into your Unity project.
|
|
|
|
### Direct Folder Drop
|
|
1. Download the latest `mrunknownde-vcc-tools-v20xx-xx-xx.zip` release.
|
|
2. Extract the archive.
|
|
3. Drag and drop the extracted folder directly into the `Assets` directory inside your Unity project's root folder (using Windows Explorer / File Explorer, not inside the Unity Editor window). Unity will automatically compile the tools.
|
|
|
|
---
|
|
|
|
## 🕹️ Usage
|
|
|
|
Once installed, you can access the tools via the top menu bar in Unity:
|
|
|
|
`Tools` -> `MrUnknownDE` -> `GIT Version Control`<br>
|
|
`Tools` -> `MrUnknownDE` -> `Discord RPC`
|
|
|
|
The tools will open as floating windows. You can easily dock them into your custom Unity layout (e.g., right next to the Inspector or Console).
|
|
|
|
---
|
|
|
|
## ⚠️ Prerequisites & Troubleshooting
|
|
|
|
- **Git Installation:** You must have Git installed on your Windows machine. If the tool does not detect Git, it will provide a download link within the Unity UI.
|
|
- **Environment Variables:** If you just installed Git, **you must completely restart Unity Hub and the Unity Editor** so Windows can load the new `PATH` variables.
|
|
- **Authentication:** For automatic pushes to remote servers (Gitea/GitHub) to work seamlessly, ensure you have SSH keys or cached Git credentials configured on your system. Unity cannot intercept terminal password prompts.
|
|
|
|
---
|
|
|
|
*Built with ❤️ for the VRChat Community.*
|