goktug97 / bevy_modding_experiment

A simple approach to add modding to a Bevy game

Bevy Modding Experiment

This project demonstrates a simple approach to adding modding capabilities to a Bevy game, inspired by bevy_dynamic_plugin.

Limitations

• Both the main application and plugins must use the same Bevy version and dynamically link Bevy using the bevy/dynamic_linking feature.
• Components intended for use by plugins must reside in a separate dynamic library (dylib) crate and should not be subdirectory of the main application (?).
• No WASM
• Unsafe Code

Getting Started

To run the project, follow these steps:

git clone https://github.com/goktug97/bevy_modding_experiment
cd bevy_modding_experiment/plugin
cargo build --release
cd ../bevy_modding
cargo run --release

How It Works

• Main Application: The core application initializes a scene featuring a camera and a stationary circle. It dynamically loads the plugin shared library using libloading. Then it calls the setup function, passing a mutable reference to the App instance (&mut App). This function is a required implementation within the plugin.

• Plugin: The plugin is responsible for implementing the setup function. In this example, the plugin adds a system to move the circle.