Getting Started
This page will walk you through getting set up with Nomsu. Nomsu's only prerequisites are Lua and LPEG. Nomsu has been tested on Mac, Linux, and Windows 10.
Installing Nomsu on Windows
For Windows, the best way to install is to download the self-contained executable build:
To get started, launchnomsu[version number].exe
and type
tutorial
into the interactive console and
hit "enter" twice.
You can right click a ".nom" file and choose "Open With..." and browse to the Nomsu .exe file and choose to always open .nom files with it. From then on, you can launch a Nomsu file by double clicking it. If you want a program to remain open until you close it, put this line at the end of your program:
Installing Prerequisites on Mac
If you use the Homebrew package manager, you can install Lua and LuaRocks (a Lua package manager) with: Then, you can install the Lua modules LPEG (required) and LuaFilesystem (recommended) with: Or, if any of these steps don't work for you, you can also build the prerequisites from source code.
Next: Download Nomsu
Installing Prerequisites on Linux
Use your package manager to install Lua and LuaRocks (a Lua package manager), for example, using apt-get: With LuaRocks, install LPEG and LuaFilesystem: Or, if any of these steps don't work for you, you can also build the prerequisites from source code.
Next: Download Nomsu
Building Prerequisites from Source
Building Lua from Source
Paraphrasing the instructions from Lua's website:
make macosx test
make linux test
Building LPEG from Source
LPEG is a Lua library used by Nomsu for Parsing Expression Grammars. To build and install it from source:
make LUADIR=/usr/local/include macosx
make LUADIR=/usr/local/include linux
Building LuaFilesystem from Source
LuaFilesystem is an optional (but recommended) Lua module that handles cross-platform filesystem functionality. Nomsu can run without it, but will be a little slower. To build LuaFilesystem:
For Mac:
Edit the# OS dependent
section of the
config
file to comment out the Linux LIB_OPTION
line and uncomment the Mac version.
Then, in the file Makefile
, delete the text:
so the line just reads:
Next: Download Nomsu
Downloading Nomsu
Once you have the prerequisites, download and unzip Nomsu:
That's it! You can now run the Nomsu tutorial from within the directory you just created:
If you want to install Nomsu so it's available on the whole system as the
command nomsu
, you can run this from within the
Nomsu directory: