Manages the game state of a game of hive and determines valid playable moves.
Additionally, produces new game states from the application of valid moves.
This engine optionally supports games with all 3 official Hive expansions: the Mosquito, the Lady Bug, and the Pill Bug. See details on the
GameState below for options.
You can read about each of the engine's components below, or dive right in with an instance of
let state = GameState()
Unit represents one of the various pieces a game of Hive is played with -- ants, spiders, etc.
Unit has a
class, which defines the type of bug it is, an
owner to let you know who it belongs to, and an
identifier to differentiate each instance.
There are a variety of functions for determining if a
Unit can move, and where it can move to.
Each class of
Unit also provides an extension to the
Unit class to calculate its moves. See extension classes such as
Unit+Beetle for more.
Position is a space on the "board" where a
Unit can be placed or moved to.
Position class also provides functions for determining if a
Unit can move freely between two
Positions, very important for determining valid moves in the current state.
Movement provides details on moving a
Unit around the board, or introducing a new
Unit to the board.
.move(unit:to:)specifies instructions for moving a
.place(unit:at:)specifies instructions for placing a
.yoink(pillBug:unit:to:)specifies instructions for moving a
Unitthrough the use of a Pill Bug to a
.passspecifies a non-movement, only available when a player has no other moves.
GameState is the structure which manages the overall state of a game of Hive.
Get started by creating an instance:
let state = GameState()
By default, a
GameState will create a basic game with no additional options. You can enable expansion pieces and common unofficial rules through
GameState.Options, as well as performance enhancements.
Provide a set of
GameState.Options to the
GameState(options:) constructor to change which options you have enabled.
You can enumerate all the current moves available with
To update the
GameState with a given move, call
apply(_:) which will mutate the state in place. If you want to explore various
Movements, you can undo a move with
For better performance, you can disable move validation with
Swift Package Manager
This package is built with Swift Package Manager, so you can require it as a dependency in your
dependencies: [ .package(url: "email@example.com:josephroquedev/hive-engine.git", .branch("master")) ],
Optionally, you can lock the engine to a specific version with:
dependencies: [ .package(url: "firstname.lastname@example.org:josephroquedev/hive-engine.git", from: "2.0.0") ],
See the Releases for the most recent release.
To install manually, simply drag and drop
HiveEngine.xcodeproj into your Xcode project.
- Swift 5.0+
- Write your changes and make sure you test them! This engine boasts nearly 100% code coverage and expects precise conformance to the rules of the game.
- Install SwiftLint for styling conformance:
brew install swiftlint
swiftlintfrom the root of the repository.
- There should be no errors or violations. If there are, please fix them before opening a PR.
- Open a PR with your changes 👍
- CI will run your changes and ensure they build and pass all tests on Linux and macOS