Update AI disclosure for HellionChat
This commit is contained in:
+46
-38
@@ -1,19 +1,18 @@
|
|||||||
# AI assistance disclosure
|
# AI Assistance Disclosure
|
||||||
|
|
||||||
This fork uses AI assistance per the [Dalamud Plugin AI Usage Policy](https://github.com/goatcorp/DalamudPluginsD17/)
|
HellionChat uses AI assistance per the
|
||||||
|
[Dalamud Plugin AI Usage Policy](https://github.com/goatcorp/DalamudPluginsD17/)
|
||||||
at the **Pair** level.
|
at the **Pair** level.
|
||||||
|
|
||||||
A note up front: Hellion Chat is currently in a rebuild and adjustment
|
A note up front: HellionChat is currently not submitted to the official
|
||||||
phase, and there are no plans to submit it to the Dalamud team for review
|
Dalamud plugin repository and technically has no obligation to disclose
|
||||||
while it stays standalone. If the plugin stays out of the official repo I
|
this. I would rather be upfront about how it is built.
|
||||||
technically wouldn't need to disclose any of this, but I'd rather be
|
|
||||||
upfront about how it's built.
|
|
||||||
|
|
||||||
Hellion Chat is my entry point into game modding and plugin development. I
|
HellionChat is my entry point into game modding and plugin development.
|
||||||
have never written a plugin for a game before. I work alone, so I get help
|
I have never written a plugin for a game before. I work alone, so I get
|
||||||
where I need it. That's not something I want to hide.
|
help where I need it. That is not something I want to hide.
|
||||||
|
|
||||||
## How I actually work
|
## How I Actually Work
|
||||||
|
|
||||||
I plan the architecture, decide what gets built, and own every design
|
I plan the architecture, decide what gets built, and own every design
|
||||||
decision. For each change I:
|
decision. For each change I:
|
||||||
@@ -23,55 +22,64 @@ decision. For each change I:
|
|||||||
- Read the Dalamud log output to verify behaviour
|
- Read the Dalamud log output to verify behaviour
|
||||||
- Run security and privacy audits on anything that touches user data
|
- Run security and privacy audits on anything that touches user data
|
||||||
|
|
||||||
One of the main reasons I use AI is consistency. I want the Hellion code to
|
One of the main reasons I use AI is consistency. I want the HellionChat
|
||||||
match the style of the upstream Chat 2 codebase and stay readable for
|
code to match the style of the upstream Chat 2 codebase and stay
|
||||||
anyone who opens the repo, not just for me. Claude helps me catch when I'm
|
readable for anyone who opens the repo, not just for me. Claude helps
|
||||||
drifting from upstream conventions or writing something that only makes
|
me catch when I am drifting from upstream conventions or writing
|
||||||
sense in my own head.
|
something that only makes sense in my own head.
|
||||||
|
|
||||||
The balance is shifting toward more hand-written work as I get more
|
The balance is shifting toward more hand-written work as I get more
|
||||||
comfortable with Dalamud and plugin development in general.
|
comfortable with Dalamud and plugin development in general.
|
||||||
|
|
||||||
## What AI is used for
|
## What AI Is Used For
|
||||||
|
|
||||||
- API explanations (Dalamud, ImGui, .NET specifics I haven't worked with before)
|
- API explanations (Dalamud, ImGui, .NET specifics I have not worked
|
||||||
|
with before)
|
||||||
- Code drafts that I read, edit, and integrate
|
- Code drafts that I read, edit, and integrate
|
||||||
- Pattern suggestions and code review
|
- Pattern suggestions and code review
|
||||||
- Keeping the style aligned with the upstream Chat 2 codebase
|
- Keeping style aligned with the upstream Chat 2 codebase
|
||||||
|
|
||||||
## What AI isn't used for
|
## What AI Is Not Used For
|
||||||
|
|
||||||
- **Visual assets.** Logos, icons, banners, and screenshots are human-drawn
|
- **Visual assets.** Logos, icons, banners, and screenshots are
|
||||||
or taken from the running game.
|
human-drawn or taken from the running game.
|
||||||
- **German translations.** Written by me as a native speaker.
|
- **German translations.** Written by me as a native speaker.
|
||||||
|
|
||||||
## What's where
|
## What Is Where
|
||||||
|
|
||||||
Upstream Chat 2 (by Infi & Anna, EUPL-1.2) is the foundation and was not
|
Upstream Chat 2 (by Infi & Anna, EUPL-1.2) is the foundation and was
|
||||||
produced with AI assistance. Hellion-specific code lives in
|
not produced with AI assistance. HellionChat-specific code lives in
|
||||||
`HellionChat/Privacy/`, `HellionChat/Export/`, `HellionChat/Resources/HellionStrings*`,
|
`HellionChat/Privacy/`, `HellionChat/Export/`,
|
||||||
`Ui/SettingsTabs/Privacy.cs`, `Ui/FirstRunWizard.cs`, `Ui/HellionStyle.cs`,
|
`HellionChat/Resources/HellionStrings*`, `Ui/SettingsTabs/Privacy.cs`,
|
||||||
plus the Migrate3 recovery and plugin layout migration in `MessageStore.cs`
|
`Ui/FirstRunWizard.cs`, `Ui/HellionStyle.cs`, plus the Migrate3
|
||||||
and `Plugin.cs`. These were developed with Pair-level assistance as
|
recovery and plugin layout migration in `MessageStore.cs` and
|
||||||
|
`Plugin.cs`. These were developed with Pair-level assistance as
|
||||||
described above.
|
described above.
|
||||||
|
|
||||||
## If AI-assisted development is a dealbreaker for you
|
## If AI-Assisted Development Is a Dealbreaker for You
|
||||||
|
|
||||||
Fair enough. There are solid alternatives that don't rely on AI in their
|
Fair enough. There are solid alternatives:
|
||||||
development:
|
|
||||||
|
|
||||||
- [Chat 2](https://github.com/Infiziert90/ChatTwo), the original upstream
|
- [Chat 2](https://github.com/Infiziert90/ChatTwo), the upstream
|
||||||
this fork is based on
|
project HellionChat is built on
|
||||||
- [XIV Instant Messenger](https://github.com/NightmareXIV/XIVInstantMessenger),
|
- [XIV Instant Messenger](https://github.com/NightmareXIV/XIVInstantMessenger),
|
||||||
a different approach to chat in FFXIV
|
a different approach to FFXIV chat
|
||||||
|
|
||||||
Both are good projects. Use what fits you best.
|
Both are good projects. Use what fits you best.
|
||||||
|
|
||||||
## Tooling
|
## Tooling
|
||||||
|
|
||||||
- Claude (Anthropic) via Claude Code CLI
|
| Tool | Purpose |
|
||||||
- Context7 / Microsoft Learn for current Dalamud and .NET documentation
|
| ---- | ------- |
|
||||||
|
| [Claude](https://claude.ai) (Anthropic) | Pair-level AI assistance via Claude Code CLI |
|
||||||
|
| [VS Code](https://code.visualstudio.com) + C# Dev Kit | Primary IDE |
|
||||||
|
| Dedicated Windows 11 VM | Build and in-game test environment (Dalamud requires Windows) |
|
||||||
|
| [dalamud.dev](https://dalamud.dev) | Dalamud API reference |
|
||||||
|
| [Microsoft Learn](https://learn.microsoft.com) | .NET and C# documentation |
|
||||||
|
| [Context7](https://context7.com) | Up-to-date library docs for Claude context |
|
||||||
|
| [Stack Overflow](https://stackoverflow.com) | General C# and .NET problem-solving |
|
||||||
|
|
||||||
## Contact
|
## Contact
|
||||||
|
|
||||||
Questions about this disclosure: <https://github.com/JonKazama-Hellion/HellionChat/issues>.
|
Questions about this disclosure:
|
||||||
|
<https://github.com/JonKazama-Hellion/HellionChat/issues>
|
||||||
|
|||||||
Reference in New Issue
Block a user