module

Emerald::Docs::GETTING_STARTED::Installation

Installation & Environment Setup

Executive Summary & Key Topics

Topic Method / Anchor Description
Adding the Shard .topic_01_adding_the_shard Configuring shard.yml with emerald and lapis.
LibVLC Prerequisites .topic_02_libvlc_prerequisites System requirements and VLC runtime binaries.
Requiring Emerald .topic_03_requiring_emerald Importing emerald into your project.

Class methods

topic_01_adding_the_shard

Adding the Shard: Configuring shard.yml with emerald and lapis.

Add emerald to your project's shard.yml:

dependencies:
  lapis:
    github: sol-vin/lapis
    branch: master
  emerald:
    github: sol-vin/emerald
    branch: main

Run shards install to fetch the dependencies.

Source
topic_02_libvlc_prerequisites

LibVLC Prerequisites: System requirements and VLC runtime binaries.

Emerald interfaces directly with the native LibVLC runtime library installed on your system.

  • Windows: Install the standard 64-bit VLC Media Player from videolan.org. Emerald automatically locates C:\Program Files\VideoLAN\VLC, sets VLC_PLUGIN_PATH, and configures DLL discovery via SetDllDirectoryA.
  • Linux (Ubuntu/Debian): sudo apt install libvlc-dev vlc-plugin-base
  • Arch Linux: sudo pacman -S vlc
  • macOS: Install VLC from official .dmg or brew install vlc.
Source
topic_03_requiring_emerald

Requiring Emerald: Importing emerald into your project.

In your game's main entry point (e.g. src/main.cr):

require "lapis"
require "emerald"

Requiring emerald automatically registers EmeraldVideoPlayer, EmeraldAudioPlayer, and EmeraldVideoPlayer3D with Godot's ClassDB.

Source