README.md

Challenge yourself to quit VRChat for a month while completing challenges and keeping track of yours and other's progress.

---

---

Build Dependencies

• .NET 6 SDK

To verify your .NET 6 installation run the following in your terminal:

dotnet --version

How to Build

Navigate into the /src directory of this project and run the following:

dotnet build

Config

In order to run VRChat API tests or run the application against a real VRChat API you're going to need to create a configuration file with the appropriate credentials.

⚠️ You shouldn't use your real VRChat account, instead, create a new one

⚠️ This will not work if the account has 2FA enabled

For Unit Tests

• Create a file and name it TestConfig.json in the /src/VrRetreat.Tests/ directory.

For Application Use

• Fill in your VRC credentials in /src/VrRetreat.WebApp/VrChatConfig.json

Contents

The contents of your config file should be as follows:

{
  "VrChatUsername": "Your-VrChat-Username-Here",
  "VrChatPassword": "Your-VrChat-Password-Here",
}

Database & Migrations

If you're the Visual Studio IDE you already have a local SQL Server ready.

On other platforms, you might need to install and configure an MSSQL server.

Applying Migrations

Before you can start using the application, you should apply all migrations.

First install the dotnet EF tools:

dotnet tool install --global dotnet-ef

💡 The --global flag installs the tool for your whole system

Then change your directory into the WebApp and update the database:

cd src/VrRetreat.WebApp
dotnet ef database update

hCaptcha

The registration view uses hCaptcha.

You might want to register your own hCaptcha account and fill in the src/VrRetreat.WebApp/appsettings.json hCaptcha section.