From 95ca6e3fdb7e682396149453c2fa4ff6eec8fc93 Mon Sep 17 00:00:00 2001 From: Louis_45 Date: Sun, 10 Dec 2023 16:06:59 +0100 Subject: [PATCH] Create README.md --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b3a4fc5 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# VRChat SDK Patcher Script + +[![Build executable with PyInstaller](https://github.com/Luois45/VRCSDK-Patcher/actions/workflows/build.yml/badge.svg)](https://github.com/Luois45/claim-free-steam-packages/actions/workflows/build.yml) +[![DeepSource](https://deepsource.io/gh/Luois45/VRCSDK-Patcher.svg/?label=active+issues&show_trend=true&token=eIo_r1Hx850IQIJEoUj3FaC5)](https://deepsource.io/gh/Luois45/claim-free-steam-packages/?ref=repository-badge) +[![Github All Releases](https://img.shields.io/github/downloads/Luois45/VRCSDK-Patcher/total.svg)](https://tooomm.github.io/github-release-stats/?username=Luois45&repository=claim-free-steam-packages) +[![License: GPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0) +[![built with: Python3](https://camo.githubusercontent.com/0d9fbff04202da688cc79c5ffe984bd171edf453b2e41e5e56e55202dd5bdbb2/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6275696c74253230776974682d507974686f6e332d7265642e737667)](https://www.python.org/) + +A patcher for the newer VRChat SDKs to disable upload limits which is easy to use and compatible only with VRChat Creator Companion Projects. + +## Instruction of usage + +1. Download the [Windows executable](https://github.com/Luois45/VRCSDK-Patcher/releases/latest) or just clone this repository +2. Execute the run.py script or the VRCSDK-Patcher.exe +3. Select the folder of the unity project you created using VCC which you want to patch the SDK of. +4. Enjoy using the SDK with most limits disabled + +## Support & Contributing +Anyone is welcome to contribute. If you decide to get involved, please take a moment and check out the following: + +* [Bug reports](.github/ISSUE_TEMPLATE/bug_report.md) +* [Feature requests](.github/ISSUE_TEMPLATE/feature_request.md) + +## License + +The code is under the [AGPL-3.0 License](https://choosealicense.com/licenses/agpl-3.0/).