You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
refactor!: Rename library from MelonAccessibilityLib to UnityAccessibilityLib
BREAKING CHANGE: Package and namespace renamed for framework-agnostic usage.
- Rename namespace from MelonAccessibilityLib to UnityAccessibilityLib
- Update NuGet package ID to UnityAccessibilityLib
- Rename .csproj and .sln files
- Update README with both MelonLoader and BepInEx examples
- Add migration instructions for existing users
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: CLAUDE.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
4
4
5
5
## Project Overview
6
6
7
-
MelonAccessibilityLib is a C# library that adds screen reader accessibility to Unity games via MelonLoader mods. It provides speech and braille output, text cleaning utilities, and P/Invoke wrappers for UniversalSpeech with SAPI fallback.
7
+
UnityAccessibilityLib is a C# library that adds screen reader accessibility to Unity games. It works with any Unity mod framework (MelonLoader, BepInEx, etc.) and provides speech and braille output, text cleaning utilities, and P/Invoke wrappers for UniversalSpeech with SAPI fallback.
8
8
9
9
## Build Commands
10
10
@@ -24,20 +24,20 @@ dotnet build -c Release
24
24
dotnet pack -c Release
25
25
```
26
26
27
-
Build outputs are located at `bin/{Debug|Release}/{net6.0|net472|net35}/MelonAccessibilityLib.dll`.
27
+
Build outputs are located at `bin/{Debug|Release}/{net6.0|net472|net35}/UnityAccessibilityLib.dll`.
28
28
29
29
## Publishing a Release
30
30
31
31
To publish a new version to NuGet:
32
32
33
-
1.**Bump the version** in `MelonAccessibilityLib.csproj`:
33
+
1.**Bump the version** in `UnityAccessibilityLib.csproj`:
34
34
```xml
35
35
<Version>1.1.0</Version>
36
36
```
37
37
38
38
2.**Commit and tag** the release:
39
39
```bash
40
-
git add MelonAccessibilityLib.csproj
40
+
git add UnityAccessibilityLib.csproj
41
41
git commit -m "chore: Bump version to 1.1.0"
42
42
git tag v1.1.0
43
43
```
@@ -67,7 +67,7 @@ No test framework is currently configured. If adding tests, use standard `dotnet
67
67
### Data Flow
68
68
69
69
```
70
-
Consumer (MelonMod)
70
+
Consumer (MelonMod, BepInEx Plugin, etc.)
71
71
│
72
72
├─ Sets AccessibilityLog.Logger
73
73
├─ Calls SpeechManager.Initialize()
@@ -93,7 +93,7 @@ Consumer (MelonMod)
93
93
- All public classes are static (no instance creation)
94
94
- Private fields use `_camelCase` prefix
95
95
- P/Invoke constants use `ALL_CAPS`
96
-
- Single namespace: `MelonAccessibilityLib`
96
+
- Single namespace: `UnityAccessibilityLib`
97
97
- Comprehensive XML documentation on all public members
98
98
- Multi-target build: net35 is limited to C# 7.3 features
<Description>A reusable library for adding screen reader accessibility to Unity games via MelonLoader mods. Provides UniversalSpeech integration with SAPI fallback, text cleaning, and speech management.</Description>
<Description>A reusable library for adding screen reader accessibility to Unity games. Works with MelonLoader, BepInEx, or any Unity mod framework. Provides UniversalSpeech integration with SAPI fallback, text cleaning, and speech management.</Description>
0 commit comments