Profiles: add local player profiles and isolated learning progress

未關閉
#43 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
5/5
預估耗時
一週以上
新手友好度
25/100
Issue 類型
功能
描述清晰度
描述清楚
活躍度
冷清
技術堆疊
csharp, unity
領域
game-dev

研究方向

Start by locating the Unity startup flow, persistent progress storage, profile settings UI, and existing automated tests in the C# project. Identify the current unscoped progress model and the APIs that read or mutate it, then define the profile context, migration, and backup boundaries described in the issue. Done means the acceptance criteria pass, including isolation, safe migration, deterministic import/export, failure atomicity, and keyboard and drum-navigation support for profile selection.

由索引模型根據 Issue 內容生成。

描述

enhancement help wanted

Summary

Add local player profiles so multiple people can use the same HitTheKit installation without overwriting one another's learning progress, practice history, results, or preferences.

This foundation should remain local-first. It must not require an account, email address, cloud service, or backend.

User experience

When no profile exists, guide the player through creating the first one.

When multiple profiles exist, show a Who's playing? screen at startup with:

  • display name;
  • one original preset avatar;
  • practice level or progress summary when available;
  • total practice time;
  • most recent activity;
  • create-profile action;
  • manage-profile action.

When exactly one profile exists, the application may open it automatically while keeping profile switching available from the main menu or Settings.

An optional Play as guest entry may allow a temporary session that does not modify persistent player progress.

Profile identity

Each profile should contain only the minimum local identity data:

  • stable internal profile ID;
  • player-chosen display name;
  • preset avatar ID;
  • creation timestamp;
  • last-used timestamp.

Preset avatars must be original project assets. Do not collect a real name, email address, date of birth, photograph, or other unnecessary personal information.

Profile-scoped data

The following data should belong to the active player profile:

  • learning-path and lesson progress;
  • unlocked lessons or exercises;
  • song and lesson results;
  • accuracy, high scores, streaks, and personal bests where supported;
  • total and per-session practice time;
  • per-song and per-lesson statistics;
  • practice speed and difficulty preferences;
  • training preferences that affect the individual learning experience;
  • first-encounter/tutorial state;
  • accessibility preferences when they are intended to follow the player.

All persistence APIs must require an explicit profile identity or an active-profile context. A profile must never read or mutate another profile's progress accidentally.

Device-scoped data

The following data should remain shared by the installation unless a later requirement proves otherwise:

  • MIDI device discovery and hardware configuration;
  • electronic-drum mappings and local device profiles;
  • audio output and technical graphics settings;
  • local song-library folders;
  • local audio bindings and machine-specific file paths;
  • application update and installation settings.

The application language may remain installation-wide initially. If it becomes profile-specific later, that policy must be explicit and migration-safe.

Profile management

Players should be able to:

  • create a profile;
  • select and switch profiles outside an active gameplay session;
  • rename a profile;
  • change its preset avatar;
  • export a profile backup;
  • import a compatible profile backup;
  • delete a profile only after a clear confirmation;
  • understand which profile is currently active.

Switching profiles during an active lesson or song must be rejected or deferred until the session ends.

Backup boundary

Support both:

  1. exporting a single profile;
  2. exporting all local profiles when appropriate.

Backups must not automatically contain:

  • commercial audio;
  • local audio files;
  • machine-specific absolute paths;
  • credentials or secrets;
  • hardware identifiers that are not required for portable progress.

Import must validate the schema and avoid silently overwriting an existing profile. Profile-ID collisions need an explicit merge, replace, or create-copy policy.

Migration

Existing installations currently using unscoped progress must migrate safely:

  • create one default local profile;
  • attach existing compatible progress and practice history to that profile exactly once;
  • preserve device-scoped configuration;
  • make the migration idempotent;
  • retain a recoverable backup until migration succeeds.

Acceptance criteria

  • A new installation can create and select its first local profile.
  • Two profiles can complete different lessons without affecting each other.
  • Results, statistics, unlocks, and practice time are isolated by profile.
  • Shared MIDI/device and local song configuration remains available to both profiles.
  • The active profile is visible in the main experience and can be switched outside gameplay.
  • Profile switching is prevented or safely deferred during an active session.
  • Renaming or changing an avatar does not change the stable profile ID.
  • Deleting a profile requires confirmation and cannot delete another profile's data.
  • Single-profile and all-profile backups round-trip deterministically.
  • Import rejects malformed, incompatible, or ambiguous backups without partial state.
  • Backups contain no commercial media, credentials, or machine-specific absolute paths.
  • Existing unscoped progress migrates once to a default profile without resetting hardware configuration.
  • Automated tests cover creation, selection, isolation, switching, deletion, migration, backup, import, and failure atomicity.
  • The profile-selection screen works with mouse, keyboard, and supported drum-navigation input.

Out of scope

  • online accounts;
  • passwords or PIN protection;
  • cloud synchronization;
  • social profiles or leaderboards;
  • remote avatars or user-uploaded photographs;
  • parental-control or identity-verification systems;
  • backend services.

These can be evaluated later without making local profiles depend on them.

主要語言
C#
星號
0
分支
0
平均合併
16 小時 9 分鐘
30 天內合併 PR
7

環境準備

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

Codewriter90x/HitTheKit 的其他 Issue

查看 Codewriter90x/HitTheKit 的全部 Issue

相似的 Issue

更多 C# Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。