WordMasterKMP - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #typescript #llm #golang #android #docker #macos #nodejs #java #kubernetes #vue #open-source

WordMasterKMP

(★ 106)

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

파일 탐색기

최종 버전 다운로드 (.zip)

- - android.yml
  - desktop.yml
  - ios.yml
- guidelines.md
- build.gradle.kts
- screenshot1.png
- .gitignore
- build.gradle.kts
- words.txt
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- libs.versions.toml
- - ContentView.swift
  - Info.plist
  - iOSApp.swift
  - ViewModel.swift
  - words.txt
- - project.pbxproj
- build.gradle.kts
.gitignore
build.gradle.kts
gradle.properties
gradlew
gradlew.bat
LICENSE
README.md
settings.gradle.kts
words.txt

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/joreilly/WordMasterKMP

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd WordMasterKMP

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Gradle (Java/Kotlin)

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
JDK (Java) Java/Kotlin 프로젝트를 빌드/실행하려면 필요합니다.
Gradle 레포에 포함된 gradlew(Gradle Wrapper)를 쓰면 Gradle을 따로 설치할 필요가 없습니다.

cd androidApp

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

./gradlew build

Gradle로 빌드를 진행합니다.

✅ BUILD SUCCESSFUL 메시지가 뜨면 성공입니다. build/ 폴더에 결과물이 생성됩니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# WordMasterKMP

![kotlin-version](https://img.shields.io/badge/kotlin-2.4.10-blue?logo=kotlin)

Kotlin Multiplatform sample heavily inspired by [Wordle](https://www.powerlanguage.co.uk/wordle/) game and also [Word Master](https://github.com/octokatherine/word-master) and [wordle-solver](https://github.com/dlew/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)

### Screenshots

<img width="792" height="498" alt="Screenshot 2025-08-16 at 15 21 14" src="https://github.com/user-attachments/assets/7788d21b-9f4c-4e71-8ed9-3ee83666c722" />

### Shared KMP game logic/state

The shared `WordMasterService` class exposes the game state as `StateFlow`s:

```
val boardGuesses = StateFlow<ArrayList<ArrayList<String>>>()       // letters entered on each row
val boardStatus  = StateFlow<ArrayList<ArrayList<LetterStatus>>>() // per-letter result
val keyStatus    = StateFlow<Map<String, LetterStatus>>()          // best status per key, colours the keyboard
val guessError   = StateFlow<String?>()                            // validation feedback
```

Each client renders a board of read-only tiles plus an on-screen keyboard. Key presses call
`WordMasterService.addLetter()` / `removeLetter()`, and `submitGuess()` validates the row against the
word list (surfacing "Not enough letters" / "Not in word list" via `guessError`) before evaluating it
and updating the flows above.  The Compose clients observe state as following (with any updates to those
`StateFlow`'s triggering recomposition)

```
val boardStatus by wordMasterService.boardStatus.collectAsState()
val keyStatus by wordMasterService.keyStatus.collectAsState()
```

On iOS we're using the [KMP-NativeCoroutines](https://github.com/rickclephas/KMP-NativeCoroutines) library to map the `StateFlow` to Swift `AsyncSequence`.  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 = asyncSequence(for: wordMasterService.boardStatus)
for try await data in stream {
  self.boardStatus = data as! [[LetterStatus]]
}

let stream = asyncSequence(for: wordMasterService.boardGuesses)
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.

## Full set of Kotlin Multiplatform/Compose/SwiftUI samples

*  PeopleInSpace (https://github.com/joreilly/PeopleInSpace)
*  GalwayBus (https://github.com/joreilly/GalwayBus)
*  Confetti (https://github.com/joreilly/Confetti)
*  BikeShare (https://github.com/joreilly/BikeShare)
*  FantasyPremierLeague (https://github.com/joreilly/FantasyPremierLeague)
*  ClimateTrace (https://github.com/joreilly/ClimateTraceKMP)
*  GeminiKMP (https://github.com/joreilly/GeminiKMP)
*  MortyComposeKMM (https://github.com/joreilly/MortyComposeKMM)
*  StarWars (https://github.com/joreilly/StarWars)
*  WordMasterKMP (https://github.com/joreilly/WordMasterKMP)
*  Chip-8 (https://github.com/joreilly/chip-8)
*  FirebaseAILogicKMPSample (https://github.com/joreilly/FirebaseAILogicKMPSample)