Skip to content

Soapalin/IdleReader

Repository files navigation

IdleReader: A Text-based Journey 📚📖

Welcome to Idle Reader! Immerse yourself in this idle text-based game! Accumulate knowledge, grow your intelligence to purchase real in-game books.
To play the game, head to the installation section down below or to the release page.

📕 Description

Start your journey with only your favourite book in-hand! By reading it, grow your Intelligence and Knowledge. Knowledge is the currency used in-game: use it wisely to purchase and collect your favourite books! Beware, some books have Intelligence requirements, and the only way to grow your IQ is to read different books (at least once).

Learn more about the features below or in explore our wiki page for in-depth game guides.

📕 Features

  • 📗 Idle Reading: Leave the game in the background and continue progressing
  • 📗 Real Books: Purchase real in-game books with the knowledge you have accumulated
  • 📗 Bookshop: Refreshed regularly for you to find your favourite books
  • 📗 IQ Growth: Reading different books will increase your IQ!
  • 📗 Knowledge Growth: Select different books for different rate of growth
  • 📗 Concurrent Reading: Grow your IQ high enough, and read up to 3 books simultaneously!
  • 📘 Auction (Coming Soon): Tired of waiting for your favourite books to be available in the bookshop? Head to the Auction and bid for it! Beware, prices are not low...

📕 Installation

For a stress-free installation, head to release page and download the latest version of the game. Only the executable IdleReader file is required to run the game. A version is available for each OS (Windows, Linux, MacOS).

To play the game, simply double click on the file that you have just downloaded.

Note for Windows users: For best experience, install Windows Terminal (default as of Windows 11 22H2!). See in-depth guide here. You can still play the game without Windows Terminal but the default rendering will be a bit off (such as not having emojis available).

For advanced users, you can build your own binaries of the game:

  • Clone the repository: git clone [repository]
  • Navigate to the repo and build the binaries with go build .
  • the binaries built should be called engine

📕 Wiki

The game wiki and FAQs can be found here:

IdleReader Wiki

This includes in-depth game guides and tutorials.

📕 Roadmap

Current version: v0.0.1

Road to v0.1

  • AllBooksLibrary migrating to SQLite
  • Exit View
  • Create adequate README.md
  • Create wiki
  • Update wiki on unicode rendering (use Windows Terminal if still using cmd.exe)
  • Store saves/database in different path depending on OS
  • Create a release page for pre-built .exe

Road to v0.2

  • Auction feature with higher price
  • Search Book function in Auction
  • Shop shows books depending on your IQ
  • Update Help View
  • Add a way to display whether item has already been purchased or not in Bookshop

Road to v0.3

  • [] Add item effects
  • [] Search Book function in My Bookshelf
  • [] Add price algorithm
  • [] Fetch and add real books (use external API or web scraper)
  • [] Algorithm with reading speed

Road to v1.0

  • [] Find solution backwards compatibility with PlayerSave gob
  • [] User Testing needed

Road to v2.0

  • [] Find gameplay for prestige

📕 License

This project is licensed under the terms of the MIT License. See the LICENSE file for details.

📕 Closing Thoughts & How To Contribute

Thank you for checking out my text-based idle game, IdleReader!

Contributions are welcome! Since it is my first full game that I have decided to release, I am still pretty new to this and there are many ways to contribute to Idle Reader. Here are a few asks:

  • Book Recommendations: Suggest books to add to the game's library, covering a wide range of genres and topics.
  • Pull Requests: Help improve the game's functionality, optimize performance, and fix any bugs or issues.
  • New Ideas: Share or code new features and ideas and don't hesitate to reach out to me directly!

Till Next Time