aboutsummaryrefslogtreecommitdiffstats
path: root/web/README.md
blob: 50e8cefec09a50f361498eb406f03099c990d18b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# ugi.gumx.cc

Web-based UGI (Unified Geek Identifier) encoder, decoder, and format converter.

## What is this?

A self-contained HTML tool for working with UGI strings — the modernized Geek Code. It provides three functions:

- **Encoder** — form-based interface to build a UGI string by selecting fields, sub-IDs, and ratings
- **Decoder** — paste a UGI string (URI or block format) and see a human-readable breakdown
- **Converter** — convert between URI format (`ugi:0@handle:...`) and block format

The tool is a single HTML file with no external dependencies. The full UGI registry is embedded inline.

## Usage

Open `index.html` in any browser. No server required.

Supports `prefers-color-scheme` for automatic dark mode.

## Regenerating

The generator script takes the registry JSON path and output file path as arguments:

```bash
python scripts/gen_tool.py /path/to/ugi_registry_v0.json index.html
```

### Requirements

- Python 3.8+
- No external dependencies

## Project structure

```
ugi.gumx.cc/
├── index.html       # generated tool (deploy this)
├── scripts/
│   └── gen_tool.py  # HTML tool generator
└── README.md
```

## License

MIT