Skip to content

Commit 8fec14e

Browse files
docs(readme): convert README.adoc -> Markdown (renders on Glama/profile/community-health) (#34)
README was AsciiDoc → renders as raw markup in Markdown consumers (Glama MCP directory, GitHub community-health, GitHub profile). pandoc asciidoc→GFM (badges → clickable), SPDX header kept, duplicate `.adoc` removed. Part of the estate README-format fix. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 74427df commit 8fec14e

2 files changed

Lines changed: 169 additions & 168 deletions

File tree

README.adoc

Lines changed: 0 additions & 168 deletions
This file was deleted.

README.md

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
<!--
2+
SPDX-License-Identifier: CC-BY-SA-4.0
3+
SPDX-FileCopyrightText: 2025-2026 Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
4+
-->
5+
6+
[![MPL-2]()](https://opensource.org/licenses/MPL-2.0)
7+
[![Palimpsest]()](https://github.com/hyperpolymath/palimpsest-license)
8+
9+
**Ethical merge game with Mandelbrot dogtags - no scams, just maths.**
10+
11+
\[\![RSR
12+
Compliant\]([https://img.shields.io/badge/RSR-Compliant-gold)\](./MANIFESTO.md](https://img.shields.io/badge/RSR-Compliant-gold)](./MANIFESTO.md))
13+
14+
# What is MegaDog?
15+
16+
MegaDog is an ethical remake of predatory mobile "merge dog" games.
17+
Instead of fake money promises and psychological manipulation, we offer:
18+
19+
- **Real Ownership**: Your dogs are NFTs you actually own
20+
21+
- **Beautiful Maths**: Unique Mandelbrot fractals as dogtags
22+
23+
- **Transparent Economics**: All code open source, all odds public
24+
25+
- **Memory-Safe Stack**: Pony + Vyper + Kotlin (no exploits)
26+
27+
# Quick Start
28+
29+
```bash
30+
= Enter development environment
31+
32+
nix develop
33+
34+
= See available commands
35+
36+
just
37+
38+
= Build everything
39+
40+
just build-all
41+
42+
= Run server
43+
44+
just container-run
45+
```
46+
47+
# Architecture
48+
49+
┌─────────────────────────────────────┐
50+
│ Android Client (Kotlin) │
51+
│ • Merge UI • Mandelbrot Renderer │
52+
└─────────────┬───────────────────────┘
53+
│ WebSocket
54+
55+
┌─────────────────────────────────────┐
56+
│ Pony Game Server │
57+
│ • State Management • Anti-Cheat │
58+
│ • Batch Aggregation │
59+
└─────────────┬───────────────────────┘
60+
│ Batched Diffs
61+
62+
┌─────────────────────────────────────┐
63+
│ Polygon Blockchain │
64+
│ • Vyper Contracts │
65+
│ • Logarithmic Storage │
66+
│ • NFT Ownership │
67+
└─────────────────────────────────────┘
68+
69+
# The Innovation: Logarithmic Storage
70+
71+
Traditional games store values directly: `` ` `` `treats` `=`
72+
`1,000,000,000` `(uint256:` `32` `bytes)`\`
73+
74+
MegaDog stores logarithmically: `` ` `` `log_treats` `=`
75+
`ln(1,000,000,000)` `×` `10^6` `=` `20,723,266` `(int128:` `16`
76+
`bytes)`\`
77+
78+
**Result**: 50% storage reduction, ~30% gas savings at scale.
79+
80+
# Mandelbrot Dogtags
81+
82+
Each dog generates a unique 3D Mandelbulb fractal based on: - Dog level
83+
(complexity) - Merge history (seed) - Birth timestamp (entropy)
84+
85+
These fractals are: - Deterministic (reproducible by anyone) - Beautiful
86+
(actual mathematical art) - Exportable (4K wallpapers, NFT metadata)
87+
88+
# RSR Compliance
89+
90+
This project follows the Rhodium Standard Repository specification:
91+
92+
-**Nix flakes** for hermetic builds
93+
94+
-**Nickel** for type-safe configuration
95+
96+
-**Justfile** for comprehensive CLI
97+
98+
-**Podman** with Wolfi base images
99+
100+
-**GitLab** for source control
101+
102+
-**Memory-safe languages** throughout
103+
104+
# Project Structure
105+
106+
megadog/
107+
├── android/ # Kotlin Android app
108+
│ └── app/src/main/kotlin/com/megadog/
109+
│ ├── renderer/ # Mandelbrot GPU renderer
110+
│ └── game/ # Game logic & client
111+
├── server/ # Pony game server
112+
│ └── src/ # Actor-based architecture
113+
├── contracts/ # Vyper smart contracts
114+
├── config/ # Nickel configurations
115+
├── containers/ # Podman containerfiles
116+
├── scripts/ # Deployment scripts
117+
└── docs/ # Documentation
118+
119+
# Commands
120+
121+
```bash
122+
= Development
123+
124+
just dev # Enter Nix shell
125+
just validate # Validate all configs
126+
just fmt # Format code
127+
128+
= Build
129+
130+
just build-server # Build Pony server
131+
just build-android # Build Android app
132+
just build-all # Build everything
133+
134+
= Containers
135+
136+
just container-build # Build with Podman
137+
just container-run # Run locally
138+
just container-scan # Security scan
139+
140+
= Contracts
141+
142+
just contracts-compile # Compile Vyper
143+
just contracts-deploy # Deploy to testnet
144+
145+
= Testing
146+
147+
just test-all # Run all tests
148+
```
149+
150+
# Philosophy
151+
152+
Read \[MANIFESTO.md\](./MANIFESTO.md) for why we built this.
153+
154+
Read \[ARCHITECTURE.md\](./ARCHITECTURE.md) for how it works.
155+
156+
Read \[CONTRIBUTING.md\](./CONTRIBUTING.md) to help out.
157+
158+
# License
159+
160+
PMPL-1.0 - Because games should be games, not slot machines.
161+
162+
------------------------------------------------------------------------
163+
164+
**The dogs deserve better. So do the players.**
165+
166+
# Architecture
167+
168+
See <a href="TOPOLOGY.md" class="md">TOPOLOGY</a> for a visual
169+
architecture map and completion dashboard.

0 commit comments

Comments
 (0)