README

Symfony Bundle implementing Ingress Maxfield — generates optimal portal linking and fielding plans for the Ingress mobile game.

Installation

composer require elkuku/maxfield-bundle

Portal File Format

Create a plain text file with one portal per line:

# Lines starting with # are comments and are ignored

PortalName; IntelURL; [keys]; [SBUL]

Example:

# My operation portals
Town Hall; https://intel.ingress.com/intel?pll=38.032646,-78.477578; 3
Library; https://intel.ingress.com/intel?pll=38.032570,-78.477450
Post Office; https://intel.ingress.com/intel?pll=38.033100,-78.476900; 0; SBUL

• Portals with duplicate coordinates are silently skipped.
• A minimum of 3 portals is required to create any fields.

Usage

Console command

bin/console maxfield:plan <portal-file> [options]

Examples:

# Single agent, defaults
bin/console maxfield:plan portals.txt

# Three agents, save to a specific directory, include CSV
bin/console maxfield:plan portals.txt --num-agents=3 --outdir=./output --output-csv

# Verbose output with more iterations for better quality
bin/console maxfield:plan portals.txt --num-iterations=5000 -v

PHP API

Inject MaxfieldPlanner and call run():

use Elkuku\MaxfieldBundle\Service\MaxfieldPlanner;

class MyController
{
    public function __construct(private readonly MaxfieldPlanner $planner) {}

    public function generate(): void
    {
        $plan = $this->planner->run(
            filename: '/path/to/portals.txt',
            numAgents: 2,
            numFieldIterations: 1000,
            maxRouteSolutions: 1000,
            maxRouteRuntime: 60,
            outdir: '/tmp/my-operation',
            outputCsv: true,
            verbose: false,
        );

        // $plan->graph->ap        — total AP
        // $plan->graph->numLinks  — number of links
        // $plan->graph->numFields — number of fields
        // $plan->assignments      — array of Assignment objects
    }
}

run() returns the completed Plan object and also writes all output files to $outdir.

Output Files

All files are written to the directory specified by --outdir.

Reading the assignment files

Links must be made in the listed order. Each entry shows:

Link ; Agent ;   # ; Link Origin name
                 # ; Link Destination name

• Link — global sequence number
• Agent — which agent makes this link (1-based)
• # — portal number on the portal map