Skip to content

Commit e5a1dd4

Browse files
committed
Add repo README
1 parent 7d7a30e commit e5a1dd4

File tree

2 files changed

+85
-1
lines changed

2 files changed

+85
-1
lines changed

README.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# useless random color buttons
2+
3+
## Overview
4+
5+
This is a useless time waster built with vanilla JavaScript. The concept is simple: colored buttons spawn randomly and pile up on your screen. Your job is to click them to make them disappear.
6+
7+
I built this to experiment with handling visual chaos in the browser and tracking simple user interactions. As you play, the app tracks your stats—like how many buttons you've created, how many you've clicked, and your clicking speed. There is no deep meaning or complex gameplay loop here. It is just you against a rising tide of colorful buttons.
8+
9+
It started as one of my "Hello World" experiments—small, focused projects where I learn something new. It turned into a fully responsive Progressive Web App (PWA) that works on desktop and mobile, but at its core, it remains a simple, chaotic button clicker.
10+
11+
## How to Play
12+
13+
* **Click:** Tap or click buttons to remove them.
14+
* **Survive:** They spawn automatically. Don't let them cover the whole screen (or do, it's up to you).
15+
* **Track:** Watch your stats in the "Game View" or check the summary when you win or give up.
16+
* **Customize:** Open settings to change spawn rates, button labels (hex codes, numbers, timestamps), or the number of starting buttons.
17+
18+
## Two Ways to Run It
19+
20+
I've designed this project to be accessible in two distinct ways: as a modern web app and as a standalone offline file.
21+
22+
### 1. Online (PWA)
23+
24+
You can play the latest version directly in your browser at:
25+
**[https://urcbuttons.helloworldwriter.com/](https://urcbuttons.helloworldwriter.com/)**
26+
27+
Since it is a Progressive Web App, you can install it on your phone or desktop to run it like a native app.
28+
29+
### 2. Offline (Portable Edition)
30+
31+
If you prefer to keep things local, I provide a packaged offline version. You can download `urcbuttons-v2.0.0-portable.zip` from the **[Releases](../../releases)** page.
32+
33+
**How to run the offline version:**
34+
1. Unzip the archive.
35+
2. Locate `urcbuttons.html`.
36+
3. Double-click it.
37+
38+
It will open immediately in your default web browser. No internet connection is required.
39+
40+
**Where is the .exe?**
41+
You might be looking for an executable file. You won't find one. That is by design. By keeping it as a standard HTML file, the entire app remains incredibly small (under 100KB) and works on Windows, macOS, Linux, Android, and iOS without any installation or security warnings.
42+
43+
## Compatibility
44+
45+
Since this is a standard HTML5 application, it works on any modern device:
46+
* Windows (Edge, Chrome, Firefox)
47+
* macOS (Safari, Chrome, Firefox)
48+
* Linux (Firefox, Chromium)
49+
* Android & iOS
50+
51+
## Building from Source
52+
53+
If you want to tinker with the code, here is how to build it yourself.
54+
55+
**Prerequisites:**
56+
* Node.js installed.
57+
58+
**Setup:**
59+
```bash
60+
git clone https://github.com/TheHelloWorldWriter/useless-random-color-buttons.git
61+
cd useless-random-color-buttons
62+
npm install
63+
```
64+
65+
**Development:**
66+
To start the development server with hot reloading:
67+
```bash
68+
npm run dev
69+
```
70+
71+
**Build:**
72+
To create the production build (outputs to `dist/`):
73+
```bash
74+
npm run build
75+
```
76+
77+
To create the portable zip file (outputs to `dist-packaged/release/`):
78+
```bash
79+
npm run build:portable
80+
```
81+
82+
## License
83+
84+
This project is open source under the [MIT License](LICENSE).

assets/packaged/README.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ app runs.
3939

4040
It also saves space. If I had converted this to a native desktop app (using
4141
Electron or similar tools), the file size would be huge. By keeping it as pure
42-
web code, the entire app is only 85KB (and the ZIP archive is just 63KB). It's
42+
web code, the entire app is only 87KB (and the ZIP archive is just 64KB). It's
4343
simple, lightweight, and it works.
4444

4545

0 commit comments

Comments
 (0)