DocumentationDocumentation
GitHubGitHub (opens in a new tab)
  • Introduction
  • Quick Start
  • Installation
  • Basic
    • Create a Scene
    • Add Actions
    • Show Dialog
    • Show Images
    • Play the Story
    • Make Choices
    • Play Sounds
    • Store Data
    • Conditional
    • Play Voices
    • Manage Preferences
  • Core
    • Elements
      • Scene
      • Character
        • Sentence
        • Word
        • Pause
      • Image
      • Sound
      • Menu
      • Script
      • Condition
      • Control
      • Text
      • Persistent
      • Story
      • Displayable
      • Layer
      • Service
    • Animation
      • Transform
      • Transition
        • Dissolve
        • Fade In
    • Game
      • Game
      • GameState
      • LiveGame
      • Storable
        • Namespace
        • Preference
      • AlignPosition
      • IPosition
      • ITransition
      • ImageTransformProps
      • ImageConfig
      • ImageColor
      • ImageSrc
      • IImageUserConfig
      • ILayerUserConfig
      • ITextUserConfig
      • ISceneUserConfig
      • ISoundUserConfig
      • IStoryConfig
      • JumpConfig
      • Lambda
      • LambdaCtx
      • LambdaHandler
      • LiveGameEvent
      • LiveGameEventToken
      • SayComponent
      • SavedGame
      • SceneConfig
      • ScriptCtx
      • SentenceConfig
      • SentencePrompt
      • SentenceUserConfig
      • ServiceHandlerCtx
      • SoundConfig
      • SoundType
      • StorableData
      • CharacterConfig
      • CharacterMode
      • ChainedActions
      • Choice
      • Coord2DPosition
      • CommonDisplayable
      • CommonDisplayableConfig
      • CommonPositionType
      • CommonTransformProps
      • Components
      • ComponentsTypes
      • ConditionConfig
      • CustomEasingFunction
      • WordConfig
      • EasingDefinition
      • BezierDefinition
      • MenuConfig
      • MenuChoice
      • GameConfig
      • GamePreference
      • TextConfig
      • TransformDefinitions
      • TransformersMap
      • RawPosition
      • RichImageUserConfig
      • Origins
      • OffsetPosition
      • PauseConfig
      • PreferenceEventToken
      • FadeOptions
      • Awaitable
      • Background
      • Color
      • Font
      • Gamecontexttype
      • Menucomponent
    • Utils
  • Player
    • Player
    • GameProviders
      • useGame
      • usePreference
      • useRouter
    • Page Router
      • Router
      • Page
  • Customization
  • Migration
    • From Ren'Py
    • License
    • Incompatible Changes
Question? Give us feedback → (opens in a new tab)Edit this page
Documentation
Core
Elements

Elements

SceneCharacterImageSoundMenuScriptConditionControlTextPersistentStoryDisplayableLayerService
CoreScene
Copyright © 2025 NarraLeaf. Licensed under the MPL-2.0 License. GitHub.