Welcome to Factorio Learning Environment’s documentation!

An open source framework for developing and evaluating LLM agents in the game of Factorio.

Getting Started

• Installation
  • Prerequisites
  • Installation Methods
  • Client-side Setup (Optional)
  • API Key Configuration
  • Initial Setup
  • Verification
  • Next Steps
• Quickstart
  • CLI Commands
  • Basic Usage Example
  • Understanding the REPL Pattern
  • Listing Available Environments
  • Creating Different Environments
  • Complete Workflow Example
  • Next Steps
• Troubleshooting
  • Common Issues
  • Testing Your Installation
  • Getting Help
  • Debugging Tips

Environment

• Environment Overview
  • The REPL Pattern
  • Available Tools
  • The Namespace
  • Observations
  • Error Handling
  • Custom Functions and Classes
  • Action Space
  • Observation Space
  • Environment Methods
  • Architecture
  • Task Types
  • Next Steps
• Gym Environment Registry
  • Overview
  • Features
  • Quick Start
  • Available Environments
  • Command-Line Tools
  • Environment Interface
  • API Reference
  • Complete Example
  • Error Handling
  • Troubleshooting
  • Testing

Tools

• Tools Overview
  • What are Tools?
  • Tool Architecture
  • Anatomy of a Tool
  • Tool Categories
  • Using Tools
  • Return Values
  • Error Handling
  • Next Steps
• Core Tools Reference
  • Inventory Management
  • Entity Manipulation
  • Resource Operations
  • Connections
  • Crafting & Research
  • Movement & Utility
  • Output
  • Best Practices
  • Next Steps
• Creating Custom Tools
  • Overview
  • Tool Structure
  • Step-by-Step Guide
  • Complete Example
  • Automatic Registration
  • Tips & Best Practices
  • Common Patterns
  • Next Steps

Advanced Topics

• Model Context Protocol (MCP)
  • Overview
  • What is MCP?
  • Benefits
  • Installation
  • Configuration
  • Using MCP
  • Integration with LLM Clients
  • Tool Definitions
  • Advanced Usage
  • Architecture
  • Documentation
  • Troubleshooting
  • Next Steps
• Sprites
  • Overview
  • Why Use Sprites?
  • Installation
  • Default Locations
  • CLI Usage
  • Programmatic Usage
  • Visual Observations
  • Sprite Categories
  • Performance Considerations
  • Advanced Usage
  • Integration with Vision Models
  • Troubleshooting
  • Next Steps
• Database Configuration
  • Overview
  • Supported Databases
  • SQLite Configuration
  • PostgreSQL Configuration
  • Database Schema
  • Using the Database
  • Database Client API
  • Migration
  • Backup and Restore
  • Performance Optimization
  • Troubleshooting
  • Best Practices
  • Next Steps

Reference

• Project Structure

Indices and tables

• Index

• Module Index

• Search Page