ark2000/pankuconsole

Feature-packed real-time debugging toolkit for Godot Engine.

---

Panku Console is a feature-packed real-time debugging toolkit for Godot Engine. With Panku Console, you can easily interact with your scripts and objects at runtime, whether to cheat, debug, prototype, or just to have fun 😄🎮.

Panku Console is designed to be modular and extensible, and it is easy to add and maintain features. It is also designed to be as unobtrusive as possible, so you can use it in your project without worrying about the impact on the final product 🧩🚀.

✨ Highlights

📦 Tiny Footprint - Less than 256KB!

Panku Console is and will always be as lite as possible.

🖼️ Multi-window UI - Arrange your layout however you want!

Any windows can be scaled, snapped, collapsed, dragged and even become an independent OS window.

💻🔮 Developer Console - Execute Arbitrary Code at runtime with hints!

Allows you to execute arbitrary expressions (such as function calls) at runtime like if you were god 🧙‍♂️.

📝🕹️ Native Logger - Display native logs just in your game!

View native logs (the same as the editor output panel) in an overlay or a separate window 📋.

🛠️🔧 Data Controller - Turn Any Object into a Tweakable Property Panel!

Automatically convert all export properties in your script into an inspector window.

👀🎮 Expression Monitor

Watch the results of expressions at runtime just in your game.

And More... 🌟

• History Manager: view history inputs. ⏪
• Keyboard Shortcut: bind expressions to keys for quick cheating. ⌨️🕹️
• Screen Notifier: display popup messages on the screen. 💬📢
• Texture Viewer: view textures in real time. 🖼️👁️
• Misc Commands: provide some useful commands. 🛠️🔧
• General Settings: customize the console to your liking. ⚙️🔧
• FAQ: frequently asked questions. 🙋‍♂️🙋‍♀️

Since Panku Console is modular, you can easily remove or add features to suit your needs. 🧩🔧

Installation 🚀

A. Downloading GitHub master branch directly

1. Download Latest commit from Github 📥.

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

3. Enable this addon within the Godot settings ⚙️: Project > Project Settings > Plugins

B. Using mirror repo as git submodule

Or if you prefer to use git(recommended), you can add this mirror repo as a submodule in your addons folder which will automatically update the addon when you pull the latest changes 🔄.

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

C. Downloading from Godot Asset Library

Which is the same as downloading godot4_asset_library branch (always points to latest stable release version and only contains addons folder)

---

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

Note: Panku Console currently only supports Godot version 4.x, 3.x support is still in progress.

Contribute 🤝

Do you want to contribute? Learn more in the contribution section. 🌟🙌

Also, see Project Roadmap for more information about the development plan.

License 📜

MIT License

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

pankuconsole's Issues

No need for a Panku.gd and Panku_impl.gd, currently Panku.gd does not contain any implementation

I suggest that it contains only a file called panku.gd with the implementation that is in the panku_impl.gd file

The console window should be able to be an independant OS window.

Multi windows is a notable new feature of Godot 4 that we can utilize.

Just like this: https://www.youtube.com/watch?v=iKoYbtw4gC0&t=249s

If we have multiple screens, the console window then will not occupy the precious space of the game screen.

Support export properties of Vector2

With a similar button like float export that you can drag around to change vector2 value.

The version in console should automatically be updated.

Every time when you commit, the version information should automatically be updated, just like this:

Add the Ability to Check Latest Release

Better notification UI

Add menu bar

Cyclic dependency with DefaultEnv inside console.tscn

Lack of docs to explain features.

1. The code should be self-documented. It's a mess now.
2. The runtime console itself should add more intuitive ways to help the user learn it more quickly.
3. Consider building a project page.
4. New project icon.

Export properties start with an underscore should be ignored by export window.

export panel properties are not aligned, ugly.

Need to not be focused on input to close console removes a lot of accessibility

Need to not be focused on input to close console removes a lot of accessibility, testing many consoles in games, almost all have an easy switch between on/off state.

System redesign

Add a minimal mode for REPL

like this below, only input box and hints are showed in the center.
This is great for its simplicity.
And you can switch between full/minimal mode very easily.

Add signals for open/close console

Improve the save ability

Currently some settings such as window transparency can not be remembered, this is a problem.

And if the program crashes, you will lost all layout saves.

More details will be described later.

Add smooth scroll for the console.

Can not navigate histories in mini repl mode.

Version: 7f8d82c

The histories and autocomplele is confict in repl mode. You should only use tab for autocompletion while only use arrows for histories.

Follow godot best practices

https://docs.godotengine.org/en/stable/tutorials/best_practices/index.html

• Case sensitivity
• Ignoring specific folders

use svg icons instead of png

Add static syntax checking for expressions

Open console key is written in input when opening console, this can be played when not using '~' key to open console

Add the ability to bind expressions with input actions

There will be a manager window to manager the key bindings.

Using engine default font instead of external

To minimize the package size

Add unit test workflow

By utilizing this great project: https://github.com/bitwes/Gut

A good reference: https://github.com/bitbrain/beehave/blob/godot-4.x/.github/workflows/unit-tests.yml

Add live demo

The demo should look like this: https://github.com/pkdawson/imgui-godot
Live demo: https://greggman.github.io/doodles/glfw-imgui/out/glfw-imgui.html

Add widgets manager window

Add categories in export panel.

The final work should look like this in general.

@export_category("My Properties")
@export var number = 3
@export var string = ""

This will be supported.

[Suggestion] Rename Panku file to Console

It would be more intuitive to read the code:
Console.notify("example")

Editor reports error when toolbar submenu is clicked

E 0:00:04:0572   window_get_popup_safe_rect: Condition "!windows.has(p_window)" is true. Returning: Rect2i()
  <C++ Source>   platform/windows/display_server_windows.cpp:2215 @ window_get_popup_safe_rect()

Widgets system

I came up with this idea from the conversation with @scriptsengineer : #1

You can create floating widgets very quickly inside the console or in your code, they are capable of:

1. being closed with a close icon.
2. being dragged around and snap to the screen edge just like the console window.
3. being clicked and then execute an expression.
4. being update by an expression at a constant frequency.

There will be something maybe a manager window to manage multiple widgets plans and autoload widgets, more details will be explained later.

This feature will be of great help Imo since you can monitor expressions and call expressions conveniently.

More details

The whole system can be fully accessed inside the console.
More specifically, I added several functions in default_env.gd, explained below:

#Add a widget to watch an expression
w_watch(env:String, exp:String)
#Add an expression widget button
w_button(text:String, env:String, exp:String)
#Add a widget to monitor performance
w_perf
# Show all widgets plans
w_plans
#Save current widgets as a new plan
w_save_as(plan:String)
#Clear current widgets and load a plan
w_load(plan:String)
#Delete a widgets plan (Except for current plan)
w_delete(plan:String)

• When you add or remove a widget by clicking the close button right in the widget, the plan will be automatically saved.
• When quitting the current plan is memorized and will be loaded next time.

Support embedded multi-window.

Quick screen space shader tools

Add command system just like Minecraft BE.

like this:

Autocompletion when inputting an expression.

This is an extremely import feature in most consoles.

Mini REPL should show all available hints when input is empty.

like this:

Add conversion method call 'method()' to '/method'

We need the ability to run a sequence of expressions.

Currently the so called PankuConsole is just REPL, we haven't reached its full potential yet.

There should be something we can run a sequence of expressions with basic flow controls.

Or even further, a runtime gdscript code interpreter to make it more powerful. (This is a pretty tough task, but maybe we can learn something from this project)

Add logger system

The logger window is not the same thing as REPL window.
It will support infinite logs and labels with powerful filter.

Add more built-in functions in default_env.gd

For examples,
show_fps() will allow to add a label on the top left screen displaying current frame rate.
fullscreen() will allow to make the game fullscreen

These simple functions would be very convenient.

Add buttons in export panel.

We can use a special constant to mark an export property that has get method.

Identify assignment expressions

Input like this player.hp = 100.0 will be translated to player.set("hp", 100.0)

Input expressions will be translated like this:

• player.hp = 100.0 -> player.set("hp", 100.0)
• allow_jump = false -> set("allow_jump", false)
• hello = "hello = 123" -> set("hello", "hello = 123")
• "hello = 123" -> "hello = 123" (This is not an assignment, so nothing happens)

The rule is simple, if we find an equal sign in the input expression and no quotation marks before the equal sign, we then split the input into two parts by the equal sign and apply the translation rules.

Hopefully the heuristic rule or RegEx is enough since I don't want to code an assignment parser for this.

Use lynx window to contain widgets

The so called `environment` concept is redundant.

For example, instead this:

We can input expressions like that below:

With the power of auto-complete, this should be more intuitive and quicker.

What's more, the current predefined expressions in default_env.gd is tedious:

We can split these functions into several parts instead all huddled together.

Add more intuitive ways to create widgets

Export option to turn off drag for console

Update docs to V1.2

A short introduction youtube video would be made maybe?

C# wrapper support

Use ProjectSettings to store data and configurations.

Add export panel in run-time