https://github.com/mesqueeb/micromaxonapplesilicon

♟️ The µ-Max C Chess engine to play Chess games. Built as multi-platform Swift Package for iOS, visionOS, macOS
https://github.com/mesqueeb/micromaxonapplesilicon

chess chess-ai chess-engine micro-max swift swift-package

Last synced: 16 days ago
JSON representation

♟️ The µ-Max C Chess engine to play Chess games. Built as multi-platform Swift Package for iOS, visionOS, macOS

• Host: GitHub
• URL: https://github.com/mesqueeb/micromaxonapplesilicon
• Owner: mesqueeb
• License: mit
• Created: 2024-06-19T02:56:22.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-10-14T06:36:26.000Z (3 months ago)
• Last Synced: 2024-12-17T13:31:50.709Z (19 days ago)
• Topics: chess, chess-ai, chess-engine, micro-max, swift, swift-package
• Language: C++
• Homepage: https://swiftpackageindex.com/mesqueeb/MicroMaxOnAppleSilicon
• Size: 757 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Micro-Max On Apple Silicon ♟️

[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fmesqueeb%2FMicroMaxOnAppleSilicon%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/mesqueeb/MicroMaxOnAppleSilicon)

[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fmesqueeb%2FMicroMaxOnAppleSilicon%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/mesqueeb/MicroMaxOnAppleSilicon)

```

.package(url: "https://github.com/mesqueeb/MicroMaxOnAppleSilicon", from: "2.1.0")

```

Micro-Max On Apple Silicon is the [µ-Max C Chess engine](https://home.hccnet.nl/h.g.muller/max-src2.html) by H.G. Muller to play Chess games. Built as multi-platform XCframework for iOS, macOS and visionOS. Wrapped as a modernised Swift Package that can be included in any Swift project and can build on all Apple platforms.

## Installation

You can add `MicroMaxOnAppleSilicon` by adding it as a dependency to your `Package.swift` or add it via Xcode by searching for the name.

The library currently relies on a certain file existing in your project's Bundle Resources, so you will need to manually add that before the engine can be used, otherwise you will hit an error:

> fmax.ini not found in the framework bundle.

The `fmax.ini` file is bundled with the files that will get installed with this package:

![](./docs/copy_fmax_ini_file.jpg)

You then have to copy paste this file into your project's directory and add it to the Bundle Resources of your target:

![](./docs/add_to_bundle_resources.jpg)

That's all! Now you can use the engine in your project.

## Usage

```swift

import MicroMaxOnAppleSilicon

let bridge = MicroMaxBridge()

bridge.connectToEngine()

/// You need to feed the engine FEN state strings to be able to request moves

let fenState: String = "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1"

do {

  let (from, to) = try await bridge.requestAiMove(fenState: inputText)

  guard let from, let to else { throw fatalError("no result") }

  print("MicroMax moves from \(from) to \(to)") // Eg. from "B7" to "B6"

} catch {

  print("something went wrong... error:", error)

}

```

The library comes with some useful types and helper functions, be sure to check out the [Swift wrapper's source code here](./MicroMaxOnAppleSilicon/SwiftBridge/).

### Sample Project

There is a sample Xcode project provided as part of the repo that you reference here: [MicroMaxTestApp](./MicroMaxTestApp/).

### Documentation

See the [documentation](https://swiftpackageindex.com/mesqueeb/MicroMaxOnAppleSilicon/documentation/micromaxonapplesilicon) for more info.

# Other Projects

Also check out Fuego on Apple Silicon ⚫️⚪️, the Fuego Go engine wrapped for Apple Silicon.

→ [github.com/mesqueeb/FuegoOnAppleSilicon](https://github.com/mesqueeb/FuegoOnAppleSilicon)