Android-WordMasterKMP: Kotlin Multiplatform sample with SwiftUI and Compose (Desktop and Android) clients. Heavily inspired by Wordle game.

WordMasterKMP

Kotlin Multiplatform sample heavily inspired by Wordle game and also Word Master and wordle-solver samples. The main game logic/state is included in shared KMP code with basic UI then in following clients

  • iOS (SwiftUI)
  • Android (Jetpack Compose)
  • Desktop (Compose for Desktop)

Shared KMP game logic/state

The shared WordMasterService class includes following StateFlows representing the current set of guesses and updated status info for each letter.

val boardGuesses = MutableStateFlow<ArrayList<ArrayList<String>>>(arrayListOf())
val boardStatus = MutableStateFlow<ArrayList<ArrayList<LetterStatus>>>(arrayListOf())

The various clients call WordService.setGuess() when a user enters a letter and then WordService.checkGuess() after row of letters are entered...UI then reflects any resulting updates to above StateFlow's. The Compose clients for example do that using

val boardGuesses by wordMasterService.boardGuesses.collectAsState()
val boardStatus by wordMasterService.boardStatus.collectAsState()

On iOS we're using KMP-NativeCoroutines library to map the StateFlows to Swift AsyncStreams. So, for example, our Swift view model includes

@Published public var boardStatus: [[LetterStatus]] = []
@Published public var boardGuesses: [[String]] = []

which are then updated using for example

let stream = asyncStream(for: wordMasterService.boardStatusNative)
for try await data in stream {
  self.boardStatus = data as! [[LetterStatus]]
}

let stream = asyncStream(for: wordMasterService.boardGuessesNative)
for try await data in stream {
    self.boardGuesses = data as! [[String]]
}

Any updates to boardStatus or boardGuesses will trigger our SwiftUI UI to be recomposed again.

Remaining work includes

  • check if overall word is valid and show indication in UI if not
  • share Compose code between Android and Desktop
  • indicator in UI that correct guess entered (other than all letters being green)

Screenshots

Screenshot 2022-01-08 at 22 40 36

Simulator Screen Shot - iPhone 13 Pro - 2022-01-08 at 22 38 11

Screenshot_1641682073

Comments

  • initial unit test plumbing
    initial unit test plumbing

    Jan 9, 2022

    null

                                                                                                                                                                                                           
    Reply
  • ReadMe Typo Fix
    ReadMe Typo Fix

    Jan 9, 2022

    null

                                                                                                                                                                                                           
    Reply
  • Readme Typo Fixes
    Readme Typo Fixes

    Jan 9, 2022

    null

                                                                                                                                                                                                           
    Reply