Vignette is a face tracking software for characters using osu!framework. Unlike most solutions, Vignette is:

• Made with osu!framework, the game framework that powers osu!lazer, the next iteration of osu!.
• Open source, from the very core.
• Always evolving - Vignette improves every update, and it tries to know you better too, literally.

We provide releases from GitHub Releases and also from Visual Studio App Center. Vignette releases builds for a select few people before we create a release here, so pay attention.

You can also run Vignette by cloning the repository and running this command in your terminal.

dotnet run --project Vignette.Desktop

Please make sure you meet the prerequisites:

• A desktop platform with .NET 5.0 SDK installed.
• Have provided proper credentials to access the GitHub Packages.
• Provide your own copy of the Live2D Cubism SDK.

Open your NuGet Configuration (global or user-scoped) and append this inside the configuration:

<packageSourceCredentials>
   <Vignette>
      <add key="Username" value="YourGitHubUserName"/>
      <add key="ClearTextPassword" value="YourGitHubPAT"/>
   </Vignette>
</packageSourceCredentials>

Your GitHub PAT (personal access token) should have the read:packages scope to access this organization's NuGet feed.

• See this article for more information about configuring GitHub Packages for NuGet and .NET.
• See this also for more information about creating a personal access token.

Due to restrictions, we are unable to provide the SDK publicly. However, you can still run Vignette by manually including these files when building.

1. Download the SDK through this link.
2. Extract the correct library for your operating system and architecture in the root of the build directory.

With this, the application will be able to pickup the libraries and start.

The style guide is defined in the .editorconfig at the root of this repository and it will be picked up in intellisense by capable editors. Please follow the provided style for consistency.

Vignette is Copyright © 2020 Ayane Satomi and the Vignette Authors, licensed under Non-Profit Open Source License v3.0. For the full license text please see the LICENSE file in this repository.

While Vignette is NPOSLv3, for-profit agencies who wish to use Vignette for their performers, please contact Ayane Satomi for a negotiation.