https://github.com/giginet/peafowl

:mahjong: Play Japanese Mahjong in Swift
https://github.com/giginet/peafowl

Last synced: 2 months ago
JSON representation

:mahjong: Play Japanese Mahjong in Swift

• Host: GitHub
• URL: https://github.com/giginet/peafowl
• Owner: giginet
• License: mit
• Created: 2018-06-26T18:48:12.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-08-26T18:36:29.000Z (over 6 years ago)
• Last Synced: 2024-10-14T09:53:21.556Z (3 months ago)
• Language: Swift
• Homepage:
• Size: 502 KB
• Stars: 92
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Peafowl

[![Build Status](https://travis-ci.com/giginet/Peafowl.svg?branch=master)](https://travis-ci.com/giginet/Peafowl)

[![Language](https://img.shields.io/badge/language-Swift%204.2-orange.svg)](https://swift.org)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

[![Platform iOS|macOS](https://img.shields.io/badge/platform-iOS|macOS|watchOS-lightgray.svg)](https://github.com/giginet/Peafowl)

[![License](https://cocoapod-badges.herokuapp.com/l/RxSpriteKit/badge.svg)](https://github.com/cookpad/RxSpriteKit/blob/master/LICENSE)

:mahjong: **Peafowl** is a score calculation library to play Japanese Mahjong!

## Usage

```swift

// You can define hand as an array literal.

// Last tile will be picked tile.

let hand: Hand = [二萬, 二萬, 三萬, 四萬, 四萬, 五萬, 五萬, 二索, 三索, 四索, 二筒, 三筒, 四筒, 三萬]

let context = GameContext()

let score = scoreCalculator.calculate(with: hand, context: context)

let describer = ScoreDescriber()

let scoreReport = describer.describe(score!)

```

![Playground](Documentation/playground.png)

You'll get score reports.

```

三色同順 2

一盃口 1

ツモ 1

断ヤオ 1

30符5飜 満貫 8000点

```

### GameContext

You can define game states on `GameContext` struct. (e.g. prevalent wind, seat wind, dora, riichi state or others...)

```swift

let gameContext = GameContext(winningType: .selfPick, // 自摸和了、ロン和了

                              pickedSource: .wall, // 第1順, 山, 河底, 嶺上牌

                              riichiStyle: .single, // 立直, ダブル立直

                              isOneShot: false, // 一発

                              isDealer: false, // 親

                              prevalantWind: 東, // 場風

                              seatWind: 南, // 自風

                              dora: [五萬]) // ドラ

```

## Required

- Swift 4.2

- Xcode 10 beta 6 (Recommended)

- or Xcode 9.4.1 + Some Swift 4.2 toolchain

## Playground

You can try Peafowl on Xcode Playground.

1. Clone this

2. Open `Peafowl.xcworkspace`

3. Open `Peafowl.xcplayground`

## Installation

```

github "giginet/Peafowl"

```

## Known limitation

- [ ] Pung and Chow are partially supported

- [ ] Not support Kong system

    - [ ] Related yaku (e.g. 槍槓、三槓子, 四槓子）

## Acknowledgement

Tile images are provided from [here](http://majandofu.com/mahjong-images).