Skip to content

Commit 7a4da60

Browse files
Update README.md
1 parent 7089dd7 commit 7a4da60

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
1-
# O2 Console
1+
# o2 InGame Console
22

3-
**O2 Console** is an in-game, attribute-driven debug console for Unity that allows developers to define and execute commands easily. Built using the **Reflection API**, it dynamically discovers scene objects and registers command methods at runtime, making it incredibly flexible. With its real-time command execution and robust exception handling, O2 Console provides a powerful way to interact with and debug your game, enhancing your development experience.
3+
**o2 Console** is an in-game, attribute-driven debug console for Unity that allows developers to define and execute commands easily. Built using the **Reflection API**, it dynamically discovers scene objects and registers command methods at runtime, making it incredibly flexible. With its real-time command execution and robust exception handling, O2 Console provides a powerful way to interact with and debug your game, enhancing your development experience.
44

55
---
66

77
## Features
88

99
- **Command Attribute System**: Mark methods as console commands using `[ConsoleCommand("Command Key")]`, and O2 Console automatically registers them.
10-
- **Reflection-Based Command Registration**: O2 Console scans and registers commands from methods, properties, and fields (both public and private) at runtime.
10+
- **Reflection-Based Command Registration**: O2 Console scans and registers commands from methods, properties, and fields (both public and private) during scene initialization.
11+
- **Supports Single Parameter Methods**: Currently, O2 Console supports methods with up to one parameter. Support for multiple parameters may be added in the future.
1112
- **Dynamic Command Execution**: Execute commands in-game directly through the console interface.
1213
- **Static and Instance Methods**: Supports executing both static and instance methods.
13-
- **Real-Time Object Discovery**: Automatically detects and interacts with scene objects during gameplay.
14-
- **Supports Parameter Passing**: Command methods can accept parameters, and the console automatically converts inputs to match method signatures.
15-
- **Exception Handling**: Automatically catches and logs exceptions from commands and the console, without crashing or pausing the game.
16-
- **Built-in Commands**: Includes commands like `/Clear` to clear console logs, with additional built-in functionality to interact with the game.
14+
- **Scene Discovery on Initialization**: O2 Console scans and interacts with objects present at scene load. For objects created during runtime, manual subscription to the console is required.
15+
- **Supports Parameter Passing**: Command methods can accept one parameter, and the console automatically converts the input to match the method signature.
16+
- **Exception Handling**: Automatically catches and logs exceptions from commands.
17+
- **Built-in Commands**: Includes commands like `/Clear` to clear console logs, with additional built-in functionality to interact with the game and the engine.
18+
1719

1820
---
1921
## Ready-to-use user interface

0 commit comments

Comments
 (0)