README.md (view raw)
1# Clicker Game
2
3A generic clicker game built with React, TypeScript, and Vite. This project implements a Progressive Web App (PWA) with all the classic clicker game features.
4
5## Features
6
7- Click to earn currency
8- Purchase upgrades to increase click value
9- Automatic clicking upgrades
10- Passive income generation
11- Prestige system for restarting with multipliers
12- Offline progression
13- Mobile responsive design
14- PWA support for installation on devices
15
16## Game Mechanics
17
18- **Click Value**: Determines how much currency you earn per click
19- **Passive Income**: Automatically generates currency over time
20- **Auto Click**: Automatically clicks for you at a specific rate
21- **Prestige System**: Reset your progress to earn permanent multipliers
22
23## Installation
24
251. Clone the repository:
26 ```
27 git clone https://github.com/yourusername/clicker-game.git
28 cd clicker-game
29 ```
30
312. Install dependencies:
32 ```
33 npm install
34 ```
35
363. Run the development server:
37 ```
38 npm run dev
39 ```
40
414. Build for production:
42 ```
43 npm run build
44 ```
45
465. Preview the production build:
47 ```
48 npm run preview
49 ```
50
51## Customization
52
53This is a generic clicker game template that you can customize:
54
55- Update theme colors in `App.css` and component styles
56- Add your own theme and story in text elements
57- Modify upgrade values and costs in `gameData.ts`
58- Add new game mechanics by extending the `GameState` type
59
60## PWA Support
61
62The game includes full PWA support:
63- Installable on mobile and desktop devices
64- Offline functionality
65- Home screen icon
66- Splash screen
67
68## License
69
70MIT