[](#contributors-)

Website | Code Examples | Discord | Web Demo

---

Safe, low-latency and fast sandbox for the Godot game engine.

---

This extension exists to allow Godot creators to implement safe modding support, such that they can pass around programs built by other players, knowing that these programs cannot harm other players. All Godot platforms are supported.

Installation

• Automatic (Recommended): Download the plugin from the official Godot Asset Store using the AssetLib tab in Godot by searching for Godot Sandbox.

• Manual: Download the latest github release and move only the addons folder into your project addons folder.

What can I do?

• You can implement a modding API for your game, to be used inside the sandbox. This API can then be used by other players to extend your game, in a safe manner. That is, they can send their mod to other people, including you, and they (and you) can assume that it is safe to try out the mod. The mod is not supposed to be able to do any harm. That is the whole point of this extension.
• You can implement support for your favorite language inside the sandbox. The sandbox receives Variants from Godot or GDScript, and can respond back with Variants. This means the communication is fully dynamic, and supports normal Godot usage.
• You can distribute programs from a server to clients on login. The programs will behave the same way on all platforms, including 32-bit platforms. You can use this to live-distribute changes, like bugfixes, to the game without having to redeploy the game itself.

Usage

• Write C++ or Rust in the Godot editor. An accompanying ELF resource is created.

• Create a new Sandbox and assign the ELF resource to it

  • Access to the underlying Sandbox
  • Lifetime as any other node
  • Auto-completion from other GDScripts using @export

• Or, directly assign an ELF script resource to a node

  • Shared sandbox among all instances with that script
  • Maximum scalability
  • Call functions and attach signals like GDScript

Examples

static void add_coin(const Node& player) {
	static int coins = 0;
	coins ++;
	Node coinlabel = player.get_parent().get_node("Texts/CoinLabel");
	coinlabel.set("text", "You have collected "
		+ std::to_string(coins) + ((coins == 1) ? " coin" : " coins"));
}

extern "C" Variant _on_body_entered(Node2D node) {
	if (node.get_name() != "Player")
		return Nil;

	get_node().queue_free(); // Remove the current coin!
	add_coin(node);
	return Nil;
}

Script of a simple Coin pickup, with a counter that updates a label in the tree of the player. This script can be attached to the Coin just like GDScript.

#[no_mangle]
pub fn _physics_process(delta: f64) -> Variant {
	if Engine::is_editor_hint() {
		return Variant::new_nil();
	}

	let slime = get_node();
	let sprite = get_node_from_path("AnimatedSprite2D");

	let flip_h = sprite.call("is_flipped_h", &[]);
	let direction: f32 = (flip_h.to_bool() as i32 as f32 - 0.5) * -2.0;

	let mut pos = slime.call("get_position", &[]).to_vec2();
	pos.x += direction * SPEED * delta as f32;

	slime.call("set_position", &[Variant::new_vec2(pos)]);

	let ray_right = get_node_from_path("raycast_right");
	let ray_left  = get_node_from_path("raycast_left");
	if direction > 0.0 && ray_right.call("is_colliding", &[]).to_bool() {
		sprite.call("set_flip_h", &[Variant::new_bool(true)]);
	}
	else if direction < 0.0 && ray_left.call("is_colliding", &[]).to_bool() {
		sprite.call("set_flip_h", &[Variant::new_bool(false)]);
	}

	Variant::new_nil()
}

The Rust API is still under development, but simple scripts are possible.

You may also have a look at our demo repository for the Godot Sandbox. It's a tiny platformer that uses C++ and Rust.

Contributing

Requirements:

• SCons
• python3

If you want to contribute to this repo, here are steps on how to build locally:

scons

Linting:

./scripts/clang-tidy.sh

Icons

The script icon is built from the Godot icons. It's using the same font as the Godot Logo, which is Lilita One. The icons are then imported into Godot once in order to check the box Scale With Editor in the import panel.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Alf-André Walla 💻

K. S. Ernest (iFire) Lee 💻 🔬 ⚠️

Dragos Daian 💻

This project follows the all-contributors specification. Contributions of any kind welcome!