Skip to content

Contributing

PaperHammer edited this page May 22, 2026 · 1 revision

Thank you for your interest in contributing to VirtualPaper!

Getting Started

  1. Fork the repository and clone it locally.
  2. Install .NET 8.0 SDK.
  3. Open src/VirtualPaper.sln in Visual Studio 2022 or Rider.
  4. Build the solution — all dependencies are restored via NuGet automatically.

Project Structure

Project Role
VirtualPaper Core backend service (wallpaper control, playback, screen saver)
VirtualPaper.UI Main WinUI 3 application shell
VirtualPaper.WpSettingsPanel Wallpaper settings panel
VirtualPaper.DraftPanel Wallpaper creator / draft panel
VirtualPaper.PlayerWeb WebView2-based wallpaper player process
VirtualPaper.ML AI feature models (ONNX)
VirtualPaper.Core.Test Unit tests — backend
VirtualPaper.UI.Test Unit tests — UI ViewModels

Running Tests

dotnet test src/VirtualPaper.Core.Test/VirtualPaper.Core.Test.csproj
dotnet test src/VirtualPaper.UI.Test/VirtualPaper.UI.Test.csproj

Submitting Changes

  • Open an issue to discuss significant changes before sending a PR.
  • Follow the existing code style (checked via .editorconfig).
  • All new features should include unit tests.
  • PR titles should follow: feat:, fix:, refactor:, docs: prefixes.

Localization

Translation files are under src/VirtualPaper.UI/Strings/. Each locale is a separate .resw file. Copy the zh-CN file as a starting point.

Clone this wiki locally