Check out our latest project ✨ OpenChapter.io: free ebooks the way its meant to be 📖

Ruake In-Game Console with Scene Tree + In Editor REPL

An asset by j9794
The page banner background of a mountain and forest
Ruake In-Game Console with Scene Tree + In Editor REPL thumbnail image
Ruake In-Game Console with Scene Tree + In Editor REPL thumbnail image
Ruake In-Game Console with Scene Tree + In Editor REPL hero image

Quick Information

0 ratings
Ruake In-Game Console with Scene Tree + In Editor REPL icon image
j9794
Ruake In-Game Console with Scene Tree + In Editor REPL

This console can be opened while the game is running. It lets you evaluate code and even choose which node from the scene tree should be "self" when you are running it.It also includes a REPL that can be used in the editor.

Supported Engine Version
4.1
Version String
0.2.0
License Version
MIT
Support Level
community
Modified Date
2 months ago
Git URL
Issue URL

Ruake

This addon includes: - a terminal that runs godot expressions using nodes from the running scene as context. - a REPL that's available in the editor.

This can be used to debug while the game is running: README A spaceship game is running and a panel similar to quake's console is opened. The panel has a console in which code can be evaluated, and also has a section with a scene tree. Items from the scene tree can be clicked and that makes the code evaluated in the console be interpreted as being evaluated in the context of that node.

And to try out stuff in the editor!: README image

How to install

Download the project and copy the addon folder into your godot project.

Go to Project Settings > Plugins, and enable Ruake.

By default, this configures an action called toggle_ruake that opens the Ruake terminal by pressing CTRL+1.

The input can be modified in the Input Map, and if you want to use a different action name, you can configure it in ProjectSettings > Addons > Ruake.

README image

How to use

Ruake (in game)

Input the action that is configured to open ruake (toggle_ruake -> CTRL+1 by default) and the terminal will open!

The same action closes it.

You can select a node from the SceneTree and the code will run using that node as self in the context of the expression.

Repl (in editor)

After enabling Ruake, you will have a new tab in the bottom dock! README image

You can run expressions there and evaluate them with Enter. You can scroll to previous expressions you evaluated with up and down.

Also, all the expressions are ran in the context of the selected node. So, if you choose a different node on the SceneTree, you can run code in the context of that node. That means, self will be that node for all the code ran.

Finally, you can use the eyedropper to evaluate code on any node of the editor itself. This can be used to make it easier to create plugins that modify the editor. ⚠️ But be careful!, messing with the nodes of the editor might crash it or force you to reload the project to get the editor back to its initial state.

This console can be opened while the game is running. It lets you evaluate code and even choose which node from the scene tree should be "self" when you are running it.
It also includes a REPL that can be used in the editor.

Reviews

0 ratings

Your Rating

Headline must be at least 3 characters but not more than 50
Review must be at least 5 characters but not more than 500
Please sign in to add a review

Quick Information

0 ratings
Ruake In-Game Console with Scene Tree + In Editor REPL icon image
j9794
Ruake In-Game Console with Scene Tree + In Editor REPL

This console can be opened while the game is running. It lets you evaluate code and even choose which node from the scene tree should be "self" when you are running it.It also includes a REPL that can be used in the editor.

Supported Engine Version
4.1
Version String
0.2.0
License Version
MIT
Support Level
community
Modified Date
2 months ago
Git URL
Issue URL

Open Source

Released under the AGPLv3 license

Plug and Play

Browse assets directly from Godot

Community Driven

Created by developers for developers