Update README.md

README.md

@@ -1,3 +1,94 @@
----
-license: cc0-1.0
----
+---
+license: cc0-1.0
+task_categories:
+- reinforcement-learning
+tags:
+- factorio
+- gaming
+- game-ai
+- strategy
+size_categories:
+- 1K<n<10K
+---
+
+# Factorio Saves Metadata Dataset
+
+Metadata for 2,418 Factorio save files collected from public sources (speedrun.com, GitHub, forums). Covers game versions 0.6.3 through 2.0.64.
+
+## What's Included
+
+**CSV with 8 columns:**
+- `filename` - Renamed with metadata encoding (e.g., `factorio_0_16_51_0_vanilla_mid_tier1_replay_0042.zip`)
+- `type` - vanilla or modded
+- `size_mb` - File size
+- `game_version` - Factorio version string
+- `mods_used` - Number of mods (0-254)
+- `has_replay` - Boolean, checked for `replay.dat` inside zip
+- `playtime_category` - Estimated from file size (early/mid/late/mega)
+- `quality_tier` - Calculated score 1-3 (1=best)
+
+## Quick Stats
+
+- **2,418 saves total**
+- **801 with replays (33%)** - Contains action sequences for RL training
+- **72 game versions** - From 0.6.3 to 2.0.64
+- **958 vanilla** (40%) / **1,460 modded** (60%)
+
+## How Fields Were Calculated
+
+**has_replay**: Opened each zip, searched for `replay.dat` file anywhere in archive
+
+**playtime_category**: Heuristic based on file size adjusted for mod count
+- Mods inflate save size, so: `effective_size = size_mb × 0.6` if 50+ mods
+- Then: <5MB=early, 5-20MB=mid, 20-80MB=late, 80MB+=mega
+- Not actual playtime - just an estimate
+
+**quality_tier**: Scoring system
+- +40 points if has replay
+- +5 to +35 points based on playtime category
+- +10 if vanilla, +15 if heavily modded (20+ mods)
+- Score ≥50 = Tier 1, ≥25 = Tier 2, else Tier 3
+
+**mods_used**: Parsed from `level-init.dat` binary file (byte 48 = mod count)
+
+**game_version**: Extracted from `script.dat` first 8 bytes (4× uint16 little-endian)
+
+## Distribution
+
+**Playtime** (estimated):
+- Early: 1,376 (57%)
+- Mid: 798 (33%)
+- Late: 228 (9%)
+- Mega: 16 (1%)
+
+**Quality tiers**:
+- Tier 1: 734 (30%) - Has replay + substantial playtime
+- Tier 2: 1,026 (42%)
+- Tier 3: 658 (28%)
+
+**Mod usage**:
+- 0-20 mods: 1,175
+- 20-100 mods: 411
+- 100+ mods: 832 (median: 25 mods)
+
+## Limitations
+
+- Playtime is estimated, not measured
+- 57% early-game saves, only 16 megabases
+- 67% have no replay data
+- Metadata only - actual save files not included
+
+## Sources
+
+- speedrun.com: 198 verified runs
+- GitHub repos: ~1,200 public saves
+- Factorio forums: ~1,020 community-shared saves
+
+The actual save files (~30GB total) are available upon request for legitimate research or educational purposes.
+
+To request access:
+1. Open a discussion on this dataset page
+2. Briefly describe your intended use (RL training, game AI research, etc.)
+3. I'll provide a download link (likely Google Drive or similar)
+
+**Note**: Files are shared as-is from public sources. If you're an original creator and want your save removed, contact me via discussions.