F8 Features Exceltool Workflow
Developmentf8-features-exceltool-workflowF8 Features Exceltool 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 ExcelTool feature workflows — config table loading, Excel binary/JSON generation, variant support, and runtime data access in F8Framework.
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.
Inspect the Agent Skill at https://github.com/TippingGame/F8Framework/blob/HEAD/Tests/AISkills/f8framework-skills/features/f8-features-exceltool-workflow/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/f8-features-exceltool-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.
ExcelTool Feature Workflow
⚠️ IMPORTANT: Before using this feature, you MUST formally initialize F8Framework in the launch sequence. Ensure
ModuleCenter.Initialize(this);has run first, then create the required module, for exampleFF8.Config = ModuleCenter.CreateModule<F8DataManager>();.
Use this skill when
- The task is about config tables, Excel data reading, or data class generation.
- The user asks about F8 (generate) or F7 (runtime reload) shortcuts.
- The user needs to define new data types, containers, enums, or variants in Excel.
- Troubleshooting config loading failures or type mismatches.
Path resolution
- Prefer project source at Assets/F8Framework.
- If F8Framework is installed as a package, use Packages/F8Framework.
- For usage docs, read: Assets/F8Framework/Tests/ExcelTool/README.md
Sources of truth
- Runtime module: Assets/F8Framework/Runtime/ExcelTool
- Editor module: Assets/F8Framework/Editor/ExcelTool
- Generated data classes: Assets/F8Framework/ConfigData
- Excel source: Assets/StreamingAssets/config/*.xlsx
- Test docs: Assets/F8Framework/Tests/ExcelTool
Key classes and interfaces
| Class | Role |
|---|---|
ConfigManager | Core module. Access via FF8.Config. Loads and queries config data. |
ReadExcel | Reads Excel files. Extensible for custom types. |
API quick reference
Loading config data
// Load single sheet by name
Sheet1 sheet1 = FF8.Config.Load<Sheet1>("Sheet1");
// Sync load all
FF8.Config.LoadAll();
// Async load all (coroutine)
yield return FF8.Config.LoadAllAsyncIEnumerator();
// Async load all (async/await — WebGL compatible)
await FF8.Config.LoadAllAsyncTask();
// Runtime Excel reload (development only)
FF8.Config.RuntimeLoadAll();
Querying data
// Get single row by ID
LogF8.Log(FF8.Config.GetSheet1ByID(2).name);
// Iterate all rows
foreach (var item in FF8.Config.GetSheet1())
{
LogF8.Log(item.Key);
LogF8.Log(item.Value.name);
}
Variant support (multi-language/multi-version configs)
// Set global variant name
FF8.Config.VariantName = "English";
// Set per-sheet variant name (higher priority)
Sheet1.VariantName = "English";
Excel type system
Basic types
char, bool, byte, short, int, long, float, double, decimal, str/string, obj/object, datetime, sbyte, ushort, uint, ulong
Unity types: vec2/vector2, vec3/vector3, vec4/vector4, vec2int/vector2int, vec3int/vector3int, quat/quaternion, color, color32, matrix4x4
Standard JSON specification type: json
Container types
- Arrays:
int[],string[][],obj[][][] - Lists:
list<obj> - Dictionaries:
dict<int,list<string>> - ValueTuples:
valuetuple<int,string>(up to 7 types) - HashSets:
hashset<int>
Special types
- Enums:
enum<name,int,Flags>{Value1=1,Value2=2} - Variants:
variant<name,variantName>— switch configs by variant name
Row/column exclusion
- Skip entire row: leave
idempty - Skip entire column: leave
typeornameempty
Workflow
- Create Excel files in
Assets/StreamingAssets/config/directory. - Set first column as
inttypeid(unique primary key). - Row 1 = types, Row 2 = field names, Row 3+ = data.
- Press F8 to generate binary files and C# data classes.
- Generated files appear in
Assets/F8Framework/ConfigData/andAssets/AssetBundles/Config/BinConfigData/. - In code, call
FF8.Config.LoadAll()before accessing data. - Press F7 for runtime Excel reload (development only).
- For variants, add
variant<fieldName,variantName>columns.
Common error handling
| Error | Cause | Solution |
|---|---|---|
| Compilation errors after F8 | Naming conflicts in generated classes | Check ConfigData/ for duplicates, clean and regenerate |
| Data class not found | Sheet name mismatch | Ensure sheet name matches exactly (case-sensitive) |
| Android runtime Excel read fails | StreamingAssets not directly readable | Use SyncStreamingAssetsLoader or binary cache mode |
| Dictionary key error in JSON export | Container key type not supported in JSON | Use binary format which supports all key types |
Cross-module dependencies
- AssetManager: Binary/JSON config files loaded via
FF8.Asset. - Localization: Can use variant type as lightweight localization alternative.
Output checklist
- Excel structure defined (types, names, data).
- F8/F7 generation verified.
- Data access code validated.
- Validation status and remaining risks.