Skip to content

Commit 506e1ff

Browse files
committed
chore: Update README files and dependencies for version 0.0.2
This commit updates the version numbers for gameframework, gameframework_unity, and gameframework_unreal to 0.0.2 across various README files. It enhances the documentation by adding a project status and roadmap section, clarifying platform support, and detailing the current development status for Unity and Unreal integrations. Additionally, it introduces the gameframework_stream dependency for asset streaming support.
1 parent c4d2296 commit 506e1ff

4 files changed

Lines changed: 100 additions & 52 deletions

File tree

README.md

Lines changed: 34 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,10 @@ Add to your `pubspec.yaml`:
7777

7878
```yaml
7979
dependencies:
80-
gameframework: ^0.0.1
81-
gameframework_unity: ^0.0.1 # If using Unity
82-
# gameframework_unreal: ^0.0.1 # If using Unreal
80+
gameframework: ^0.0.2
81+
gameframework_unity: ^0.0.2 # If using Unity
82+
gameframework_stream: ^0.0.2 # If using asset streaming
83+
# gameframework_unreal: ^0.0.2 # If using Unreal (WIP)
8384
```
8485

8586
### Basic Usage
@@ -233,15 +234,36 @@ Engine Plugin (gameframework_unity/unreal)
233234
Game Engine (Unity/Unreal)
234235
```
235236

237+
## 📊 Project Status & Roadmap
238+
239+
**Current Version:** 0.0.2
240+
241+
### ✅ Production Ready
242+
- **Unity:** Android, iOS
243+
- **Core Framework:** All platforms
244+
245+
### 🚧 Work in Progress
246+
- **Unity:** Web, macOS, Windows, Linux
247+
- **Unreal:** Android, iOS
248+
249+
### 📋 Roadmap
250+
- Complete Unity desktop & web support
251+
- Complete Unreal Engine mobile integration
252+
- Unreal desktop & web support
253+
- Advanced streaming features
254+
- Performance optimization tools
255+
- v1.0 Production release
256+
236257
## Platform Support
237258

238259
| Platform | gameframework | Unity | Unreal | Status |
239260
|----------|--------------|-------|--------|--------|
240-
| Android |||| Stable |
241-
| iOS |||| Stable |
242-
| macOS |||| Beta |
243-
| Windows |||| Beta |
244-
| Linux |||| Beta |
261+
| Android | ✅ Ready | ✅ Ready | 🚧 WIP | Stable |
262+
| iOS | ✅ Ready | ✅ Ready | 🚧 WIP | Stable |
263+
| Web | ✅ Ready | 🚧 WIP | ⏳ Planned | Beta |
264+
| macOS | ✅ Ready | 🚧 WIP | ⏳ Planned | Beta |
265+
| Windows | ✅ Ready | 🚧 WIP | ⏳ Planned | Beta |
266+
| Linux | ✅ Ready | 🚧 WIP | ⏳ Planned | Beta |
245267

246268
## Continuous Integration
247269

@@ -302,9 +324,10 @@ Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for gui
302324

303325
All packages use semantic versioning (semver). Current versions:
304326

305-
- gameframework: 0.0.1
306-
- gameframework_unity: 0.0.1
307-
- gameframework_unreal: 0.0.1
327+
- gameframework: 0.0.2
328+
- gameframework_stream: 0.0.2
329+
- gameframework_unity: 0.0.2
330+
- gameframework_unreal: 0.0.2
308331

309332
## License
310333

engines/unity/dart/README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,27 @@ Unity Engine integration plugin for Game Framework. This plugin allows you to em
55
## Features
66

77
- ✅ Unity 2022.3.x support
8-
- ✅ Multi-platform: Android, iOS, Web, macOS, Windows, Linux
8+
-**Production Ready:** Android, iOS
9+
- 🚧 **Work in Progress:** Web, macOS, Windows, Linux
910
- ✅ Lifecycle management (pause, resume, destroy)
1011
- ✅ Bidirectional communication between Flutter and Unity
1112
- ✅ Scene load events
1213
- ✅ Error handling
13-
- WebGL support for Flutter Web
14+
- 🚧 WebGL support for Flutter Web (WIP)
1415
- ✅ AR Foundation support (ARCore/ARKit)
1516
- ✅ Performance monitoring
16-
- ✅ Desktop platform support (macOS, Windows, Linux)
17+
- 🚧 Desktop platform support (macOS, Windows, Linux) (WIP)
18+
19+
## Platform Support
20+
21+
| Platform | Status | Notes |
22+
|----------|--------|-------|
23+
| Android |**Production Ready** | API 21+, Stable |
24+
| iOS |**Production Ready** | iOS 12.0+, Stable |
25+
| Web | 🚧 **Work in Progress** | WebGL support coming soon |
26+
| macOS | 🚧 **Work in Progress** | Desktop support coming soon |
27+
| Windows | 🚧 **Work in Progress** | Desktop support coming soon |
28+
| Linux | 🚧 **Work in Progress** | Desktop support coming soon |
1729

1830
## Installation
1931

engines/unreal/dart/README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,23 @@ Integrate **Unreal Engine 5.x** into your Flutter applications with full bidirec
88

99
## Features
1010

11-
**Core Features:**
12-
- 🎮 Full Unreal Engine 5.x integration
11+
> **⚠️ Development Status:** Unreal Engine integration is currently under active development. Features and APIs may change.
12+
13+
**Core Features (WIP):**
14+
- 🎮 Unreal Engine 5.x integration
1315
- 🔄 Bidirectional communication (Flutter ↔ Unreal)
1416
- 🎯 Blueprint support for non-programmers
15-
- 📱 Multi-platform support (Android, iOS, macOS, Windows, Linux)
17+
- 📱 Multi-platform support focus: Android, iOS
1618
- ⚡ High-performance native bridges (JNI, Objective-C++)
1719

18-
🎨 **Unreal-Specific Features:**
20+
🎨 **Unreal-Specific Features (Planned):**
1921
- 🎚️ Quality settings with 5 presets (low, medium, high, epic, cinematic)
2022
- 🖥️ Console command execution (`stat fps`, `r.SetRes`, etc.)
2123
- 🗺️ Level/map loading and streaming
2224
- 📊 Quality level control (AA, shadows, textures, effects, etc.)
2325
- 🎬 Blueprint events for lifecycle and messaging
2426

25-
🚀 **Advanced Features:**
27+
🚀 **Advanced Features (Planned):**
2628
- 📦 Binary messaging with compression and chunked transfers
2729
- ⏱️ Message batching and throttling for performance optimization
2830
- 📊 Delta compression for efficient state synchronization
@@ -33,11 +35,13 @@ Integrate **Unreal Engine 5.x** into your Flutter applications with full bidirec
3335

3436
| Platform | Status | Requirements |
3537
|----------|--------|--------------|
36-
| Android | ✅ Production Ready | API 21+, NDK r25+ |
37-
| iOS | ✅ Production Ready | iOS 12.0+, Xcode 14+ |
38-
| macOS | ✅ Production Ready | macOS 10.14+, Xcode 14+ |
39-
| Windows | ✅ Ready | Windows 10+, Visual Studio 2022 |
40-
| Linux | ✅ Ready | Ubuntu 20.04+, GTK 3.0+ |
38+
| Android | 🚧 **Work in Progress** | API 21+, NDK r25+ |
39+
| iOS | 🚧 **Work in Progress** | iOS 12.0+, Xcode 14+ |
40+
| macOS |**Planned** | macOS 10.14+, Xcode 14+ |
41+
| Windows |**Planned** | Windows 10+, Visual Studio 2022 |
42+
| Linux |**Planned** | Ubuntu 20.04+, GTK 3.0+ |
43+
44+
**Note:** Unreal Engine integration is currently under active development. Android and iOS support are the primary focus.
4145

4246
## Quick Start
4347

@@ -47,8 +51,8 @@ Add to your `pubspec.yaml`:
4751

4852
```yaml
4953
dependencies:
50-
gameframework: ^0.5.0
51-
gameframework_unreal: ^0.5.0
54+
gameframework: ^0.0.2
55+
gameframework_unreal: ^0.0.2
5256
```
5357
5458
Install:

packages/gameframework/README.md

Lines changed: 35 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@ A unified, modular framework for embedding multiple game engines (Unity, Unreal
2929

3030
```yaml
3131
dependencies:
32-
gameframework: ^0.4.0
33-
gameframework_unity: ^0.4.0
32+
gameframework: ^0.0.2
33+
gameframework_unity: ^0.0.2
34+
gameframework_stream: ^0.0.2 # Optional: for asset streaming
3435
```
3536
3637
Or install from the command line:
@@ -83,8 +84,10 @@ class GameScreen extends StatelessWidget {
8384

8485
| Engine | Status | Platforms | Version |
8586
|--------|--------|-----------|---------|
86-
| **Unity** | ✅ Available | Android, iOS | 2022.3.x |
87-
| **Unreal Engine** | 🚧 Coming Soon | Android, iOS | 5.x |
87+
| **Unity** | ✅ Production (Android, iOS)<br>🚧 WIP (Web, Desktop) | Android, iOS, Web*, macOS*, Windows*, Linux* | 2022.3.x |
88+
| **Unreal Engine** | 🚧 WIP (Android, iOS) | Android*, iOS* | 5.x |
89+
90+
\* = Work in Progress
8891

8992
---
9093

@@ -241,28 +244,34 @@ The example demonstrates:
241244

242245
---
243246

244-
## 📊 Project Status
245-
246-
**Current Version:** 0.4.0
247-
**Overall Progress:** ~60% Complete (4 of 8 phases)
248-
249-
### Completed Phases
250-
-**Phase 1:** Core Framework (Dart)
251-
-**Phase 2:** Native Bridge (Android & iOS)
252-
-**Phase 3:** Unity Plugin (Full implementation)
253-
-**Phase 4:** Unity Production Features (Complete with testing)
254-
255-
### Quality Metrics
256-
- ✅ 39/39 tests passing
257-
- ✅ Static analysis clean (flutter analyze)
258-
- ✅ Type-safe API throughout
259-
- ✅ Comprehensive documentation (9,000+ lines)
260-
261-
### Upcoming
262-
- 📋 **Phase 5-6:** Unreal Engine Plugin
263-
- 📋 **Phase 7-8:** Polish & v1.0 Release
264-
265-
See [IMPLEMENTATION_STATUS.md](IMPLEMENTATION_STATUS.md) for details.
247+
## 📊 Project Status & Roadmap
248+
249+
**Current Version:** 0.0.2
250+
251+
### ✅ Production Ready
252+
- **Unity:** Android, iOS
253+
- **Core Framework:** All platforms
254+
- **Quality:** Type-safe API, comprehensive tests, clean static analysis
255+
256+
### 🚧 Work in Progress
257+
- **Unity:** Web, macOS, Windows, Linux
258+
- **Unreal:** Android, iOS
259+
260+
### 📋 Roadmap
261+
- **Near-term:**
262+
- Complete Unity desktop (macOS, Windows, Linux) support
263+
- Complete Unity Web/WebGL support
264+
- Complete Unreal Engine mobile (Android, iOS) integration
265+
266+
- **Mid-term:**
267+
- Unreal desktop & web support
268+
- Advanced asset streaming features
269+
- Performance optimization tools
270+
271+
- **Long-term:**
272+
- Additional game engine integrations
273+
- Cloud services integration
274+
- v1.0 Production release
266275

267276
---
268277

0 commit comments

Comments
 (0)