Giter Club home page Giter Club logo

wordle-kt's Introduction

Build Status

Wordle Compose

Wordle game clone written in Kotlin & using Compose UI Toolkit.

Screenshots

Compose for Desktop

Main screens

Playing Victory End of game Settings How to play

Light & Dark mode

Light 🌞 Dark 🌛

Compose for Android

The main UI is displayed in Android devices.

For now, the setup is made quick & dirty and needs improvements (maybe using Kotlin Multi Platform project?). Sources from the desktop version needs to be copied into the Android project.

./syncComposeSharedSources.sh

Any edit made in the Android copy should be done in the original desktop module afterwards.

Extracting Compose code common to Desktop & Android apps in a shared module would clean this mess but might require specific Gradle setup. Reason why it might be better to use KMP project setup.

Android support is still very rough and a nice to have for now.

ASCII/Console mode

.---------------.
| Hello Wordle! |
'---------------'
 ➡️ Enter a 5 letter english word: hello
Wordle 189 4/6
T⬛I⬛L🟩E🟨S⬛
G⬛R⬛E🟨A⬛T⬛
T⬛A⬛L🟩E🟨S⬛
H🟩E🟩L🟩L🟩O🟩
 ⬜ ⬜ ⬜ ⬜ ⬜
 ⬜ ⬜ ⬜ ⬜ ⬜
Congrats! You found the correct answer 🎉: HELLO
 🔄 Play again? (y/N) 
Full game…
.---------------.
| Hello Wordle! |
'---------------'
 ⬜ ⬜ ⬜ ⬜ ⬜
 ⬜ ⬜ ⬜ ⬜ ⬜
 ⬜ ⬜ ⬜ ⬜ ⬜
 ⬜ ⬜ ⬜ ⬜ ⬜
 ⬜ ⬜ ⬜ ⬜ ⬜
 ⬜ ⬜ ⬜ ⬜ ⬜

 ➡️ Enter a 5 letter english word: tiles
T⬛I⬛L🟩E🟨S⬛
 ⬜ ⬜ ⬜ ⬜ ⬜
 ⬜ ⬜ ⬜ ⬜ ⬜
 ⬜ ⬜ ⬜ ⬜ ⬜
 ⬜ ⬜ ⬜ ⬜ ⬜
 ⬜ ⬜ ⬜ ⬜ ⬜
Keep going… 1/6
 ➡️ Enter a 5 letter english word: great
T⬛I⬛L🟩E🟨S⬛
G⬛R⬛E🟨A⬛T⬛
 ⬜ ⬜ ⬜ ⬜ ⬜
 ⬜ ⬜ ⬜ ⬜ ⬜
 ⬜ ⬜ ⬜ ⬜ ⬜
 ⬜ ⬜ ⬜ ⬜ ⬜
Keep going… 2/6
 ➡️ Enter a 5 letter english word: tales
T⬛I⬛L🟩E🟨S⬛
G⬛R⬛E🟨A⬛T⬛
T⬛A⬛L🟩E🟨S⬛
 ⬜ ⬜ ⬜ ⬜ ⬜
 ⬜ ⬜ ⬜ ⬜ ⬜
 ⬜ ⬜ ⬜ ⬜ ⬜
Keep going… 3/6
 ➡️ Enter a 5 letter english word: hello
Wordle 189 4/6
T⬛I⬛L🟩E🟨S⬛
G⬛R⬛E🟨A⬛T⬛
T⬛A⬛L🟩E🟨S⬛
H🟩E🟩L🟩L🟩O🟩
 ⬜ ⬜ ⬜ ⬜ ⬜
 ⬜ ⬜ ⬜ ⬜ ⬜
Congrats! You found the correct answer 🎉: HELLO
 🔄 Play again? (y/N) 

Compose Mosaic mode

In a compatible terminal, build the binary distribution and execute it:

$ ./gradlew wordle-compose-mosaic:installDist
$ ./wordle-compose-mosaic/build/install/wordle-compose-mosaic/bin/wordle-compose-mosaic

Or you can simply execute the convenience runWordleMosaic.sh script doing the same.

$ ./runWordleMosaic.sh 

Tech Stack

Development

To build and run the desktop application, run the following command

./gradlew run

To run tests, run the following command

./gradlew test

To build and package desktop application, run the following command

./gradlew assembleDist

License

The MIT License (MIT)

Copyright (c) 2022 Olivier Patry

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

wordle-kt's People

Contributors

opatry avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

wordle-kt's Issues

Consider resizable window and responsive layout

  • Allow resizing window
  • Restrict to min size (500x700?)
  • Adjust components to make them more responsive (especially Alphabet & WordleGrid)
  • Adjust dialog & panel to take current window width into account for their max size

Move replay button in stats dialog

In official game, at the left of the Share button, there is a counter for the next word, we could use this place holder for our restart button and stay closed to original game design.

Review victory sequence

  1. Grid animation
  2. Victory message toast
  3. Once toast is dismissed, show victory dialog
  4. Once victory dialog is dismissed, show restart and answer placeholder

Will also fix

Let user choose language and word size

  • Smart user default (device locale + 5 letters).
  • persistence
  • initial choice at first launch
  • option on settings
  • add source dictionary buckets in records to avoid melding results for different setup

Screen abstraction/navigation might be needed to clean `WordleApp()` Composable

Currently, the transition from dictionary picker to loading to game screen is a bit ad hoc and might be improved thanks to a screen abstraction.

Here is what was done for another POC game.

sealed class Screen {
    object Home : Screen()
    data class Progress(val maxRank: Int) : Screen()
    data class Settings(val player: PlayerInfo) : Screen()
    data class Scores(val player: PlayerInfo) : Screen()
    object Inventory : Screen()
    data class InGame(val mode: GameRules.Mode) : Screen() {
        val rules = GameRules(mode)
    }

    data class Statistics(val player: PlayerInfo, val viewModel: GameRulesViewModel) : Screen()
}

@Composable
fun HuesApp() {
    CheapHuesComposeTheme {
        var screenState by remember { mutableStateOf<Screen>(Screen.Home) }
        val player by remember { mutableStateOf(PlayerInfo.DEFAULT_PLAYER) }

        val backToHome = { screenState = Screen.Home }

        screenState.let { screen ->
            when (screen) {
                Screen.Home -> HomeScreen(player) { screenState = it }
                is Screen.Inventory -> InventoryScreen(player, backToHome)
                is Screen.Settings -> SettingsScreen(player, backToHome)
                is Screen.Scores -> ScoresScreen(player, backToHome)
                is Screen.Progress -> ProgressionScreen(3, backToHome)
                is Screen.InGame -> {
                    val viewModel = GameRulesViewModel(player, screen.rules)
                    val status = rememberUpdatedState(viewModel.status)

                    when (status.value) {
                        GameRules.GameStatus.PLAYING -> GameScreen(viewModel, backToHome)
                        else -> EndOfGameScreen(viewModel) {
                            screenState = Screen.Statistics(player, viewModel)
                        }
                    }
                }
                is Screen.Statistics -> StatisticsScreen(
                    screen.player,
                    screen.viewModel,
                    onRestart = {
                        screen.viewModel.restart()
                        screenState = Screen.InGame(screen.viewModel.mode)
                    },
                    onQuit = backToHome
                )
            }
        }
    }
}

Use an enum for all available dialog type

Instead of having as many booleans as dialogs types, given that only one of them can be displayed at once, define a (nullable or having a none case) visible dialog state.

Replace Key event by text field

Either find a way to make the active row a full text field properly displaying characters or define it as focusable/focused but invisible /hidden.

At each input pushing word to view model would automatically update grid.

This would allow writing accented characters (out any diacritic) for french, Spanish, ...

Allow fetching user defined dictionaries

  • Drop any words_[a-z]{2}_[\d]+.txt in app's data dir (esp. for Desktop)
  • Add a button to open a file picker in DictionaryPicker (would need CompositionLocalProvider for Desktop & Android)
  • Define a builtIn attribute in Dictionary
  • Add special indicator (user icon vs system icon?) in dictionary list
  • Handle invalid data

Add a solver

  • add solver
  • add a auto solve button in Compose version
  • determine if a hint couldn't be provided by a way or another

Check dlew/wordle-solver for details.

Finalize Mosaic version

  • need to press enter twice to update screen
  • replace println game instructions with Text() Composable
  • determine if Mosaic provides the equivalent of EditText() to replace readLine()
  • #17

Implement the share button when finishing the game

This is a bit tedious to achieve given that it's dependent on underlying platform internals.

  • Compose desktop should rely on AWT clipboard
  • #28
  • Add toast message "Copied results to clipboard"
  • For Mosaic version, we could automatically put to clipboard without user action, maybe we could rely on pbcopy call system?

In this SO answer, it is suggested to use a CompositionLocalProvider to delegate the impl: https://stackoverflow.com/a/68389985/2551689

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.