Skip to content

mikelyons/study-game

Repository files navigation

Study Game

This is an idle clicker game built with React and Vite. The goal is to manage resources, upgrade your skills, and progress through the ranks of knowledge.

🎮 Play the Game Here! 🎮

About

This is an incremental study game built with React, TypeScript, and Vite. Study hard and you too can be successful!

Development

To run the project locally:

# Clone the repository
git clone https://github.com/mikelyons/study-game.git
cd study-game

# Install dependencies
npm install

# Start development server
npm run dev

Deployment

This project is automatically deployed to GitHub Pages using GitHub Actions. Every push to the main branch triggers a new deployment.

To deploy manually:

npm run deploy

For detailed deployment setup instructions, see DEPLOYMENT.md.

Technologies Used

  • React 19 - UI library
  • TypeScript - Type-safe JavaScript
  • Vite - Fast build tool and dev server
  • GitHub Pages - Hosting platform

How to Play

  • Sleep: Increase your energy.
  • Study: Increase your knowledge. This action may be limited by your rank.
  • Upgrade Study Habits: Improve the efficiency of your studying.

Game Mechanics

The game revolves around balancing your energy and knowledge.

  • Energy: Regenerated by sleeping. It's a key resource for progression.
  • Knowledge: Gained by studying. Reaching certain knowledge thresholds allows you to rank up.
  • Ranks: You start as a "child" and progress through various stages of learning, from "student" to "god" and beyond. Each rank has a knowledge requirement.
  • Upgrades: You can improve your "study habits" and "study power" to accelerate your knowledge acquisition.

Planned Features

  • Implement a timer for passive resource generation.
  • Add visual effects for ranking up and clicking.
  • Create a running log of game events.
  • Add tooltips to UI elements for better guidance.
  • Balance the energy consumption and regeneration mechanics.
  • Deploy the game using GitHub Pages.

Getting Started

To run the project locally:

  1. Clone the repository.
  2. Install dependencies: npm install
  3. Start the development server: npm run dev

About

An idle clicker game in modern react

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •