Skip to content

What is Nyx?

Nyx is a simple, interpreted, dynamically-typed scripting language for scripting, data manipulation, and system/graphics interaction via its standard library. Designed for simplicity and ease of use.

  • Xmake: A C/C++ build system. (See xmake.io)
  • C++17 Compiler: Such as GCC, Clang, or MSVC.
  • SDL2 Libraries (Optional, for std:sdl module):
    • SDL2 (version >=2.0.12)
    • SDL2_ttf (version >=2.0.15)
  1. Navigate to the root directory of the Nyx project.
  2. Build using Xmake:
    Terminal window
    xmake

After a successful build, you can install the nyx interpreter to a system location (e.g., /usr/local):

Terminal window
sudo xmake install --root

Once nyx is built (and optionally installed), you can run Nyx scripts:

Terminal window
nyx /path/to/your_script.nyx [script_arguments...]

Example:

Terminal window
nyx examples/snake_game/snake_game.nyx

To see the interpreter’s command-line options:

Terminal window
nyx --help