Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Lukas Klingsbo <[email protected]>
  • Loading branch information
erickzanardo and spydon authored Oct 23, 2024
1 parent d57f956 commit be7b157
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 18 deletions.
18 changes: 9 additions & 9 deletions doc/bridge_packages/flame_console/flame_console.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
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 your `GameWidget` which when activated will show a
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, or perform actions.
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.

Expand All @@ -14,7 +14,7 @@ It comes with a set of built-in commands, but it is also possible to add custom

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 example of a floating action button that will
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
Expand Down Expand Up @@ -46,12 +46,12 @@ Widget build(BuildContext context) {

## 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
- `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
Expand Down
3 changes: 1 addition & 2 deletions packages/flame_console/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Flame Console 💻


Terminal overlay for Flame games which allows developers to debug and interact with their games.
Terminal overlay for Flame games which allows developers to debug and interact with their running games.

Check out the documentation
[here](https://docs.flame-engine.org/latest/bridge_packages/flame_console/flame_console.html) for
Expand Down
2 changes: 1 addition & 1 deletion packages/flame_console/example/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# example
# flame_console example

Example of using the flame console package
5 changes: 2 additions & 3 deletions packages/flame_console/example/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: example
name: flame_console_example
description: "Example of using the flame console package"

publish_to: 'none'
Expand All @@ -10,8 +10,7 @@ environment:

dependencies:
flame: ^1.19.0
flame_console:
path: ../
flame_console: ^0.1.0
flutter:
sdk: flutter

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/// A repository to persist and read history of commands
/// A repository to persist and read history of commands.
abstract class ConsoleRepository {
const ConsoleRepository();

Expand Down
4 changes: 2 additions & 2 deletions packages/flame_console/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: flame_console
description: "An extensible and customizable console to help debug a Flame game"
version: 0.0.1
description: "An extensible and customizable console to help debug Flame games."
version: 0.1.0
homepage:

environment:
Expand Down

0 comments on commit be7b157

Please sign in to comment.