Skip to content

Latest commit

 

History

History
48 lines (37 loc) · 3.86 KB

README.md

File metadata and controls

48 lines (37 loc) · 3.86 KB

Theseus Documentation

Technical documentation for Theseus, the Xbox dashboard engine rebuilt from binary analysis of the retail dashboard, and for UIX Desktop, the build of it that runs on macOS, Linux and Windows. If you just want to run it, the main README is the place to start.

Reference

  • XAP Script Contract: every node type, function, property and callback the dashboard's XAP scripts use. The "do not break" surface any implementation (Xbox, desktop, future ports) has to honor.
  • xips-source: the editable source for the scene archives Theseus adds or changes.

What we found in the dashboard binary (decomp/)

Per subsystem notes from analyzing the 5960 retail dashboard XBE in Ghidra. Each file documents the structures, function tables, properties and behavior identified for one part of the dashboard. decomp/README.md is the address by address index.

  • VM: XAP bytecode VM: opcode set, operator table, built in functions, variable resolution
  • Compiler: how XAP text becomes bytecode and scene nodes
  • Node: scene graph reflection, FND and PRD struct layouts, how the structures were identified in the binary
  • XIP: archive format, file layout, texture loading, mesh buffer layout
  • AudioSystem: DirectSound pipeline, CAudioBuf, CAudioPump, CFilePump, CAudioClip, CMusicCollection
  • SceneGroups: Group, Layer, Background and Level grouping nodes
  • ShapeRender: Shape, Appearance, Material, Box, Sphere, falloff shading, mesh normal smoothing
  • HudNode: the HUD and Picture screen space overlay nodes
  • TmapSystem: dynamic textures, delta field warping, audio visualizer, FFT, particle dot field
  • AnimationNodes: TimeSensor, interpolators, Viewpoint, NavigationInfo
  • FileOps: file and directory copy, save game grid backend
  • Keyboard: on screen keyboard layout and input handling
  • Camera: view matrix construction
  • Text: font rendering, glyph layout, color formatting
  • NtIoSvc: CD-ROM IOCTL service
  • TitleCollection: saved game and title enumeration backend
  • Settings: system settings, screen saver, INI style config file parser
  • Date and Math: built in date and math objects
  • StringObject: string built in
  • Util: utility helpers

Desktop (desktop/)

How the same engine runs on macOS, Linux and Windows. The Xbox build doesn't need any of this.

  • Building: every desktop target, the one time library steps, Windows cross builds, packaging
  • Dependencies: packages per OS, minimum library versions, Windows cross deps
  • Desktop Features: games grid and launching, Title Maker, media, music, xCloud, skins, CRT, tools
  • Porting to PC: the platform layer, drive letters and the user data folder, audio, input, nodes
  • D3D8 to bgfx: drawing the dashboard's Direct3D 8 calls through bgfx
  • Media Player: the media library, libmpv playback, and the DVD player node

The Xbox build

Built with OXDK through build/Makefile.xbox (make -f Makefile.xbox CONFIG=retail or CONFIG=debug from build/). It needs an Xbox SDK tree of your own at theseus/xdk. Console work currently ships as UIX Lite; the Theseus XBE is a work in progress.