-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Blue Fire
committed
Oct 24, 2024
1 parent
b1291dd
commit 0b13e87
Showing
9 changed files
with
573 additions
and
15 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
109 changes: 109 additions & 0 deletions
109
docs/main/_sources/bridge_packages/flame_console/flame_console.md.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
# flame_console | ||
|
||
Flame Console is a terminal overlay for Flame games which allows developers to debug and interact | ||
with their games. | ||
|
||
It offers an overlay that can be plugged in to your `GameWidget` which when activated will show a | ||
terminal-like interface written with Flutter widgets where commands can be executed to see | ||
information about the running game and components, or perform actions. | ||
|
||
It comes with a set of built-in commands, but it is also possible to add custom commands. | ||
|
||
|
||
## Usage | ||
|
||
Flame Console is an overlay, so to use it, you will need to register it in your game widget. | ||
|
||
Then, showing the overlay is up to you, below we see an example of a floating action button that will | ||
show the console when pressed. | ||
|
||
```dart | ||
@override | ||
Widget build(BuildContext context) { | ||
return Scaffold( | ||
body: GameWidget( | ||
game: _game, | ||
overlayBuilderMap: { | ||
'console': (BuildContext context, MyGame game) => ConsoleView( | ||
game: game, | ||
onClose: () { | ||
_game.overlays.remove('console'); | ||
}, | ||
), | ||
}, | ||
), | ||
floatingActionButton: FloatingActionButton( | ||
heroTag: 'console_button', | ||
onPressed: () { | ||
_game.overlays.add('console'); | ||
}, | ||
child: const Icon(Icons.developer_mode), | ||
), | ||
); | ||
} | ||
``` | ||
|
||
|
||
## Built-in commands | ||
|
||
- `help` - List available commands and their usage. | ||
- `ls` - List components. | ||
- `rm` - Remove components. | ||
- `debug` - Toggle debug mode on components. | ||
- `pause` - Pauses the game loop. | ||
- `resume` -Resumes the game loop. | ||
|
||
|
||
## Custom commands | ||
|
||
Custom commands can be created by extending the `ConsoleCommand` class and adding them to the | ||
the `customCommands` list in the `ConsoleView` widget. | ||
|
||
```dart | ||
class MyCustomCommand extends ConsoleCommand<MyGame> { | ||
MyCustomCommand(); | ||
|
||
@override | ||
String get name => 'my_command'; | ||
|
||
@override | ||
String get description => 'Description of my command'; | ||
|
||
// The execute method is supposed to return a tuple where the first | ||
// element is an error message in case of failure, and the second | ||
// element is the output of the command. | ||
@override | ||
(String?, String) execute(MyGame game, List<String> args) { | ||
// do something on the game | ||
return (null, 'Hello World'); | ||
} | ||
} | ||
``` | ||
|
||
Then when creating the `ConsoleView` widget, add the custom command to the `customCommands` list. | ||
|
||
```dart | ||
ConsoleView( | ||
game: game, | ||
onClose: () { | ||
_game.overlays.remove('console'); | ||
}, | ||
customCommands: [MyCustomCommand()], | ||
), | ||
``` | ||
|
||
|
||
## Customizing the console UI | ||
|
||
The console look and feel can also be customized. When creating the `ConsoleView` widget, there are | ||
a couple of properties that can be used to customize it: | ||
|
||
- `containerBuilder`: It is used to created the decorated container where the history and the | ||
command input is displayed. | ||
- `cursorBuilder`: It is used to create the cursor widget. | ||
- `historyBuilder`: It is used to create the scrolling element of the history, by default a simple | ||
`SingleChildScrollView` is used. | ||
- `cursorColor`: The color of the cursor. Can be used when just wanting to change the color | ||
of the cursor. | ||
- `textStyle`: The text style of the console. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.