Skip to content

AsyncAO github wiki page WIP #132

Description

@SyntaxNyah

Project Overview
Asyncao is a client for Ace Attorney Online (AO2). It reimplements the AO2 wire protocol in a clean-room fashion and provides a native rendering, audio, and networking stack.

Make an easy to understand github wiki page that explains the project to new potential contributers sections such

building

All of the dependencies and build guide.

The render loop and the Asset thread model and how efficient it is.

Zero allocation render loop under a 256 MiB budget; a static courtroom renders nothing (real frame limiter, not vsync).

AsyncAO runs everything through one render thread, and only three packages are allowed to touch SDL. Slow work like image decoding and asset fetching is pushed onto small worker goroutines that hand results back over bounded channels, while assets load through four tiers (GPU textures, raw bytes, disk, then network) with exactly one probe per asset that learns the server's format. The render loop is zero-allocation under a 256 MiB budget and driven by a real frame limiter, so a quiet server renders nothing at all and is efficient in the background to save memory cpu usage.

Key Parts of the Project

cmd/asyncao entry point, wiring, quit logic.

internal/render SDL, viewport, audio (SDL Mixer X), the decode-pool consumer.

internal/ui screens, settings, hotkeys, the render-loop UI.

internal/courtroom AO2 scene logic: emotes, pairing, SFX, message flow.

internal/assets the asset pipeline (manager, resolver, manifest, decoder, types).

internal/config preferences

internal/network WebSocket + HTTP client.

internal/protocol the AO2 wire protocol

internal/theme theme parsing.

internal/voice Opus voice chat.

internal/presence Discord (pure Go, optional).

internal/update the auto updater

internal/archive / internal/videoenc recording / export.

Conventions

  • Comments explain why; protocol behavior cites the AO2-Client source line.
  • Every Prefetch call site carries an // AssetType: X comment.
  • Cache keys are full URLs (host included) per-server separation is structural.
  • New dependencies need a written justification in docs/ARCHITECTURE.md.
  • Tests pin behavior and performance (testing.AllocsPerRun).

extensions.json = the server's format manifest (webAO convention); .webp.static/.webp.animated normalize to .webp. and also the new things for sfxs.

Just some potential layout for the project

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions