BevyCSharp 0.5.149

<div align="center">

Bevy C#

Write Bevy games in C#.

BevyCSharp.Editor, dotnet run --project BevyCSharp.Editor

</div>

Mark a struct [Behavior], give it methods with stage attributes, and a Roslyn source generator registers it with Bevy's schedule, as a component and a system at the same time. Bevy is the engine underneath, with its ECS, its scheduler, its timing, its input and its renderer.

using Bevy;

[Behavior]
public partial struct Spin
{
    [Range(0f, 5f)] public float Speed;
    private float _angle;

    // A static method is one plain system
    [OnStartup]
    public static void Scene(BehaviorContext ctx)
    {
        ctx.Ecs.Add(Render.SpawnCamera3d(), Transform.LookingAt(new Vec3(3f, 3f, 5f), Vec3.Zero, Vec3.UnitY));
        Render.SpawnLight(LightKind.Directional, 10_000f);

        var cube = ctx.Ecs.Spawn();
        ctx.Ecs.Add(cube, new Spin { Speed = 1.2f });
        Render.SetMesh(ctx.Ecs, cube, Render.CreateMesh(MeshShape.Cuboid, 1f, 1f, 1f));
        Render.SetMaterial(ctx.Ecs, cube, Render.CreateMaterial(0.25f, 0.55f, 0.85f));
    }

    // An instance method runs once per entity that has one, handed the entity's transform
    [OnUpdate]
    public void Tick(BehaviorContext ctx, ref Transform transform)
    {
        _angle += Speed * ctx.Time.Delta;
        transform.Rotation = Quat.FromAxisAngle(Vec3.UnitY, _angle);
    }
}

In Program.cs

using Bevy;

BevyApp.Run();

Behaviors are discovered automatically, so a consuming project needs no registration code.

This is Bevy, run unchanged underneath, so what a game draws and how its systems are scheduled are Bevy's. What it adds is C#, behaviors reloaded while the game runs, an editor, scene files and saves, physics, and a package with no Rust in it. What it costs is a call across to the bridge each time C# reaches Bevy, and only what the bridge has opened, which reaches two thirds of the Bevy examples about a game rather than Rust. Compared with Bevy has each, with what was measured.

Contents

• Examples
• Install
• Guide
• Controlling a running app
• Status and limitations
• Building from source
• Contributing
• License

Examples

Bevy's own examples are written in C# under Bevy's names in BevyCSharp.Examples, each opened by name and captured beside Bevy's picture of it, and EXAMPLES.md has a row for every one of Bevy's, saying whether it is written, can be, or waits on something the bridge lacks. A picture opens the C# program that drew it. A group's heading counts the examples of Bevy's group written here, and one that prints rather than draws is in EXAMPLES.md rather than in the row.

Of Bevy's 438 examples, 373 are written in C# here and 0 more in part, 0 more can be with what is bridged, 3 wait on something the bridge lacks, 2 are declined and 60 are about Rust itself (EXAMPLES.md).

2D Rendering, 28 of 29

bloom_2d	rotate_to_cursor	2d_shapes	2d_viewport_to_world	wireframe_2d	mesh2d_arcs	cpu_draw	dynamic_mip_generation	rotation	mesh2d	mesh2d_vertex_color_texture	mesh2d_alpha_mode	mesh2d_repeated_texture	move_sprite	multi_window_text	pixel_grid_snap	sprite	sprite_animation	sprite_flipping	sprite_scale	sprite_sheet	sprite_slice	sprite_tile	text2d	texture_atlas	tilemap_chunk	tilemap_chunk_orientation	transparency_2d

3D Rendering, all 68

bloom_3d	3d_scene	3d_shapes	3d_viewport_to_world	animated_material	anisotropy	anti_aliasing	atmosphere	atmospheric_fog	auto_exposure	blend_modes	post_processing	camera_sub_view	clearcoat	clustered_decal_maps	clustered_decals	color_grading	contact_shadows	decal	deferred_rendering	depth_of_field	fog	fog_volumes	generate_custom_mesh	irradiance_volumes	light_probe_blending	light_textures	lighting	lightmaps	lines	mesh_ray_cast	meshlet	mirror	mixed_lighting	motion_blur	occlusion_culling	order_independent_transparency	orthographic	parallax_mapping	pccm	parenting	pcss	pbr	rect_light	reflection_probes	render_to_texture	rotate_environment_map	ssao	ssr	scrolling_fog	shadow_biases	shadow_caster_receiver	skybox	solari	specular_tint	spherical_area_lights	split_screen	spotlight	texture	tonemapping	transmission	transparency_3d	two_passes	vertex_colors	visibility_range	volumetric_fog	wireframe	solari_reflections

Animation, all 13

animated_mesh	animated_mesh_control	animated_mesh_events	animated_transform	animated_ui	animation_events	animation_graph	animation_masks	color_animation	custom_skinned_mesh	eased_motion	easing_functions	morph_targets

Application, 12 of 19

drag_and_drop	empty_defaults	headless_renderer	logs	render_recovery	persisting_window_settings	settings

Assets, 11 of 18

alter_mesh	alter_sprite	asset_loading	asset_settings	embedded_asset	extra_asset_source	generated_assets	hot_asset_reloading	multi_asset_sync	repeated_texture

Async Tasks, all 3

async_channel_pattern	async_compute	external_source_external_thread

Audio, all 8

audio	audio_control	decodable	pitch	play_sound_effect	soundtrack	spatial_audio_2d	spatial_audio_3d

Camera, all 12

2d_on_ui	2d_top_down_camera	camera_orbit	custom_projection	first_person_view_model	free_camera_controller	pan_orbit_camera_minimal	pan_orbit_camera_ortho	pan_camera_controller	pan_orbit_camera_cad	projection_zoom	2d_screen_shake

Dev tools, 2 of 3

fps_overlay	infinite_grid

Diagnostics, all 3

log_diagnostics

ECS (Entity Component System), 26 of 35

delayed_commands	entity_disabling	error_handling	hierarchy	hotpatching_systems	iter_combinations	observers	one_shot_systems	parallel_query	removal_detection	state_scoped

Games, all 7

alien_cake_addict	breakout	contributors	desk_toy	game_menu	loading_screen	mines

Gizmos, all 9

2d_gizmos	3d_gizmos	anchored_text_gizmos	axes	light_gizmos	2d_text_gizmos	3d_text_gizmos	text_gizmos_font	transform_gizmo

Input, all 12

mouse_grab

Math, 5 of 6

bounding_2d	cubic_splines	random_sampling	render_primitives	smooth_follow

Movement, 1 of 1

physics_in_fixed_timestep

Picking, 6 of 7

dragdrop_picking	draggable_slider	mesh_picking	debug_picking	simple_picking	sprite_picking

Scene, 1 of 2

world_serialization

Shaders, 24 of 27

animate_shader	array_texture	compute_shader_game_of_life	compute_mesh	custom_vertex_attribute	extended_material_bindless	extended_material	gpu_component_array_buffer	gpu_readback	automatic_instancing	custom_shader_instancing	shader_material	shader_material_2d	shader_material_2d_bindless	shader_material_bindless	shader_material_screenspace_texture	shader_prepass	pipeline_constants	custom_post_processing	render_depth_to_texture	shader_defs	sprite_material	storage_buffer	texture_binding_array

Shaders Advanced, 3 of 4

deferred_raymarch	fullscreen_material	mesh_shader_intro

State, all 4

computed_states	custom_transitions	states	sub_states

Stress Tests, 19 of 20

bevymark	bevymark_3d	many_materials	many_animated_sprites	many_buttons	many_cameras_lights	many_cubes	many_foxes	many_gizmos	many_glyphs	many_gradients	many_lights	many_meshlet_materials	many_morph_targets	many_sprites	many_text	many_text2d	text_pipeline	transform_hierarchy

Time, 2 of 3

virtual_time

Tools, all 2

gamepad_viewer	scene_viewer

Transforms, all 5

3d_rotation	align	scale	transform	translation

UI (User Interface), 62 of 65

anchor_layout	borders	box_shadow	button	grid	directional_navigation	directional_navigation_overrides	display_and_visibility	drag_to_scroll	editable_text_filter	feathers_counter	feathers_number_input	feathers_gallery	fixed_node	flex_layout	font_atlas_debug	font_query	font_variations	font_weights	ghost_nodes	gradients	headless_tabs	image_node	image_node_resizing	inline_image	letter_spacing	multiline_text_input	multiple_text_inputs	overflow	overflow_clip_margin	overflow_transform	overflow_debug	relative_cursor_position	render_ui_to_texture	scroll	scrollbars	size_constraints	stacked_gradients	standard_widgets	standard_widgets_observers	strikethrough_and_underline	tab_navigation	text	text_background_colors	text_debug	text_input	text_wrap_debug	transparency_ui	ui_drag_and_drop	ui_material	ui_scaling	ui_target_camera	ui_texture_atlas	ui_texture_atlas_slice	ui_texture_slice	ui_texture_slice_flip_and_tile	ui_transform	z_index	vertical_slider	viewport_node	virtual_keyboard	window_fallthrough

Usage, all 4

character_creation	context_menu	cooldown	debug_frustum_culling

Window, all 11

clear_color	custom_cursor_image	low_power	monitor_info	multiple_windows	scale_factor_override	screenshot	transparent_window	window_drag_move	window_resizing	window_settings

glTF, 6 of 9

edit_material_on_gltf	load_gltf	load_gltf_extras	query_gltf_primitives	update_gltf_scene	gltf_skinned_mesh

Kept out of Bevy's list, 4 of 14

minimizing	resizing	test_meshlet

dotnet run --project BevyCSharp.Examples -- 3d_scene
./bcs open --example lighting --offscreen     # serving, for ./bcs to control and capture

Install

dotnet new install BevyCSharp.Templates
dotnet new bevycsharp -o MyGame && cd MyGame
dotnet run

The template makes the program above, Spin.cs and Program.cs, in a project asking for the package of the template's own version, and dotnet run opens its window. The package carries the managed library, the source generator and a prebuilt bridge per platform, and any other project takes it with dotnet add package BevyCSharp.

On Linux the bridge's audio links ALSA, so the bridge needs ALSA's library to load, libasound2 (libasound2t64 on Ubuntu 24.04 and Debian 13) or alsa-lib on Fedora and Arch, which a desktop has and a container usually does not, and drawing needs a Vulkan driver. Where there is no display, as in a container or on a build server, BCS_OFFSCREEN=1 draws into an image instead of a window and BCS_FRAMES ends the run after that many frames. Mesa's software Vulkan (mesa-vulkan-drivers) draws where there is no graphics card:

BCS_OFFSCREEN=1 BCS_FRAMES=120 dotnet run

The pack run follows these steps in a container holding the .NET SDK and the two packages alone.

Guide

The guide in docs/ is for somebody using the engine, a page an area. Everything in it is Bevy's own, bridged rather than reimplemented, so a Transform written from C# is the transform the renderer reads and a sound played from C# is an entity in the same world.

Controlling a running app

./bcs controls a running app from a terminal, the editor, a game or an example, answering in JSON, which is how a change is checked without a person at the window:

./bcs open --editor --offscreen        # start one, detached, with no display needed
./bcs command entity.set Cube Transform.Translation 0,2.5,0
./bcs command input.hold W,D 12        # keys held for twelve frames, inside the app
./bcs shot after.png                   # the next frame, as a PNG
./bcs stop

A game adds commands of its own with [Command] on a static method, and the tools page has the rest.

Status and limitations

Early. The behavior system, the ECS bridge and the schedule work and are covered by tests that run against a real Bevy app. Bevy's own examples are the measure of how much of it is reached, and how many of them are written stands under Examples.

Known gaps:

• A locally built package contains only the platform you built it on. Use the pack workflow, or run build-native.sh on each target platform, to produce a package covering all of them.
• A render build draws. Mesh primitives, textured physically based materials, cameras, lights, sprites, gizmos, UI nodes and text are reachable from a behavior script, verified on Vulkan. glTF files and .scn scenes load and spawn, audio plays, and a camera tonemaps, blooms, multisamples, antialiases, scatters a sky over what it draws, pulls focus and finds its own exposure. What is thin is the layer above that. A model's clips play one at a time, sprites step through no frames of their own, and a compressed texture a desktop GPU cannot decode is not transcoded. .github/TODO.md lists what each gap needs.
• The library compiles no C# at runtime, so a game carries no compiler. Behavior scripts loaded while an app runs go through BevyCSharp.Scripting, which the editor and the player reference and a game references only if it loads scripts itself, over App.EnableDynamicSystems and App.RemoveSystemsBySource.
• The editor's document is a scene file, with the hierarchy, entity references and Bevy's own components kept, and primitives and materials made in memory written as how to make them again. A mesh built vertex by vertex is written as its geometry, and a material can be kept in a *.material.json of its own. .github/SCENES.md has what is left.
• Five of Bevy's components are mirrored by hand, and the rest are reached through Bevy's reflection, by type path and JSON or through generated typed wrappers, at the cost of a serialization a call. A component holds a list, inline or in a managed store, and a dictionary in the same store, and shared values live in data assets of their own. .github/COMPONENTS.md plans generated mirrors.
• Component filters must be table-stored components, which is everything C# registers. A filter naming a Bevy-side sparse-set component is rejected rather than silently wrong.
• A cubemap comes from a file, as six square faces in a column, a row or a cross, or from a reflection probe that captures itself. One a game renders into with its own cameras, a layer at a time, has no bridge.
• Slang shaders compile with slangc, which the build fetches. A machine without it draws what was compiled and cached on one that had it, and cannot compile an edit.
• The renderer is open at fewer points than virtualized geometry, texture streaming, screen-space and world-space GI or reflections need. .github/RENDERING.md lists what each of those asks of an engine, what is here, what is missing, and the order it is built in.

Building from source

Using the package needs none of this, since it ships a prebuilt bridge for every supported platform. This is for working on the bridge itself.

build/build-native.sh          # the headless bridge
dotnet build                   # what copies it beside each project's binaries
dotnet test BevyCSharp.Tests/BevyCSharp.Tests.csproj

The two halves are built separately, and a rebuilt bridge is invisible until a managed build copies it, which is why the second line is not optional. build/build-native.sh --render adds the renderer and --editor adds the interface on top of it.

.github/BUILDING.md has the rest, the three native profiles and what each costs, the platforms and their prerequisites, how the package is assembled for six runtime identifiers, and how a release is published.

Contributing

Prose in this repository follows .github/STYLE.md, which uses no em dashes, no spaced hyphens as punctuation, no colon inside a running sentence, no padded section banners, and comments that explain why rather than restate the code.

License

Mozilla Public License 2.0. The full text is in LICENSE, and it ships inside the package. So does THIRD-PARTY-NOTICES.md, which names the work of others the package carries, Bevy and every crate the bridge is built from among it, each with its license and the notices its own files give, for a game shipped on the package to carry in turn.

MPL-2.0 is file-level copyleft, meaning changes to files that are part of this project have to stay under it and be made available in source form, while anything you build around it, including a game that references the package, is yours under whatever terms you like. Bevy itself is MIT and Apache-2.0, which this can incorporate freely.