AsyncAO github wiki page WIP

未关闭
  • 哪里不对？
#132 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
55/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
go
领域
documentation

调研方向

Start with docs/ARCHITECTURE.md and the listed project areas, especially cmd/asyncao, internal/render, and internal/assets, to verify the build steps and architecture details. The issue asks for an easy-to-understand GitHub wiki page covering building, the render and asset-thread models, efficiency, and the listed project parts; done means new contributors can use the page to understand those topics.

由索引模型根据 Issue 内容生成。

描述

documentation good first issue help wanted not before 3.0

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

主要语言
Go
星标
4
派生
3
平均合并
6 天 21 小时
30 天内合并 PR
1

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

SyntaxNyah/AsyncAO 的其他 Issue

查看 SyntaxNyah/AsyncAO 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。