Skip to content

A simple remote entity & component inspector inside neovim using the telescope API

License

Notifications You must be signed in to change notification settings

Lommix/bevy_inspector.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 

Repository files navigation

bevy_inspector.nvim

A simple remote entity & component inspector inside Neovim using the telescope API with the new BRP-API introduced in bevy 0.15

prep_clean-inspect.mp4

Installation with lazy.nvim

return {
	"lommix/bevy_inspector.nvim",
	dependencies = {
		"nvim-telescope/telescope.nvim",
		"nvim-lua/plenary.nvim",
	},
	config = function()
		require("bevy_inspector").setup({
            -- optional custom url
	        -- url = "http://127.0.0.1:15702",
        })
	end,
	cmd = { "BevyInspect", "BevyInspectNamed", "BevyInspectQuery" },
	keys = {
		{  "<leader>bia", ":BevyInspect<Cr>", desc = "Lists all entities" },
		{  "<leader>bin", ":BevyInspectNamed<Cr>", desc = "List all named entities" },
		{  "<leader>biq", ":BevyInspectQuery<Cr>", desc = "Query a single component, continues to list all matching entities", },
	},
}

Control flow

Mostly boils down to this:

entitie list -> show entity components -> live preview component

In Bevy

Make sure you have bevy_remote feature enabled and added the necessary remote plugins.

app.add_plugins((
    RemotePlugin::default(),
    RemoteHttpPlugin::default(),
));