AMOOSEDWEB / DEVELOPER DOCUMENTATION / v0.27.1

Build AmoosedWeb into your product.

Technical documentation for third-party developers. Compile and host a carrier-backed site, read verified resources from native C++, Node.js, or .NET, and follow the native C/C++ compiler and Reader work toward a stable 1.0 ABI.

CHOOSE A PATH

Start with the interface you need.

Compiler & static hosting

Build the ordinary site and carrier-backed app, package a static release, then validate host routes and byte-preserving media. The published compiler uses Node.js; native C++ compilation is in development.

Integration guide →

Native C/C++ Reader and compiler

Integrate verified resources into a service, tool, desktop application, or game. Reader headers and prebuilt libraries are in local review; the native compiler is an owner-side prototype.

Native development status →

Plain C quickstart →

Node.js Reader SDK

List and download verified resources in an ESM application, with optional index and member key files.

Node.js API →

.NET Reader SDK

Use the Windows x64 native-backed C# facade from a .NET 10 application.

.NET API →

For engine-specific work, see the Unreal integration walkthrough →

MINIMAL WORKFLOW

From starter to verified output.

Install the compiler, create a project, edit site/ and app/, then build. The generated project includes its own README and version-matched helper scripts.

npm install -g amoosedweb-compiler
amw init my-site
cd my-site
build.cmd               # Windows
# sh build.sh            # macOS or Linux

For an existing host, export the same-version runtime and follow its route contract. Validate the live host after publishing.

amw export-runtime ./amw-routes
amw check-host https://your-site.example/

Existing-host requirements →

BOUNDARIES

Know what the verification proves.

Integrity

Readers verify carrier parts and reconstructed resources against the index. HTTPS authenticates the transport.

Format details →

Access

A public hosted index is discoverable. External index and member keys are transferable bearer credentials.

Access model →

Deployment

Carriers need byte-preserving hosting. The app runtime and its service worker belong on the same origin as the site.

Host contract →

Building with an AI coding agent? Give it the SDK integration guidelines for agents →.

PROTOCOL

See the bytes and the read path.

The illustrated protocol guide explains the AMW payload, carrier layouts, index and member keys, resource checks, and same-origin boot flow. Start there for a human-readable map; use the full format specification for exact fields and limits.