Using Xray Agent

Documentation / Xray Agent

• Overview of Xray Agent
  • What It Does
  • What It Is Not
• Using Xray Agent
  • Under CySaver
  • Windowed On The Desk
  • Fullscreen Without CySaver
  • Embed And Prefs Preview
  • Swarm Behaviour
• Command Line
  • Window And Saver
  • Swarm
• Copyright

Using Xray Agent

Xray Agent is the xray-agent binary on the classic xswarm draw path. Pick it in CySaver, or run it from a shell to try swarm size and roam before you arm the saver.

Under CySaver

Customize > Screen Saver lists Xray Agent when xray-agent is installed. Hack options (swarm size, roam percent, survivors, furious) are stored in ~/.cyanotype/cysaver.conf and passed on arm and on Test Full Screen.

• Preview embeds with -window-id and -no-input-exit so input in the panel does not kill the preview.
• Fullscreen idle and Test pass -fullscreen. Activity exits the hack so CySaver can show the lock greeter when lock is on.

Windowed On The Desk

xray-agent
xray-agent -swarm small
xray-agent -swarm large -roam 40
xray-agent -geometry 640x480 -fps 60

Default is an ordinary framed window (-window). Default geometry is 640x480; default frame rate is 60.

Fullscreen Without CySaver

xray-agent -fullscreen

Override-redirect full screen; exits on input. Same contract as the saver path.

Embed And Prefs Preview

xray-agent -window-id 0xWIN -no-input-exit

-parent is accepted as an alias for -window-id. Always add -no-input-exit when a parent owns the session.

Swarm Behaviour

• -swarm small|medium|large -- preset head counts (CySaver uses these)
• -count N -- raw swarm size (default 64 when you do not pass -swarm)
• -roam N -- roam area as 5..100 percent of the screen
• -survivors N -- blast survivors as 1..99 percent
• -furious -- faster REVENGE purge (speed, not criticality)

See Also

• Overview of Xray Agent
• Command Line
• Screen Saver book (Help Books > CySaver) for idle, lock, and timing