orkid: Skill for Claude Code

Orkid Application Framework Reference

When answering questions about application structure in orkid, consult these files.

Key Files

Component	Location
Application (C++)	ork.core/inc/ork/application/application.h
Application Impl	ork.core/src/application/application.cpp
Python Bindings	ork.core/pyext/pyext_application.cpp
ComponentizedApplication	obt.project/scripts/ork/app/application.py
Logger UI Component	obt.project/scripts/ork/app/loggerui.py
Frame Profiler	obt.project/scripts/ork/app/frame_profiler.py

Architecture Overview

AppInitData

Singleton struct (appinitdata()) centralizing initialization config:

• Command-line parsing (Boost.ProgramOptions)
• Window config: width, height, fullscreen, MSAA/SSAA
• Audio config: device names, channels, framesize, stream sync
• Target UPS/FPS rates
• Pre/post init operation queues

Path Expanders (set during init)

<assetcache>  → <stage>/assetcache
<staging>     → staging directory root
<ork_data>    → orkid data directory
<ork_ecsscenes> → ork.data/ecsscenes
<ork_envmaps> → staging/envmaps
<ork_testdata> → ork.data/tests

URI Contexts

src://     → ork.data/src
data://    → ork.data
lev2://    → ork.data/platform_lev2
orkid://   → orkid root
ork_core://→ ork.core source
ork_lev2://→ ork.lev2 source

Environment Variables

• ORKID_ASSET_MANIFEST_DIRS — colon-separated manifest paths
• ORKID_AUDIO_INPUT_DEVICE / ORKID_AUDIO_OUTPUT_DEVICE
• ORKID_AUDIO_FRAMESIZE — buffer size (default 1024)
• ORKID_AUDIO_STREAM_SYNC — audio/graphics sync
• ORKID_DISABLE_ALWAYS_ON_TOP — window flag
• ORKID_LOGGER_BACKEND — logger selection

ComponentizedApplication (Python)

High-level Python app framework with ECS-like component pattern:

class MyApp(ComponentizedApplication):
  def __init__(self):
    super().__init__()
    self.logger = self.addComponent("logger", loggerui.LoggerUIComponent, ...)
    self.createEzApp(width=1280, height=720)

  def _onUiInit(self):
    lg = self.ezapp.topLayoutGroup
    # Build UI here

  def _onGpuInit(self, ctx):
    # GPU resources here

  def _onUpdate(self, updinfo):
    # Per-frame logic here

app = MyApp()
app.ezapp.mainThreadLoop()