rustshogi Documentation¶
rustshogi is a high-performance shogi library implemented in Rust. It can be used from Python applications through Python bindings.
Contents:
- Installation
- Installation with pip
- Installing the development version
- Building from source
- Verifying the installation
- Quickstart
- Basic Usage
- Searching for Legal Moves
- Executing a Move
- Move Representation
- Checking for Game End
- Using the Evaluation Function
- Using the Search Engine
- API Reference
- Module Overview
- Basic Types
- Evaluation Functions
- Search
- Examples
- Basic Game
- Piece Placement and Movement
- Position Analysis
- Hand Management
- Using the Game Class
- Using Evaluation Functions
- Using the Search Engine
- Automated Game System
- Changelog
- Version 0.1.0 (2025-01-XX)
Features¶
Fast shogi board representation and manipulation
Legal move generation and search
Piece placement and movement
Hand piece management
Game state management
Python bindings
Installation¶
pip install rustshogi
Quickstart¶
from rustshogi import Board, ColorType, Move, Address
# Create an initial position
board = Board("startpos")
# Search for legal moves
legal_moves = board.search_moves(ColorType.Black)
# Execute a move
if legal_moves:
board.execute_move(legal_moves[0])
For detailed usage, please refer to Quickstart.
API Reference¶
The complete API reference can be found at rustshogi package.
API Reference: