xodus-gaming/xodus

1. Repository shape

- This is a Rust workspace with two crates:

- xodus: the core library that implements Xbox PC game auth, licensing, package handling, and XVD/MSIXVC crypto/parsing.

- xodus-cli: a command-line front end that drives the library for user-facing flows like login, license retrieval, download, and extraction.

2. Overall purpose

- Xodus targets the end-to-end pipeline needed to run Xbox PC games on Linux: authenticate a user/device, obtain licenses, fetch game packages, and process MSIXVC/XVD content.

- The README shows the project is already centered on login, package download, license acquisition, parsing, and decryption, with remaining work around on-demand EXE decryption and MSIXVC2 support.

3. CLI boundary

- xodus-cli is the operational entry point.

- Its command modules (login, license, download, extract) are thin orchestration layers over the library.

- Supporting code like webview.rs, device.rs, and user.rs suggests the CLI also handles interactive auth/device setup and local state presentation, not just raw API calls.

4. Authentication subsystem

- The library has a dedicated auth layer in xodus/src/auth.rs, supported by models/live.rs, SOAP models, and api/live.

- This indicates Microsoft/Xbox authentication is not a single request but a staged exchange involving user auth, token brokerage, and token exchange.

- The docs tree reinforces this with separate documentation for login, Xbox Live, Xbox services, and Game Pass.

5. Device identity and registration

- Device-related logic is split out into hardware.rs, models/devicecredential.rs, and secrets.rs.

- This subsystem appears responsible for device registration, device credential generation/storage, and derived device keys mentioned in the README.

- In the architecture diagram, this should sit alongside auth because the device identity is part of the credential chain used later for licensing and downloads.

6. Licensing subsystem

- Licensing is a distinct core area: licensing.rs, licensing/content.rs, licensing/splicense.rs, plus helper utilities and models.

- The README’s “license parsing” and “licensing flow” map directly to this layer.

- This subsystem likely consumes tokens and device credentials, then produces entitlement/license artifacts needed to authorize game package access.

7. External service APIs

- api/live and api/xbox provide the outbound integrations.

- api/displaycatalog.rs indicates catalog lookups for game/product metadata, while the live/xbox modules likely wrap Microsoft/Xbox service endpoints.

- The architecture is therefore centered on external service calls rather than a local server or database.

8. Protocol and serialization layer

- models/soap contains SOAP envelope/security/token structures, which means part of the auth flow uses SOAP-based Microsoft endpoints.

- The models tree also includes structured representations for licensing, display catalog, CLEP, secrets, and XVD data.

- This layer is the contract boundary between network payloads and the rest of the business logic.

9. Content/package handling

- xodus/src/xvd and models/xvd implement the MSIXVC/XVD domain: constants, flags, raw/parsed structures, math, crypto, and utilities.

- This is the package-processing pipeline used after download: parse the package, understand its structure, and decrypt content where supported.

- The README’s “MSIXVC parsing support” and “Decryption” map here.

10. CLEP / challenge handling

- clep.rs and clep/challenge.rs show a specialized challenge/response subsystem.

- This likely supports cryptographic validation or key derivation steps in the broader licensing/content flow.

- For an architecture diagram, it belongs between licensing/auth and content decryption, since it appears to participate in protected-content access.

11. Data flow through the system

- A typical flow is:

1. CLI triggers login.

2. Auth modules obtain user and device tokens.

3. Device registration and key derivation complete.

4. Licensing modules fetch/parse licenses.

5. API modules query catalog/download data.

6. XVD/MSIXVC modules parse and decrypt package content.

- The CLI is the coordinator; the library contains the stateful domain logic.

12. Documentation and project scaffolding

- docs/ is organized by domain (xbox, xodus) and mirrors the code boundaries, which is useful for mapping subsystems to diagram boxes.

- GitHub Actions (.github/workflows/rust.yml) indicates standard Rust CI, but there is no sign of a backend service or persistent datastore; the product is primarily a local client and library interacting with remote Microsoft/Xbox services.