loic-sharma / butter

.NET Bridge to Flutter

Butter

Local testing

1. Run the example app using the Butter tool:

   cp example
   dart run ../bin/butter.dart run -d butter
   

2. Build engine

3. Copy the locally built engine to the example/butter/Flutter/ephemeral directory:

   cp C:\Code\f\engine\src\out\host_debug_unopt\flutter_windows.dll C:\Code\butter\example\butter\Flutter\ephemeral
   

4. Run the example app once using the local engine:

   cd example
   flutter run -d windows --local-engine host_debug_unopt
   

5. Now run the example app using Butter:

   dotnet run --project butter/Runner
   

TODO:

1. Hot reload
2. Error on exit
3. Clean should remove obj/bin folders
4. Plugins
5. Messaging
6. C++ plugins
7. Pigeon
8. Create template
9. Figure out if template works if Butter supports multiple target platforms
   1. Maybe Butter.Windows should be Butter and Butter.Windows.Bindings should be Butter.Windows?
   2. Maybe instead of packages we shove source files in the ephemeral directory?

Useful resources

1. https://github.com/LiveOrNot/FlutterSharp/blob/8b24bdf14465c090b53ecc04c0c2c2598ae7aff3/FlutterSharp/Integrations/FlutterInterop.cs
2. https://github.com/microsoft/CsWin32/blob/abb1b3de5bc2298cf3919a8cf724e7d18ea916c7/test/WinRTInteropTest/Program.cs#L79
3. https://github.com/timsneath/win32_runner/blob/main/lib/src/window.dart
4. https://github.com/sony/flutter-elinux