Giter Club home page Giter Club logo

quotle_fl's Introduction

Quotle

Quotle is a mobile game developed as part of a Mobile Development class. The objective of the game is to guess a hidden quote by typing words in a text field. The game ends when the user has successfully found the full quote.

Installation

To run Quotle on your device, please follow these steps:

  1. Ensure that you have Flutter installed on your machine. If not, you can download and install Flutter from the official website: Flutter - Install

  2. Clone this repository to your local machine using Git or download it as a ZIP file and extract it.

  3. Open a terminal or command prompt and navigate to the project directory.

  4. Create a .env file with the following contents at the root of the project:

    API_LINK = "https://munstermc.pythonanywhere.com/"
  5. Run the following command to retrieve the project's dependencies:

    flutter pub get
  6. Connect your Android or iOS device to your machine, or start an emulator/simulator.

  7. Run the following command to launch the app on your device:

    flutter run

    This will build and install the Quotle app on your connected device or emulator.

  8. Enjoy playing Quotle and challenge yourself to uncover the hidden quotes!

How to Play

! ONLY FRENCH IS SUPPORTED BY THE CURRENT API !

  1. When you launch the Quotle app, you may pick a category and be presented with a screen containing a text field and a set of tiles. Each tile corresponds to a word in the quote.

  2. The text field is where you can type your guesses to uncover the hidden quote. Start typing words that you think might be part of the quote.

  3. As you type, Quotle will analyze your input and highlight tiles that contain words semantically close to the hidden quote. This can help you narrow down your search.

  4. To switch to the length of a word on a tile, simply tap on it. Tapping will alternate between displaying the hint for the word and its length. This feature can be useful to help you deduce the hidden quote.

  5. Continue guessing words and using the tile hints until you have successfully revealed the entire quote.

  6. Once you have found the full quote, the game will end and you can celebrate your victory!

Contributing

Thank you for your interest in contributing to Quotle! If you have any ideas, bug reports, or suggestions for improvement, please feel free to open an issue on this repository.

License

Quotle is released under the CC-BY 3.0. You are free to use, modify, and distribute this project in accordance with the terms of the license.

Acknowledgements

Quotle was developed as part of a Mobile Development class.

App Logo by Feozard.

The data used is by Jean-Philippe Fauconnier.

quotle_fl's People

Contributors

cpbr-dev avatar

Stargazers

 avatar

Watchers

 avatar

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.