# aphu19/arknights-base-planner architecture

> Architecture diagram of the GitHub repository aphu19/arknights-base-planner, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/aphu19/arknights-base-planner
- Repository: https://github.com/aphu19/arknights-base-planner

## Overview

This is an Arknights base-shift planner: users configure a roster, facility layout, and production goals, then receive a six-shift schedule and MAA-compatible JSON. The documented workflow runs through either the CLI or Tkinter GUI into the solver, which evaluates candidate crews against production rules and scores plans before assembling shifts and exporting them. The graph preserves the documented roster, power, meeting-room, drone, morale, and storage concerns. Some subsystem links rely on README documentation or source-index references; unsampled implementation details are not assumed.

Main entry points: [`planner/solve/solver.py`](https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/solver.py) (Solver orchestration), [`planner/solve/joint.py`](https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/joint.py) (Joint search), [`planner/gui/app.py`](https://github.com/aphu19/arknights-base-planner/blob/main/planner/gui/app.py) (Tkinter GUI), [`planner/core/engine.py`](https://github.com/aphu19/arknights-base-planner/blob/main/planner/core/engine.py) (Shift evaluator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["User entry"]
  node_cli["CLI<br/>[cli.py]"]
  node_gui["Tkinter GUI<br/>[app.py]"]
  node_gui_state["GUI state<br/>[state.py]"]
end

subgraph group_solve["Planning and search"]
  node_solver["Solver orchestration<br/>[solver.py]"]
  node_objectives["Objective scoring<br/>[objectives.py]"]
  node_joint["Joint search<br/>[joint.py]"]
  node_beam["Beam search<br/>[beam.py]"]
  node_pool["Candidate pool<br/>[pool.py]"]
  node_assemble["Candidate assembly<br/>[assemble.py]"]
  node_drone["Drone allocation<br/>[drones.py]"]
  node_plan["Shift planning<br/>[plan.py]"]
end

subgraph group_domain["Game model"]
  node_engine["Shift evaluator<br/>[engine.py]"]
  node_dataset[("Skills and roster data<br/>[dataset.py]")]
  node_rules["Skill rules<br/>[rules.py]"]
  node_orders["Trade orders<br/>[orders.py]"]
  node_meeting["Meeting room<br/>[meeting.py]"]
  node_storage["Storage checks<br/>[storage.py]"]
  node_daycheck["Morale check<br/>[daycheck.py]"]
end

subgraph group_output["Schedule output"]
  node_maa["MAA export<br/>[maa.py]"]
end

node_user(("Planner user"))

node_user -->|"sets goals"| node_cli
node_user -->|"configures plan"| node_gui
node_gui -->|"uses state"| node_gui_state
node_gui -->|"runs solve"| node_solver
node_gui -->|"selects goals"| node_objectives
node_gui -->|"exports plan"| node_maa
node_cli -->|"runs solve"| node_solver
node_solver -->|"scores goals"| node_objectives
node_solver -->|"calls search"| node_joint
node_solver -->|"builds shifts"| node_plan
node_solver -->|"checks capacity"| node_storage
node_solver -->|"checks morale"| node_daycheck
node_solver -->|"emits schedule"| node_maa
node_joint -->|"searches crews"| node_beam
node_joint -->|"gets candidates"| node_pool
node_joint -->|"ranks plans"| node_objectives
node_joint -->|"evaluates shifts"| node_engine
node_joint -->|"scores clues"| node_meeting
node_beam -->|"scores teams"| node_pool
node_assemble -->|"searches crews"| node_beam
node_assemble -->|"builds candidates"| node_pool
node_plan -->|"assigns drones"| node_drone
node_engine -->|"reads skills"| node_dataset
node_engine -->|"applies rules"| node_rules
node_engine -->|"evaluates orders"| node_orders
node_engine -->|"evaluates room"| node_meeting

click node_cli "https://github.com/aphu19/arknights-base-planner/blob/main/planner/cli.py"
click node_gui "https://github.com/aphu19/arknights-base-planner/blob/main/planner/gui/app.py"
click node_gui_state "https://github.com/aphu19/arknights-base-planner/blob/main/planner/gui/state.py"
click node_solver "https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/solver.py"
click node_objectives "https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/objectives.py"
click node_joint "https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/joint.py"
click node_beam "https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/beam.py"
click node_pool "https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/pool.py"
click node_assemble "https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/assemble.py"
click node_drone "https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/drones.py"
click node_plan "https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/plan.py"
click node_engine "https://github.com/aphu19/arknights-base-planner/blob/main/planner/core/engine.py"
click node_dataset "https://github.com/aphu19/arknights-base-planner/blob/main/planner/core/dataset.py"
click node_rules "https://github.com/aphu19/arknights-base-planner/blob/main/planner/core/rules.py"
click node_orders "https://github.com/aphu19/arknights-base-planner/blob/main/planner/core/orders.py"
click node_meeting "https://github.com/aphu19/arknights-base-planner/blob/main/planner/core/meeting.py"
click node_storage "https://github.com/aphu19/arknights-base-planner/blob/main/planner/core/storage.py"
click node_daycheck "https://github.com/aphu19/arknights-base-planner/blob/main/planner/core/daycheck.py"
click node_maa "https://github.com/aphu19/arknights-base-planner/blob/main/planner/emit/maa.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_gui,node_gui_state,node_user toneBlue
class node_solver,node_objectives,node_joint,node_beam,node_pool,node_assemble,node_drone,node_plan toneAmber
class node_engine,node_dataset,node_rules,node_orders,node_meeting,node_storage,node_daycheck toneMint
class node_maa toneRose
```

## Components

### User entry

- [CLI](https://github.com/aphu19/arknights-base-planner/blob/main/planner/cli.py): `planner/cli.py`
- [Tkinter GUI](https://github.com/aphu19/arknights-base-planner/blob/main/planner/gui/app.py): `planner/gui/app.py`
- [GUI state](https://github.com/aphu19/arknights-base-planner/blob/main/planner/gui/state.py): `planner/gui/state.py`

### Planning and search

- [Solver orchestration](https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/solver.py): `planner/solve/solver.py`
- [Objective scoring](https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/objectives.py): `planner/solve/objectives.py`
- [Joint search](https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/joint.py): `planner/solve/joint.py`
- [Beam search](https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/beam.py): `planner/solve/beam.py`
- [Candidate pool](https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/pool.py): `planner/solve/pool.py`
- [Candidate assembly](https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/assemble.py): `planner/solve/assemble.py`
- [Drone allocation](https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/drones.py): `planner/solve/drones.py`
- [Shift planning](https://github.com/aphu19/arknights-base-planner/blob/main/planner/solve/plan.py): `planner/solve/plan.py`

### Game model

- [Shift evaluator](https://github.com/aphu19/arknights-base-planner/blob/main/planner/core/engine.py): `planner/core/engine.py`
- [Skills and roster data](https://github.com/aphu19/arknights-base-planner/blob/main/planner/core/dataset.py): `planner/core/dataset.py`
- [Skill rules](https://github.com/aphu19/arknights-base-planner/blob/main/planner/core/rules.py): `planner/core/rules.py`
- [Trade orders](https://github.com/aphu19/arknights-base-planner/blob/main/planner/core/orders.py): `planner/core/orders.py`
- [Meeting room](https://github.com/aphu19/arknights-base-planner/blob/main/planner/core/meeting.py): `planner/core/meeting.py`
- [Storage checks](https://github.com/aphu19/arknights-base-planner/blob/main/planner/core/storage.py): `planner/core/storage.py`
- [Morale check](https://github.com/aphu19/arknights-base-planner/blob/main/planner/core/daycheck.py): `planner/core/daycheck.py`

### Schedule output

- [MAA export](https://github.com/aphu19/arknights-base-planner/blob/main/planner/emit/maa.py): `planner/emit/maa.py`

### Other components

- **Planner user**

## Connections

- Planner user → CLI: sets goals (evidence: `README.md`)
- Planner user → Tkinter GUI: configures plan (evidence: `README.md`)
- Tkinter GUI → GUI state: uses state (evidence: `planner/gui/app.py`)
- Tkinter GUI → Solver orchestration: runs solve (evidence: `planner/gui/app.py`)
- Tkinter GUI → Objective scoring: selects goals (evidence: `planner/gui/app.py`)
- Tkinter GUI → MAA export: exports plan (evidence: `planner/gui/app.py`)
- CLI → Solver orchestration: runs solve (evidence: `planner/cli.py`)
- Solver orchestration → Objective scoring: scores goals (evidence: `planner/solve/solver.py`)
- Solver orchestration → Joint search: calls search (evidence: `planner/solve/solver.py`)
- Solver orchestration → Shift planning: builds shifts (evidence: `planner/solve/solver.py`)
- Solver orchestration → Storage checks: checks capacity (evidence: `planner/solve/solver.py`)
- Solver orchestration → Morale check: checks morale (evidence: `planner/solve/solver.py`)
- Solver orchestration → MAA export: emits schedule (evidence: `planner/solve/solver.py`)
- Joint search → Beam search: searches crews (evidence: `planner/solve/joint.py`)
- Joint search → Candidate pool: gets candidates (evidence: `planner/solve/joint.py`)
- Joint search → Objective scoring: ranks plans (evidence: `planner/solve/joint.py`)
- Joint search → Shift evaluator: evaluates shifts (evidence: `planner/solve/joint.py`)
- Joint search → Meeting room: scores clues (evidence: `planner/solve/joint.py`)
- Beam search → Candidate pool: scores teams (evidence: `planner/solve/beam.py`)
- Candidate assembly → Beam search: searches crews (evidence: `planner/solve/assemble.py`)
- Candidate assembly → Candidate pool: builds candidates (evidence: `planner/solve/assemble.py`)
- Shift planning → Drone allocation: assigns drones (evidence: `planner/solve/plan.py`)
- Shift evaluator → Skills and roster data: reads skills (evidence: `planner/core/engine.py`)
- Shift evaluator → Skill rules: applies rules (evidence: `planner/core/engine.py`)
- Shift evaluator → Trade orders: evaluates orders (evidence: `planner/core/engine.py`)
- Shift evaluator → Meeting room: evaluates room (evidence: `planner/core/engine.py`)
