Skip to content

Commit 5410544

Browse files
authored
chore: Remove deprecated flame_oxygen package (#3947)
Removes the deprecated `flame_oxygen` bridge package and its traces from the repository: - Deletes `packages/flame_oxygen` (including its example app) and removes both of its workspace entries from the root `pubspec.yaml`. - Deletes the `flame_oxygen` bridge package docs page and its entries in `doc/bridge_packages/bridge_packages.md`, plus the `flame_oxygen` bullet and links in the root `README.md`. - Replaces the Oxygen docs (`doc/other_modules/oxygen`) with a single page stating that Oxygen and `flame_oxygen` are deprecated, no longer maintained, and not recommended, and that the Flame Component System is as efficient in almost all cases. - Removes the `OxygenGame` node from the low-level game API diagram. The historical `flame_oxygen` entries in the root `CHANGELOG.md` are left untouched, since that file records the release history. Already published versions of `flame_oxygen` remain available on pub.dev. ## Testing instructions - Run `flutter pub get` in the repo root and verify that the workspace still resolves. - Run `grep -ri oxygen . --exclude-dir=.git --exclude=CHANGELOG.md` and verify that the only remaining references are the deprecation notice in `doc/other_modules`. - Build the docs and verify that the "Other Modules" section renders the Oxygen deprecation page and that the bridge packages page no longer lists `flame_oxygen`.
1 parent 2061a4f commit 5410544

45 files changed

Lines changed: 11 additions & 1487 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/.cspell/flame_dictionary.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ Bodymovin # An After Effects extension to export Lottie animations https://aescr
77
Dashbook # UI development tool for Flutter https://github.com/bluefireteam/dashbook
88
emberquest # Ember Quest, our platformer tutorial game
99
Hermione # A character from the book Harry Potter
10-
Kawabunga # Word expressing exhilaration, of unclear origins but popularized by the show Teenage Mutant Ninja Turtles
1110
Kenobi # Eminent Jedi Master, General of the Republic Army, Obi-Wan Kenobi
1211
Nakama # An open-source server designed to power modern games and apps https://github.com/Allan-Nava/nakama-flutter
1312
Overmind # A character in the game StarCraft

.github/.cspell/words_dictionary.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ platformer
1414
positionable
1515
postmultiply
1616
preorder
17-
prerender
1817
prerendered
1918
pressable
2019
presubmit

README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,6 @@ a Flame game.
9595
- [flame_lottie][flame_lottie] - Support for [Lottie][lottie] animation in Flame.
9696
- [flame_network_assets][flame_network_assets] - Helpers to load game assets from
9797
network.
98-
- [flame_oxygen][flame_oxygen] for [Oxygen][oxygen]: A lightweight Entity Component System (ECS)
99-
framework.
10098
- [flame_rive][flame_rive] for [Rive][rive]: Create interactive animations.
10199
- [flame_svg][flame_svg] for [flutter_svg][flutter_svg]: Draw SVG files in Flutter.
102100
- [flame_texturepacker][flame_texturepacker]: Load and use sprite sheets generated with [TexturePacker][texturepacker]
@@ -191,8 +189,6 @@ via an issue, GitHub discussion, or reach out to the team either using the
191189
[flame_lottie]: https://github.com/flame-engine/flame/tree/main/packages/flame_lottie
192190
[lottie]: https://airbnb.design/lottie/
193191
[flame_network_assets]: https://github.com/flame-engine/flame/tree/main/packages/flame_network_assets
194-
[flame_oxygen]: https://github.com/flame-engine/flame/tree/main/packages/flame_oxygen
195-
[oxygen]: https://github.com/flame-engine/oxygen
196192
[flame_rive]: https://github.com/flame-engine/flame/tree/main/packages/flame_rive
197193
[rive]: https://rive.app/
198194
[flame_svg]: https://github.com/flame-engine/flame/tree/main/packages/flame_svg

doc/bridge_packages/bridge_packages.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,6 @@ Use Lottie animations in Flame (bridge package for [Lottie]).
5656
Fetch assets over the network.
5757
:::
5858

59-
:::{package} flame_oxygen
60-
61-
Replace FCS with the Oxygen Entity Component System.
62-
:::
63-
6459
:::{package} flame_rive
6560

6661
Create interactive animations (bridge package for [Rive]).
@@ -129,7 +124,6 @@ flame_gamepads <flame_gamepads/flame_gamepads.md>
129124
flame_isolate <flame_isolate/flame_isolate.md>
130125
flame_lottie <flame_lottie/flame_lottie.md>
131126
flame_network_assets <flame_network_assets/flame_network_assets.md>
132-
flame_oxygen <flame_oxygen/flame_oxygen.md>
133127
flame_rive <flame_rive/flame_rive.md>
134128
flame_riverpod <flame_riverpod/flame_riverpod.md>
135129
flame_splash_screen <flame_splash_screen/flame_splash_screen.md>

doc/bridge_packages/flame_oxygen/flame_oxygen.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

doc/flame/diagrams/low_level_game_api.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323
2424
%% Nodes %%
2525
26-
A(OxygenGame)
2726
B(Game):::yellow
2827
C(FlameGame)
2928
D(Component)
@@ -32,7 +31,6 @@
3231
3332
%% Flow %%
3433
35-
A-- Extends -->B
3634
F-- Wants -->B
3735
3836
C-- Extends -->D

doc/other_modules/other_modules.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,8 @@ and the dialogue runtime; use bridge package `flame_jenny` in order to add it in
88

99
:::{package} oxygen
1010

11-
Oxygen is a lightweight Entity Component System framework written in Dart, with a focus on
12-
performance and ease of use. This package replaces the Flame Component System with the Oxygen
13-
Entity Component System.
11+
Oxygen is deprecated and no longer maintained, and we do not recommend using it. The Flame
12+
Component System is as efficient in almost all cases.
1413
:::
1514

1615

doc/other_modules/oxygen/components.md

Lines changed: 0 additions & 223 deletions
This file was deleted.

0 commit comments

Comments
 (0)