Yureka LogoDocs
GitHubyureka.dev

Getting Started

This guide covers the initial setup of OSSIM.

Prerequisites

  • Unreal Engine 5.x
  • C++ Enabled Project (OSSIM core logic is C++ based).
  • UMG: Familiarize yourself with the base widget classes in Source/OSSIM/Public/UI.

Initial Launch Flow

The OSSIM shell is Auto-On; it initializes itself immediately upon game start without manual intervention.

  1. Open the OSSIM_DemoMap.
  2. Press Play.
  3. Boot Splash (Auto): The UOSOrchestratorWidget initializes on BeginPlay and automatically starts the boot sequence.
  4. Onboarding: On a fresh install, you'll be prompted to create your first user. This data is saved to the OSSIM_UserProfile slot via the UOSSIMSaveGame class.
  5. Desktop: Once authenticated, the desktop shell (UDesktopRootWidget) will load.

Subsystem Configuration

1. OS Orchestrator (UOSOrchestratorWidget)

The master controller for shell stages.

  • Stage Switcher: A UWidgetSwitcher containing:
    1. Boot Splash
    2. Onboarding
    3. Login
    4. Desktop
  • ContextMenuClass: The widget class used for global context menus.

2. Desktop Surface (UDesktopSurfaceWidget)

  • IconGrid: A container (Wrap Box) for desktop shortcuts.
  • AppIconWidgetClass: The widget used to render individual icons.
  • Border: BackgroundWallpaper (You can assign wallpaper here)

3. Taskbar (UTaskbarWidget)

  • ClockText: A text block for the system time.
  • AppButtonContainer: A container for active application buttons.
  • AppIconClass: A template icon widget class for active applications.
  • StartMenuClass: The class of the Start Menu to spawn.

4. Window Chrome (UWindowWidget)

Every application is wrapped in a window frame.

  • BodyContainer: Where the app's content is injected.
  • TitleText: Displays the app's name.
  • CloseButton, MinimizeButton, MaximizeButton, AddTabButton: Standard window controls.

Try it Yourself

  1. Verify Onboarding: Complete the first-run flow and ensure your user profile is created.
  2. Launch Built-in Apps: Open the Explorer, Notepad, and Terminal to confirm subsystems (VFS, Process) are active.
  3. Test Persistence: Create a file in Notepad, restart the game, and verify it still exists in the File Explorer.