AsyncAO github wiki page WIP

Abierto
  • ¿Algo no está bien?
#132 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
55/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
go
Área
documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Go
Estrellas
4
Forks
3
Merge medio
6 d 21 h
PR fusionados (30 d)
1

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de SyntaxNyah/AsyncAO

Todos los issues de SyntaxNyah/AsyncAO

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.