diff --git a/ASSETS-LICENSE.md b/ASSETS-LICENSE.md index 7c9614b..183b1d0 100644 --- a/ASSETS-LICENSE.md +++ b/ASSETS-LICENSE.md @@ -553,6 +553,26 @@ decoded RGBA hash, alpha profile, and visible bounds are recorded in the The runtime file remains under `LicenseRef-Warpkeep-Provenance-Required`; neither its location in `public/` nor the cleanup operation silently relicenses it. +## Realm Wheat Farm README preview + +On 22 July 2026, the Warpkeep project owner supplied an exact Realm screenshot +of the Wheat Farm inspection presentation and instructed that it replace the +root README preview. That instruction authorizes the exact checked-in PNG for +documentation in this public Warpkeep repository; it does not establish +underlying ownership or grant a separate open license for the embedded runtime +assets, public profile imagery, names, or trademarks. The image is explicitly +labeled as a documentation preview and does not itself activate or authorize a +gameplay state. + +| Intended use | Repository file | Technical record | +| --- | --- | --- | +| Root README development preview | `docs/reference/screenshots/2026-07-18-procedural-grass-wind-preview/warpkeep-procedural-grass-preview-eb156adea5befbd7.png` | 2000×1264 RGB PNG, 3,146,015 bytes, SHA-256 `f3b1f7e598c543d6c0e74813286da97d96b219ee56bc5d764c9853bfec27fe3e`. | + +The screenshot remains `LicenseRef-Warpkeep-Provenance-Required` and is not a +runtime dependency. Its [dated record](docs/reference/screenshots/2026-07-18-procedural-grass-wind-preview/) +preserves the exact hash, display scope, privacy review, and authorization +boundary. No general derivative or redistribution permission is granted. + ## Trademark and endorsement note These licenses do not grant trademark rights or imply endorsement by the project. Forks, mods, and community realms should avoid presenting themselves as the canonical Warpkeep deployment unless explicitly authorized; see [`TRADEMARKS.md`](TRADEMARKS.md). diff --git a/README.md b/README.md index 2e2a190..28419a0 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,18 @@ # Warpkeep -**[Warpkeep](https://warpkeep.com/) is an open-source software project building a persistent strategy world where a Farcaster identity becomes a permanent castle.** - -Genesis 001 is an invite-only Lowlands realm. Its 10,000 cells, coast, rivers, -roads, forests, resource sites, and 100 castle foundations are shared by -every player. A founder's keep stays in the same place between visits, carrying -a public name and portrait while ownership and private resources remain -server-controlled. - -Alpha 0.3.13 gives the Lowlands a more natural shape. Twelve persistent rivers -cross clustered forests and grasslands before reaching an ocean that can be -explored up to the fog. Founders can follow and select the separate supply -wagon sent to each resource site, but this is still the beginning: -construction, armies, combat, trade, and the wider strategy loop are not -playable yet. - -Warpkeep is currently developed in the open by one person and shaped by -community feedback. It is an experiment, not a financial product: Alpha -participation earns no airdrop, guaranteed reward, or promised financial -return. Community Marks are separate in-game accounting with no live spending, -transfer, or cash-value loop. - -## What is live - -- A persistent 10,000-cell world with a coastline, twelve rivers, and 100 - permanent castle sites. -- Farcaster sign-in, invite-only founding, and one durable keep per player. -- Public castle names and portraits with private ownership records. -- Private Food, Wood, Stone, and Gold accounts; terrain yield and expedition - settlement remain controlled by the server. -- Shared Gold Mines, Wheat Farms, Logging Camps, and Stone Quarries, each with - a selectable independent wagon expedition. -- A shared forest, clustered outer groves, biome-driven grass, responsive WebGL - rendering, and coast-to-fog navigation across desktop and mobile layouts. - -The browser presents the realm. SpacetimeDB decides admission, ownership, -balances, routes, timers, and expedition outcomes. - -## Run locally - -Prerequisites: Git, Node.js 22, and npm 10. +**[Warpkeep](https://warpkeep.com/) turns a Farcaster identity into a permanent castle in a shared strategy world that remembers you.** + +## What is this? + +Genesis 001 is a persistent, invite-only 10,000-cell Lowlands realm with 100 permanent castle sites kept close to its founding district. Each founder signs in with a verified Farcaster identity, receives one durable keep, and can privately collect four resources from its terrain: Food / Wood / Stone / Gold. Alpha 0.3.8 is live but early; exploration and the private resource loop work today, while the intended core strategy loop is not playable yet. Warpkeep is a one-person experiment—not a finished MMO or financial product; there are no token rewards, no financial promises, and joining does not earn an airdrop or financial return or guarantee a reward or future value. + +![Development preview of Genesis 001 showing the Lowlands and an open Wheat Farm inspection panel.](docs/reference/screenshots/2026-07-18-procedural-grass-wind-preview/warpkeep-procedural-grass-preview-eb156adea5befbd7.png) + +*Development preview of the Realm Wheat Farm inspection flow; this documentation image does not itself activate or authorize gameplay.* + +## Quick start + +Prerequisites: Git, Node.js 22, and npm. ```sh git clone https://github.com/ael-dev3/Warpkeep.git @@ -48,37 +21,44 @@ npm ci npm run dev ``` -The local app does not grant shared Alpha access. Before contributing, run the -checks in [CONTRIBUTING.md](CONTRIBUTING.md) and read the -[asset provenance rules](ASSETS-LICENSE.md); protected source packages are not -part of a normal build. - -## Architecture - -- React, TypeScript, Vite, Three.js, and responsive CSS power the client. -- A Cloudflare Worker verifies Farcaster sign-in and issues least-privilege, - short-lived credentials. -- SpacetimeDB owns the persistent world and private player state. -- GitHub Actions verifies the client, auth bridge, database module, generated - bindings, migrations, dependencies, licenses, and asset contracts. - -Start with the [technical architecture](docs/technical-architecture.md), -[roadmap](docs/design/roadmap.md), and [documentation guide](docs/README.md). - -## Community and project links - -- [Play Warpkeep](https://warpkeep.com/) -- [Warpkeep channel on Farcaster](https://farcaster.xyz/~/channel/warpkeep) -- [Realm Council issue forms](https://github.com/ael-dev3/Warpkeep/issues/new/choose) -- [Visual asset archive](https://github.com/ael-dev3/Warpkeep-Assets) -- [Contributing guide](CONTRIBUTING.md) -- [Code of Conduct](CODE_OF_CONDUCT.md) -- [Release history](CHANGELOG.md) -- [Security reporting](SECURITY.md) +Open the local URL Vite prints; shared Alpha access stays off by default. Contributor checks live in [CONTRIBUTING.md](CONTRIBUTING.md), authentication setup lives in the [Farcaster integration](docs/farcaster-integration.md) guide, and deeper setup lives in [reconstruction and recovery](docs/operations/reconstruction/README.md). Asset reconstruction is explicit and not part of a normal build; read [asset provenance](ASSETS-LICENSE.md) before working with protected source packages. + +## Current status + +| State | Today | +| --- | --- | +| ✅ Live | Alpha 0.3.8 is live and invite-only. | +| ✅ World | Genesis 001 persists 10,000 cells and keeps 100 permanent castle sites near the founding district. Founders return to one durable keep, explore the Lowlands, and inspect nearby founders through their public username / portrait / castle. The same authoritative world waits across sessions. | +| ✅ Authority | FID is the durable identity; handles and portraits are bounded presentation metadata. Farcaster sign-in uses a browser-bound, least-privilege bridge. The browser presents. The server decides admission and ownership. It also owns resources, timers, and saved state. | +| ✅ Resources | Each keep privately collects Food / Wood / Stone / Gold from authoritative terrain. The browser never invents balances. | +| ✅ Marks | Community Marks are separate private accounting and start at zero. They cannot be spent, converted, or transferred. They have no cash value, promised utility, or reward loop. The world, rules, and direction will evolve. | +| 🚧 In progress | Draft PRs cover Gold and Food wagon expeditions; a shared forest; procedural grass and wind; founder-admission hardening; clearer Alpha framing; and a Hegemony entry agreement. None is live. | +| 📋 Planned | Resource nodes; construction and upgrades; units / scouting / travel / combat; alliances / trading / chat; seasons / governance / rewards. Design notes are experiments, not promises that these features will ship unchanged. | + +## Tech stack + +- **React** — Keeps interactive interface components manageable. +- **TypeScript** — Makes shared data contracts explicit. +- **Vite** — Builds the browser client quickly. +- **Three.js / WebGL** — Renders the Lowlands in browsers. +- **Responsive CSS** — Supports phones, keyboards, and fallbacks. +- **Farcaster Auth** — Connects castles to verified identities. +- **Cloudflare Workers** — Verifies sign-in with least privilege. +- **SpacetimeDB** — Owns Realm and player state. +- **Vitest** — Catches regressions across critical boundaries. + +## Links + +- **Architecture:** The [technical architecture](docs/technical-architecture.md) explains what the browser shows and what the server decides. +- **Roadmap:** The [roadmap](docs/design/roadmap.md) and [game direction](docs/design/warpkeep-direction.md) separate today's game from later plans. +- **Authentication:** The [Farcaster integration](docs/farcaster-integration.md) guide covers sign-in, privacy, and public configuration. +- **Release:** The [Alpha 0.3.8 release notes](CHANGELOG.md#038--2026-07-18) record exactly what is live. +- **Licensing:** [LICENSING.md](LICENSING.md) explains release rules; [asset provenance](ASSETS-LICENSE.md) records where media came from and what permissions apply. +- **Contributing:** [CONTRIBUTING.md](CONTRIBUTING.md) covers checks and provenance; the [Realm Council issue forms](https://github.com/ael-dev3/Warpkeep/issues/new/choose) accept privacy-safe bugs and ideas. +- **Security:** Report sensitive issues privately through [SECURITY.md](SECURITY.md), never through a public issue. +- **Quality:** The [verification checklist](docs/operations/reconstruction/verification-checklist.md) covers desktop / phone / keyboard / touch / reduced-motion / fallback checks. +- **Community:** Play at [warpkeep.com](https://warpkeep.com/), join the [Warpkeep channel on Farcaster](https://farcaster.xyz/~/channel/warpkeep), and explore the [provenance-tracked visual archive](https://github.com/ael-dev3/Warpkeep-Assets). ## License -Warpkeep software is Apache-2.0. Authorized project-owned creative work follows -the recorded CC-BY terms; some GameReady runtime assets have narrower reuse -permissions. Read [LICENSING.md](LICENSING.md) and -[ASSETS-LICENSE.md](ASSETS-LICENSE.md) before reusing media. +Warpkeep software uses Apache-2.0; authorized project-owned creative work follows the recorded CC-BY terms, while some GameReady runtime assets have narrower permissions and no general open-content or derivative license—read [LICENSING.md](LICENSING.md) and [ASSETS-LICENSE.md](ASSETS-LICENSE.md) before reuse. diff --git a/docs/reference/screenshots/2026-07-18-procedural-grass-wind-preview/README.md b/docs/reference/screenshots/2026-07-18-procedural-grass-wind-preview/README.md new file mode 100644 index 0000000..a6f8743 --- /dev/null +++ b/docs/reference/screenshots/2026-07-18-procedural-grass-wind-preview/README.md @@ -0,0 +1,29 @@ +# Realm Wheat Farm development preview + +## Authorized use + +On 22 July 2026, the Warpkeep project owner supplied this exact screenshot and +authorized its replacement use in the public Warpkeep repository and root +README. It is documentation only and is not a runtime dependency or release +claim. + +## Technical record + +- Repository file: `warpkeep-procedural-grass-preview-eb156adea5befbd7.png` +- Format: 2000×1264, 8-bit RGB, non-interlaced PNG +- Length: 3,146,015 bytes +- SHA-256: `f3b1f7e598c543d6c0e74813286da97d96b219ee56bc5d764c9853bfec27fe3e` + +The capture shows the Genesis 001 Lowlands with an open Wheat Farm inspection +panel, map resources, and a gathering expedition presentation. It is a +documentation preview and does not itself activate or authorize a gameplay +state. It shows no numeric FID, wallet address, QR payload, authentication +proof, bearer token, cookie, credential, private log, or admin output. + +## Rights boundary + +The screenshot remains `LicenseRef-Warpkeep-Provenance-Required`. The owner's +instruction authorizes this exact repository and README use; it does not +relicense embedded GameReady castle or landscape assets, resource icons, +profile imagery, names, or trademarks. It grants no general derivative or +redistribution permission. diff --git a/docs/reference/screenshots/2026-07-18-procedural-grass-wind-preview/warpkeep-procedural-grass-preview-eb156adea5befbd7.png b/docs/reference/screenshots/2026-07-18-procedural-grass-wind-preview/warpkeep-procedural-grass-preview-eb156adea5befbd7.png new file mode 100644 index 0000000..7d22a47 Binary files /dev/null and b/docs/reference/screenshots/2026-07-18-procedural-grass-wind-preview/warpkeep-procedural-grass-preview-eb156adea5befbd7.png differ