ms-toollib 1.5.9

Algorithms for minesweeper.

ms_toollib

A cross-platform minesweeper algorithm toolbox with a native Rust core.

Supports Python 3.7–3.13 on Windows, Linux, and macOS.

---

Installation

pip install ms_toollib

No additional dependencies required.

---

Features

Category	Description
Mine Laying	Random mine placement (first-click safe, Win7-style), no-guess mine generation (filter & adjustment methods)
Board Metrics	3BV, 3BV/s, openings (Op), islands (Isl), ZiNi (Greedy/Human/Random)
Probabilities	Per-cell mine probability with block decomposition and enumeration
Deduction Solver	3-tier solver: direct subset, subtract-and-compare, full enumeration (≤55 cells)
Solvability Check	Determine if a board is no-guess, find unsolvable structures
Game State Machine	MinesweeperBoard / SafeMinesweeperBoard that accepts mouse clicks and tracks full game state
Replay Parsing	Read AVF, EVF, MVF, RMV formats; save/write EVF (v0–v4) and EVFS containers
Optical Recognition	Recognize board state from an RGBA image via ONNX neural network (Sobel, Hough, DP)

---

Quick Start

import ms_toollib as ms

# Generate a no-guess Beginner board
board = ms.laymine_solvable(9, 9, 10)
print(ms.cal_bbbv(board))          # 3BV
print(ms.cal_zini(board, 1))       # Greedy ZiNi

# Per-cell mine probability
prob = ms.cal_probability_onboard(board, 10)

# Parse a replay
video = ms.AvfVideo("replay.avf")
video.parse()
video.analyse()
print(video.bbbv)

See the full documentation for detailed API references.

---

Public API

Functions (30+): cal_all_solution, cal_bbbv, cal_board_numbers, cal_hzini, cal_op, cal_probability, cal_probability_onboard, cal_rzini, cal_zini, get_all_not_and_is_mine_on_board, is_able_to_solve, is_guess_while_needless, is_solvable, laymine, laymine_op, laymine_solvable, laymine_solvable_adjust, laymine_solvable_thread, mark_board, obr_board, refresh_board, refresh_matrix, refresh_matrixs, refresh_matrixses, sample_bbbvs_exp, solve_direct, solve_enumerate, solve_minus, unsolvable_structure, valid_time_period

Classes (15): AvfVideo, BaseVideo, Board, EvfVideo, Evfs, EvfsCell, GameBoard, KeyDynamicParams, MinesweeperBoard, MvfVideo, RmvVideo, SafeBoard, SafeBoardRow, SafeMinesweeperBoard, VideoActionStateRecorder

---

Supported Platforms

OS	Architectures
Windows	x86, x64
Linux	x86, x86_64, aarch64, armv7, ppc64le, s390x
macOS	x86_64, aarch64

---

Source & Issues

• GitHub: https://github.com/eee555/ms_toollib
• Documentation: https://docs.rs/ms_toollib/latest/ms_toollib
• PyPI: https://pypi.org/project/ms_toollib/