updated readme:

This commit is contained in:
dshukertjr committed 2023-02-14 17:25:05 +09:00
1 parent 886da31339
commit a2ae8a2cfc
1 file changed
+41 -9
@@ -1,16 +1,48 @@
# flame_realtime_shooting
# Flutter Real-time Multiplayer Shooting Game
A new Flutter project.
A real-time shooting game built with [Flutter](https://flutter.dev/), [Flame](https://flame-engine.org/) and [Supabase](https://supabase.com).
You can find a step by step guide on how to build this app on [How to build a real-time multiplayer game with Flutter Flame](https://supabase.com/blog/flutter-real-time-game) article.
## Getting Started
This project is a starting point for a Flutter application.
### 1. Create new project
A few resources to get you started if this is your first Flutter project:
Sign up to Supabase - [app.supabase.io](https://app.supabase.io) and create a new project. Wait for your database to start.
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
### 2. Get the URL and Key
For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
Go to the Project Settings (the cog icon), open the API tab, and find your API URL and `anon` key, you'll need these in the next step.
The `anon` key is your client-side API key. It allows "anonymous access" to your database, until the user has logged in. Once they have logged in, the keys will switch to the user's own login token.
![Supabase Anon Key](supabase_anon_key.jpg?raw=true 'Supabase Anon Key')
### 3. Pull this example git repository
`git clone <<this repository url>> `
### 4. Paste the Supabase URL and Anon Key
Copy and paste the Supabase URL and Anon key in `lib/main.dart` file
```dart
void main() async {
await Supabase.initialize(
url: 'supabaseUrl',
anonKey: 'supabaseAnonKey',
realtimeClientOptions: const RealtimeClientOptions(eventsPerSecond: 40),
);
runApp(const MyApp());
}
```
### 5. Run the Flutter App
Now run
```bash
flutter run
```
This app can run on any environment that runs Flutter.