Panku Console

All-in-One Godot Engine 4 runtime debugging tool.

✨ Features

In short, the core function of Panku Console is to dynamically execute some simple expressions while the game is running. Of course, it is much more than that, in fact, Panku Console is a collection of many practical tools. Here is a brief description of its features.

✅ Flexible Multi-window System. Any windows can be scaled, snapped, dragged and even become an independent os window.

✅ Out-of-the-box Developer Console. No need to define complex commands, enter any expression, execute it and get the result.

✅ Expression Monitoring. Create windows to see the results of expressions in real time.

✅ Quick Key Binding. Bind expressions to keys for quick cheating.

✅ Popup Notification. Pop up any message that deserves your attention.

✅ Powerful Inspector Generator. Automatically convert all export properties in your script into an inspector window.

✅ History Management. Manage all your input history, pin or merge history expressions.

✅ Logger System. Powered by the native file logging system, simple yet powerful.

🧪 Installation

1. Download Latest commit or the stable Release version.

2. Copy the addons folder to your project root directory.

3. Enable PankuConsole in the Godot project addon settings.

Or if you prefer to use git, you can add this mirror repo as a submodule in your addons folder.

# in your project root directory
cd addons
git submodule add https://github.com/Ark2000/panku_console

For more information about plugin installation, you can visit the corresponding Godot documentation.

Note: Panku Console only supports Godot version 4.x, and I personally do not plan to provide support for 3.x.

📚 Quick Start

Panku Console is designed to take advantage of Godot's native features as much as possible, to provide as little API as possible, to reduce the intrusiveness of the project, to allow most of the operations to be done at runtime without causing additional burden for the developer, and to use pure GDScript development to maximize applicability and maintenance efficiency.

Panku Console is a collection of many tools, and each tool has its own documentation, so I will not go into details here. If you want to know more about the plugin, you can read the following documents.

Content:

• Interactive Shell
• Built-in Commands
• Expression Monitor
• Expression Shortcut
• Generating Inspector Panel
• History Manager
• Logger
• FAQ

Note: if you want to include the plugin in your released game, you may need to make some modifications to avoid players directly accessing internal state.

Contributors

Thanks to these nice people who contributed to this project, you can also participate in ways including but not limited to:

1. if you find bugs or have any suggestions, you can submit Issues

2. if you have questions, you can discuss them in the Discussion

3. You can also Contribute Code directly to this project, please refer to Recent Commits for the specification of commit message or here

See CONTRIBUTING for more details.

License

MIT License

Copyright (c) 2022-present, Feo (k2kra) Wu