F8 Features Obfuz Workflow
Developmentf8-features-obfuz-workflowF8 Features Obfuz Workflow is an Agent Skill for development published in the TippingGame/F8Framework repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Use when implementing or troubleshooting Obfuz feature workflows — code obfuscation and protection in F8Framework.
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/TippingGame/F8Framework/blob/HEAD/Tests/AISkills/f8framework-skills/features/f8-features-obfuz-workflow/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/f8-features-obfuz-workflow, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Obfuz Feature Workflow
⚠️ IMPORTANT: Before using this feature, you MUST formally initialize F8Framework in the launch sequence. Ensure
ModuleCenter.Initialize(this);has run first.
Use this skill when
- The task is about code obfuscation or protection using Obfuz.
- The user asks about protecting compiled assemblies from reverse engineering.
- The task includes Obfuz + HybridCLR integration or hot-update DLL obfuscation.
Path resolution
- Prefer project source at Assets/F8Framework.
- For usage docs, read both:
Assets/F8Framework/Tests/Obfuz/README.mdAssets/F8Framework/Tests/Obfuz/README_EN.md
- If docs need updates, keep the Chinese and English README files aligned.
Sources of truth
- Test docs:
Assets/F8Framework/Tests/Obfuz - Launcher/build integration points:
Assets/F8Framework/Editor/F8Helper/F8Helper.cs- hot-update entry
LoadDll.csin the target project
- Obfuz package / extension behavior as referenced by the test docs:
Assets/Packages/com.code-philosophy.obfuz4hybridclr/README.md
Key settings and integration points
| Item | Guidance |
|---|---|
| Obfuz import | Import Obfuz first from https://github.com/focus-creative-games/obfuz.git. |
AssembliesToObfuscate | Add Assembly-CSharp, F8Framework.Core, F8Framework.Launcher, F8Framework.F8ExcelDataClass. |
NonObfuscatedButReferenceingObfuscatedAssemblies | Add F8Framework.Core.Editor, F8Framework.Tests. |
| HybridCLR prebuild | Replace the HybridCLR-only prebuild command with Obfuz4HybridCLR.PrebuildCommandExt.GenerateAll();. |
| Encryption init | Move Obfuz EncryptionService initialization code to the hot-update entry LoadDll.cs. |
| API compatibility | Set Api Compatibility Level to .NET Framework. |
Workflow
- Import Obfuz into Unity first.
- Generate the Obfuz key by following the official quick-start guide, and mount the generated initialization code.
- Open the
ObfuzSettingswindow and populate the two assembly lists exactly as documented inTests/Obfuz/README.mdandREADME_EN.md. - If the project uses HybridCLR, update
F8Helper.cs:- in
GenerateCopyHotUpdateDll, replace the prebuild command withObfuz4HybridCLR.PrebuildCommandExt.GenerateAll(); - uncomment the branch that redirects DLL output to
GetObfuscatedHotUpdateAssemblyOutputPath(...)
- in
- Move the Obfuz
EncryptionServiceinitialization code into the hot-update entryLoadDll.cs. - Set
Api Compatibility Levelto.NET Framework. - Run F8 / build the project and verify the obfuscated output still works.
Common error handling
| Error | Cause | Solution |
|---|---|---|
| API compatibility errors | Compatibility level is too low | Switch Api Compatibility Level to .NET Framework |
| F8Framework code breaks after obfuscation | Too many framework assemblies are obfuscated | Try setting all F8Framework assemblies to non-obfuscated first, then narrow scope |
| Real-time Excel loading fails | Obfuz affects runtime config loading path | Use FF8.Config.RuntimeLoadAll() for runtime Excel reload |
GeneratedEncryptionVirtualMachine.cs init error | Generated file path is wrong | Fix the path in the ObfuzSettings window |
| HybridCLR hot-update DLL not found | F8Helper prebuild/output path not switched to Obfuz | Use Obfuz4HybridCLR.PrebuildCommandExt.GenerateAll() and the obfuscated output-path branch |
Cross-module dependencies
- HybridCLR: Required when hot-update DLLs also need Obfuz processing.
- Build/F8Helper: Obfuscation is wired into the prebuild/build pipeline.
- ExcelTool / Config: Real-time Excel reload may need
FF8.Config.RuntimeLoadAll()after integration.
Output checklist
- Obfuz import path confirmed.
- Obfuscation target assemblies defined.
- Non-obfuscated referencing assemblies defined.
- HybridCLR integration points updated when applicable.
- Encryption initialization location confirmed.
- Build test passed with obfuscation.
- Validation status and remaining risks.