Home

Welcome to the Surface 2 wiki!

Here you will find the documentation for all functions.

Getting started

You can check out the well-documented examples to learn Surface 2.
It is also highly recommended you check out the Concepts page, which explains how things are represented.

Using Surface 2

Pastebin Download

dofile (recommended)

To use this in your program, the main way is to load the library using dofile:
local surface = dofile("/path/to/surface")

inline

You can also copy + paste the library to the top of your program,
and remove return surface at the end.
It will then have the same purpose as the above method.

carl

If you're using carl to build your program, you can do
--#require /path/to/surface
Though note that the real file name has to end with a .lua, since carl expects source files to end with .lua.

Building Surface 2

If you want to build Surface 2 yourself, you need to build it with carl.
To build Surface 2, you cd to the directory and simply do carl build.
The output file will be located at /path/to/Surface2/target/surface.