Quickstart
Set up and launch Zeta on Windows, then walk through your first synthetic order — navigate the workspace, reserve inventory, simulate delivery, and explore the warehouse view.
Set up and run Zeta
Set up and run the Zeta Synthetic Warehouse prototype on Windows, then verify the complete application flow with an isolated smoke test.
Download a pre-built package
If you only need to run the prototype, download a self-contained Windows package from GitHub Releases instead of building from source:
- Go to the Zeta releases page and download the latest
Zeta-<tag>-windows-x64.zipfile. - Extract all files from the ZIP archive.
- Run
Zeta.exe.
The package includes the .NET runtime, SQLite native dependencies, and all Godot resources. You do not need to install the .NET SDK, Godot, or a database server separately.
The package is an unsigned synthetic prototype. Windows SmartScreen may display a warning because the executable is not code-signed. Review the release notes before proceeding.
A separate Development package (Zeta-<tag>-windows-x64-development.zip) is also available for builds that include configurable development fixtures and shop movement. Development builds use a separate data directory and display a visible Development badge. Most users should use the Standard package.
Prerequisites
Install the following before you begin:
- .NET SDK
10.0.401 - Godot
4.7.2with .NET support - Windows 10 or Windows 11
- Git
Zeta is a Windows-first application. Normal execution is rejected on non-Windows platforms.
Set up the project
Clone the repository
Clone the repository into a local working directory, then open a terminal at the repository root.
Restore dependencies
Restore the locked dependency set:
dotnet restore Zeta.slnx --locked-mode
The restore completes without changing the locked dependency versions.
Build the solution
Build the solution with a single MSBuild worker:
dotnet build Zeta.slnx --no-restore -m:1
A successful build produces the compiled .NET projects without restoring dependencies again.
Run the tests
Run the integration and integrity test suite:
dotnet test tests/Zeta.Tests/Zeta.Tests.csproj --no-build --no-restore
The tests use temporary SQLite stores and ephemeral encryption keys. A successful run reports that all tests passed.
Launch the Godot application
Start the application from the repository root:
Godot --path src/Zeta.Godot
You can also open src/Zeta.Godot in the Godot editor and run the project from there. The application creates its local synthetic workspace on first startup and seeds demo products, stock, and orders when the store is empty.
Run a smoke test
Run the end-to-end validation flow without opening the interactive application:
godot --headless --path src/Zeta.Godot -- --smoke-test
Confirm that the process prints ZETA_SMOKE_OK before it exits.
The --smoke-test option creates an isolated temporary workspace, runs a real end-to-end flow, creates an encrypted snapshot, prints ZETA_SMOKE_OK, and exits. It does not modify your normal workspace under %LOCALAPPDATA%\Zeta\Synthetic-v1.
Normal execution is rejected on non-Windows platforms. The --smoke-test and --demo-preview options work cross-platform by using isolated temporary workspaces.
Use the application
After you launch the app, it creates three synthetic products, twelve units per product, and eight demonstration orders on first startup. You have a working workspace immediately.
All data is synthetic and uses DEMO- identifiers. There are no real deliveries, credentials, or external services. Zeta is a safe simulation.
Navigate the workspace
Use the Orders, Inventory, Exceptions, History, and Settings screens to inspect and manage the synthetic workspace. Press F2 to cycle between the Management, Warehouse, and Shop views.
The global controls work as follows:
- Search filters synthetic order IDs.
- State filters orders by state.
- + Synthetic order creates a new
DEMO-order. - Lock clears sensitive displays and pauses new work.
Process your first order
Open the Orders screen
Select a seeded order such as DEMO-1001 to open its detail window.
Refresh the fixture observation
Click Refresh fixture observation to get the latest synthetic marketplace data. Zeta checks whether the order is paid, supported, freshly observed, has a verified recipient, and is mapped to an exact item/model variant.
Reserve inventory
Click Reserve all lines. Reservation is all-or-nothing: if any line lacks available stock, nothing is reserved. On success, units move from AVAILABLE to RESERVED.
Approve delivery
Click Approve manual delivery. This moves the order to QUEUED but does not deliver anything.
Simulate the delivery outcome
Choose a synthetic outcome: Confirmed, Rejected, Pending, Partial, Unknown, or CrashAfterEffect. Click Simulate selected delivery outcome. Each outcome changes the order and inventory state differently.
For a full walkthrough of every order state, delivery outcome, and the reveal-and-attest flow, see the Order Processing guide.
Manage inventory
The Inventory screen shows available, reserved, quarantined, delivered, invalid, and total units for each product. Create synthetic products with names that start with DEMO-, import synthetic codes from text or CSV files, and map products to exact item/model variants. See Inventory Management for details.
Explore the warehouse view
Press F2 to toggle the 3D warehouse view. Shelves show product stock, packages group around receiving, packing, review, and dispatch stations, and colors indicate order states. Click shelves, packages, or stations to navigate. Right-drag to pan and use the mouse wheel to zoom. See Warehouse View for the full control reference.
Press F2 again to switch to the Shop view, which visualizes synthetic orders as arriving customers in a storefront. See Shop View for details.
Handle exceptions
Some seeded orders demonstrate edge cases: DEMO-1004 is unpaid and held, DEMO-1006 is unsupported and held, DEMO-1005 requests more stock than available and shows a shortage, and DEMO-1008 uses an unmapped item/model. Uncertain delivery outcomes move orders to REVIEW_REQUIRED and quarantine units. See Exceptions & Recovery for the full workflow.
Adjust settings
The Settings screen provides a fixture source online/offline toggle, reduced-motion mode, text scaling, encrypted snapshots and restore, interrupted-attempt recovery, and batch inspection. Offline mode permits local inspection and import, but refuses allocation, reveal, and delivery operations.
Where data is stored
Normal Windows execution stores application data at:
%LOCALAPPDATA%\Zeta\Synthetic-v1
The directory contains:
- SQLite database
- Ownership lock
- DPAPI-protected key file
- Application preferences
- Encrypted backups
The key file is protected for the current Windows user. Do not delete or replace it while the database is in use, because the application cannot decrypt existing inventory or backups without the original key material.
Development builds use a separate data directory at %LOCALAPPDATA%\Zeta\Development-v1. Data is not shared between Standard and Development builds.
Command-line options
Run the application with these options after the Godot project arguments:
--smoke-test: Run the isolated end-to-end smoke test and exit.--demo-preview: Open a visual preview using an isolated temporary workspace.--view=Warehouse|Shop|Inventory|Settings|History: Select the initial application view.--screenshot=<path>: Capture the selected preview or application view to the specified path.--development: Enable the Development environment for editor or source runs. Exported executables are already configured for their build environment.--expect-development: Assert that the running build is a Development build. Fails startup if the build does not match.--expect-standard: Assert that the running build is a Standard build. Fails startup if the build does not match.
For example, launch directly into the inventory view:
Godot --path src/Zeta.Godot -- --view=Inventory