# Monogatari

> Visual Novel Engine

Monogatari is a simple web visual novel engine, created to bring visual novels to the web.

## Pages

- [Monogatari](/index.md): Built for the modern web — create and distribute visual novels that play anywhere.
- [Contributors](/contributors.md): The people who made Monogatari awesome.
- [Game Gallery](/gallery.md): A showcase of visual novels and games created with the Monogatari engine.
- [Demo](/demo.md): Play with Monogatari live in your browser.

## Documentation

> Guides and reference for the Monogatari visual novel engine.

- [Welcome](/v2/welcome.md): Monogatari is a free, open-source web visual-novel engine. Start here to build your first game.
- [Getting Started](/v2/getting-started.md): Install Monogatari, run it locally with live reload, and write your first scene.
- [Step 1: Set Up Your Environment](/v2/getting-started/step-1-setup-your-environment.md): Install the three tools you need — a browser, a code editor, and Bun.
- [Step 2: Get Monogatari Running](/v2/getting-started/getting-monogatari.md): Get the project template and start the live-reload dev server.
- [Step 3: Get Familiarized](/v2/getting-started/step-3-get-familiarized.md): A quick tour of the project — what every folder and file is for.
- [Step 4: Make Your First Visual Novel](/v2/getting-started/step-4-make-your-first-visual-novel.md): Write, save and test your own dialog, character and scene with live reload.
- [Upgrading from v1.4.1](/v2/upgrading-from-v1-4-1.md): Learn all you need to know about upgrading your game!
- [F.A.Q.](/v2/f-a-q.md)
- [Diagnosing Errors](/v2/diagnosing-errors.md)
- [Building Blocks](/v2/building-blocks.md)
- [Script & Labels](/v2/building-blocks/script-and-labels.md)
- [Characters](/v2/building-blocks/characters.md): Learn about characters, their properties and how to create them!
- [Variables & Data Storage](/v2/building-blocks/data-storage.md)
- [Actions](/v2/building-blocks/actions.md)
- [Life Cycle](/v2/building-blocks/actions/life-cycle.md)
- [Components](/v2/building-blocks/components.md)
- [Life Cycle](/v2/building-blocks/components/life-cycle.md)
- [Built-in Properties](/v2/building-blocks/components/built-in-properties.md)
- [Built-in Functions](/v2/building-blocks/components/built-in-functions.md)
- [Script Actions](/v2/script-actions.md)
- [Choices](/v2/script-actions/choices.md): Learn about choices, their properties and how to use them!
- [Clear](/v2/script-actions/clear.md): Clear the text box
- [Conditionals](/v2/script-actions/conditionals.md): Control the flow of your game based on conditions
- [Dialogs](/v2/script-actions/dialogs.md): The text your players are going to read.
- [End](/v2/script-actions/end.md): End your game
- [Gallery](/v2/script-actions/image-gallery.md): An Image Gallery of images for your players to unlock
- [Hide Canvas](/v2/script-actions/hide-canvas.md)
- [Hide Character](/v2/script-actions/hide-character.md): Remove a character's sprite from screen
- [Hide Image](/v2/script-actions/hide-image.md): Remove an image from the screen
- [Hide Particles](/v2/script-actions/hide-particles.md): Hide a particle system animation
- [Hide Video](/v2/script-actions/hide-video.md): Stop and remove a video from the screen
- [Hide Text Box](/v2/script-actions/hide-textbox.md): Hide the dialog text box to show off the scene behind it.
- [Input](/v2/script-actions/input.md): Displays an input dialog to the player
- [Functions](/v2/script-actions/javascript.md): Run JavaScript functions in your script
- [Jump](/v2/script-actions/jump.md): Jump to a different label in your script
- [Next](/v2/script-actions/next.md): Continue to the next statement on the script
- [Pause](/v2/script-actions/pause.md): Pause playing media
- [Placeholder](/v2/script-actions/placeholder.md)
- [Play Music](/v2/script-actions/play-music.md): Play music media
- [Play Sound](/v2/script-actions/play-sound.md): Play a sound effect
- [Play Voice](/v2/script-actions/play-voice.md): Play a voice audio file
- [Preload](/v2/script-actions/preload.md): Preload assets to ensure smooth playback
- [Show Canvas](/v2/script-actions/canvas.md)
- [Show Background](/v2/script-actions/show-background.md): Show a background without removing any game elements.
- [Show Character](/v2/script-actions/characters.md): Show a character's sprite
- [Show Character Layer](/v2/script-actions/character-layers.md): Control individual layers of a character sprite
- [Show Image](/v2/script-actions/show-image.md): Show an image on screen
- [Show Message](/v2/script-actions/message.md): Show a message
- [Show Notification](/v2/script-actions/notifications.md): Show a notification to the player
- [Show Particles](/v2/script-actions/particles.md): Show a particle system animation
- [Show Scene](/v2/script-actions/show-scene.md): Change the background
- [Show Video](/v2/script-actions/show-video.md): Display videos in your visual novel
- [Show Text Box](/v2/script-actions/show-textbox.md): Make the dialog text box visible again after it was hidden.
- [Stop Music](/v2/script-actions/stop-music.md): Stop playing music
- [Stop Sound](/v2/script-actions/stop-sound.md): Stop playing sound effects
- [Stop Voice](/v2/script-actions/stop-voice.md): Stop playing voice audio
- [Unload](/v2/script-actions/unload.md): Free up memory by unloading unused assets
- [Vibrate](/v2/script-actions/vibrate.md): Make the player's device vibrate
- [Wait](/v2/script-actions/wait.md): Wait an amount of time before continuing
- [Components](/v2/components.md)
- [Credits Screen](/v2/components/credits.md): The credits page so players can see who made the game
- [Quick Menu](/v2/components/quick-menu.md): The in-game toolbar with save, load, settings, skip and other shortcuts — and how to add your own buttons.
- [Loading Screen](/v2/components/loading-screen.md): The screen showing the asset preloading progress
- [Main Screen](/v2/components/main-screen.md): The screen that hosts the main menu and plays the menu's ambient music.
- [Choice Container](/v2/components/choice-container.md)
- [Save Slot](/v2/components/save-slot.md)
- [Text-Box](/v2/components/text-box.md)
- [Centered Dialog](/v2/components/centered-dialog.md): A floating dialog box centered on the screen, shown when a line begins with the `centered` keyword.
- [Dialog Log](/v2/components/dialog-log.md): A scrollable history of every dialog shown during play, opened from the Log button in the quick menu.
- [Type Writer](/v2/components/type-writer.md): Animated text rendering that reveals characters one at a time, with inline effects, pauses and speed changes.
- [Text Input](/v2/components/text-input.md): A flexible modal input component used by the Input action to collect text, numbers, and choices from the player.
- [Alert Modal](/v2/components/alert-modal.md): A confirmation modal with a message and custom action buttons, used for quit, slot deletion and slot overwrite confirmations.
- [Message Modal](/v2/components/message-modal.md): A modal with a title, subtitle and body shown by the Show Message action, which blocks the game until the player closes it.
- [Main Menu](/v2/components/main-menu.md): The game's main menu screen, rendering the buttons players use to start, load, and configure the game.
- [Settings Screen](/v2/components/settings-screen.md): The in-game settings screen with volume, text speed, auto-play, language and (on desktop) resolution controls.
- [Save Screen](/v2/components/save-screen.md): The in-game save screen where players name a save and store their current progress into a slot.
- [Load Screen](/v2/components/load-screen.md): The in-game load screen listing manual saves and, when enabled, auto-saves for the player to resume.
- [Gallery Screen](/v2/components/gallery-screen.md): A screen that displays unlockable CG images in a grid, with locked entries hidden behind a lock icon.
- [Help Screen](/v2/components/help-screen.md): An in-game screen listing the quick menu buttons and keyboard shortcuts, opened from the Help button in the main menu.
- [Language Selection Screen](/v2/components/language-selection-screen.md): A pre-game screen letting players pick a language, shown for multi-language games that have the language selection screen enabled.
- [Configuration Options](/v2/configuration-options.md)
- [Game Configuration](/v2/configuration-options/game-configuration.md)
- [Asset Preloading](/v2/configuration-options/game-configuration/asset-preloading.md): Configure asset preloading and caching for web deployment
- [Internationalization](/v2/configuration-options/game-configuration/internationalization.md): Making Monogatari games multilingual.
- [Saving](/v2/configuration-options/game-configuration/saving.md): Configure save slots and auto-save functionality
- [Skip Main Menu](/v2/configuration-options/game-configuration/skip-menu.md): Skip the main menu and start directly into the game
- [Storage](/v2/configuration-options/game-configuration/storage-engine.md)
- [Player Preferences](/v2/configuration-options/player-preferences.md): Player-adjustable preferences and their default values
- [Split Files](/v2/configuration-options/split.md): Splitting your Script into multiple files.
- [Style & Design](/v2/style-and-design.md)
- [Responsiveness](/v2/style-and-design/responsiveness.md)
- [CSS Classes](/v2/style-and-design/classes.md): The helper CSS classes Monogatari ships with for positioning and aligning interface elements.
- [HTML Data Attributes](/v2/style-and-design/data-attributes.md): The data-* attributes Monogatari uses to wire up the interface, and how to use them when customizing.
- [Icons](/v2/style-and-design/icons.md): Use Font Awesome icons anywhere in your game — in menus, buttons and dialog.
- [Image Menus](/v2/style-and-design/image-menus.md)
- [Releasing Your Game](/v2/releasing-your-game.md)
- [Web](/v2/releasing-your-game/web.md): Build your game for the web and publish it anywhere — itch.io, a static host, or your own server.
- [Desktop App](/v2/releasing-your-game/desktop.md): Package your game as a standalone Windows, macOS or Linux application.
- [Mobile](/v2/releasing-your-game/mobile.md): Reach phones and tablets — installable as an app, with offline play.
- [Chrome App](/v2/releasing-your-game/chrome.md): Chrome Apps are discontinued — release your game as a website instead.
- [Advanced: Monogatari Development](/v2/advanced-monogatari-development.md)
- [Core Libraries](/v2/advanced-monogatari-development/core-libraries.md): >-
- [Actions](/v2/advanced-monogatari-development/actions.md)
- [Components](/v2/advanced-monogatari-development/components.md)
- [Translations](/v2/advanced-monogatari-development/translations.md): Add or override Monogatari's interface strings for your game, in any language.
- [Events](/v2/advanced-monogatari-development/events.md): The engine events you can hook into with monogatari.on() to run your own code.
- [Translations](/v2/contribute/translations.md): Help translate Monogatari's interface into more languages.

## Documentation v1

> Guides and reference for the Monogatari visual novel engine.

- [Getting Started](/v1/welcome.md)
- [Configuration](/v1/configuration.md): Configuration — Monogatari documentation.
- [Asset Preloading](/v1/configuration/asset-preloading.md)
- [Internationalization](/v1/configuration/internationalization.md)
- [Saving](/v1/configuration/saving.md)
- [Skip Main Menu](/v1/configuration/skip-menu.md)
- [Design](/v1/design.md): Design — Monogatari documentation.
- [CSS Classes](/v1/design/classes.md)
- [HTML Data Attributes](/v1/design/data-attributes.md)
- [Icons](/v1/design/icons.md)
- [Image Menus](/v1/design/image-menus.md)
- [Port](/v1/port.md): Port — Monogatari documentation.
- [Ren'py](/v1/port/renpy.md)
- [Release](/v1/release.md): Release — Monogatari documentation.
- [Chrome App](/v1/release/chrome.md)
- [Desktop App](/v1/release/desktop.md)
- [Mobile](/v1/release/mobile.md)
- [Web](/v1/release/web.md)
- [Script](/v1/script.md): Script — Monogatari documentation.
- [Audio](/v1/script/audio.md)
- [Characters](/v1/script/characters.md)
- [Choices](/v1/script/choices.md)
- [Conditionals](/v1/script/conditionals.md)
- [Images](/v1/script/images.md)
- [Input](/v1/script/input.md)
- [JavaScript](/v1/script/javascript.md)
- [Labels](/v1/script/labels.md)
- [Messages](/v1/script/messages.md)
- [Notifications](/v1/script/notifications.md)
- [Particles](/v1/script/particles.md)
- [Scenes](/v1/script/scenes.md)
- [Split Files](/v1/script/split.md)
- [Storage](/v1/script/storage.md)
- [Text](/v1/script/text.md)
- [Vibration](/v1/script/vibration.md)
- [Video](/v1/script/video.md)
- [Wait](/v1/script/wait.md)
- [Contribute](/v1/contribute.md): Contribute — Monogatari documentation.
- [Translations](/v1/contribute/translations.md): Translate Monogatari to other languages!