Skip to content

Fix the stale docs from section 11 of the roadmap - #75

Open
dzolotov wants to merge 5 commits into
0.9.0from
wf/stale-docs-0-9
Open

dzolotov wants to merge 5 commits into
0.9.0from
wf/stale-docs-0-9

Conversation

@dzolotov

@dzolotov dzolotov commented Oct 3, 2026

Copy link
Copy Markdown
Collaborator

Section 11 of tasks/0.9-engine-roadmap.md listed three things the docs had wrong. This branch fixes them. There is no code change.

Texture encoder. README and ARCHITECTURE §8.4/§15 said dart run flutter3d_build:convert had no texture encoder. It has one. --textures bc writes BC1 for an opaque image and BC3 for one with alpha, etc2 writes ETC2 RGB, and universal writes a file of 4×4 blocks that the load turns into BC, ASTC 4×4, ETC2 or RGBA8. The build hook picks BC or ETC2 from its target. I checked the demos' source models: the textures embedded in them are all whole 4×4 blocks, so a native build of the dungeon, platformer and racing demos ships them compressed. The passages now also say what stays uncompressed: everything on the web, the loose PNGs under assets/textures/, ETC2 with alpha, and sizes that aren't whole blocks. The same §15 paragraph still listed UASTC and Zstandard/ZLIB as refused, but the loader reads both now, so I fixed that too. I also corrected one line in the racing models' licence note.

README package table. Added rows for flame_flutter3d, flame_flutter3d_audio, flame_multiplayer + flame_multiplayer_dashwire, flutter3d_lti, flutter3d_editor_play, flutter3d_audio_core and packages/education/chemlab. The arcade, river, showcase and incident apps had no rows either, so they have them now. Every directory under packages/ and apps/ is now in the table.

Comparison page. The core version goes from 0.8.2 to 0.8.3+1. The multiplayer row now names flame_multiplayer and its dashwire wire. There is a new input row: on our side flutter3d_game's actions over pad_input/pointer_lock, on Scene's side flutter_scene_input, which has been in its repository since 2026-09-14 at 0.1.0-dev and isn't on pub.dev. A Flame bridge row and the bullet name flame_flutter3d 0.8.5, River Sortie and the single-model component. I checked these against pub.dev and both repositories on 2026-10-03, and the page now gives that date. Following decision 19, the rest of the table is untouched until the full 0.9.0 revision.

Testing. dart run tool/structure.dart: "35 rules, all held". A grep finds no "no encoder" sentence left in README, ARCHITECTURE or the site.

Left. The full 0.9.0 revision of the comparison table (decision 19). The Windows/Linux runner rows in ARCHITECTURE stay with the §6 runner work. No package CHANGELOG is touched, because no package changed.

README and ARCHITECTURE 8.4/15 still said dart run flutter3d_build:convert
had no texture encoder. It has BC1/BC3 (--textures bc), ETC2 RGB (etc2)
and a universal block file the load turns into BC, ASTC, ETC2 or RGBA8,
and the build hook picks BC or ETC2 from its target, so the demos' models
carry compressed textures on native builds. The passages now say that
and list what stays uncompressed: web builds, loose PNGs, ETC2 with
alpha, sizes that are not whole blocks. The limits paragraph also stops
calling UASTC and Zstandard/ZLIB refused, since both are read now.
The table had no row for the Flame bridge and its audio, flame_multiplayer
and its dashwire wire, flutter3d_lti, flutter3d_editor_play,
flutter3d_audio_core or the chemistry bench under packages/education, nor
for the arcade, river, showcase and incident apps. Each now has one, and
the build hook's row says that textures come out as BC or ETC2.
The page still named flutter3d 0.8.1 and 0.8.2. The core package is
0.8.3+1, the multiplayer row now names flame_multiplayer and its dashwire
wire, a new input row sets flutter3d_game's actions against Scene's
flutter_scene_input (in its repository since 2026-09-14, 0.1.0-dev, not on
pub.dev), and a Flame bridge row and bullet name flame_flutter3d 0.8.5,
River Sortie and the single-model component. The rest of the table waits
for the full revision with 0.9.0, and the page says so.
The encoder passages, the README package table and the comparison's
versions, multiplayer, input and bridge rows are done. The full 0.9.0
revision of the comparison and the Windows/Linux runner rows are left.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant