Cargo Features

[dependencies]
breakwater = { version = "0.17.0", default-features = false, features = ["alpha", "binary-set-pixel", "binary-sync-pixels", "egui", "native-display", "vnc"] }
default = egui, vnc

We don't enable binary-sync-pixels and binary-set-pixel by default to make it a bit harder for clients ;)

alpha

Enables alpha of breakwater-parser

binary-set-pixel

Enables binary-set-pixel of breakwater-parser

binary-sync-pixels

Enables binary-sync-pixels of breakwater-parser

egui default

Enables breakwater-egui-overlay, bytemuck, eframe, egui, and libloading

Affects cli_args::CliArgs.viewport, cli_args::CliArgs.advertised_endpoints, cli_args::CliArgs.ui, sinks::egui, cli_args::CliArgs.native_display

native-display

Enables softbuffer and winit

Affects sinks::native_display, cli_args::CliArgs.native_display

vnc default

Enables vncserver

Affects cli_args::CliArgs.vnc, cli_args::CliArgs.vnc_port, sinks::vnc