AsyncAO github wiki page WIP

オープン
  • 何か問題がありますか？
#132 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
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時間
マージ済み PR（30日）
1

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

SyntaxNyah/AsyncAO のほかの issue

SyntaxNyah/AsyncAO の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。