[![Build Status](https://travis-ci.org/fengari-lua/fengari-web.svg?branch=master)](https://travis-ci.org/fengari-lua/fengari-web)
[![npm](https://img.shields.io/npm/v/fengari-web.svg)](https://npmjs.com/package/fengari-web)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![#fengari on Freenode](https://img.shields.io/Freenode/%23fengari.png)](https://webchat.freenode.net/?channels=fengari)


# fengari-web

Provides anything you need to run [Fengari](https://fengari.io) in the browser.

## Getting started

### Download

Visit the [GitHub releases page](https://github.com/fengari-lua/fengari-web/releases) and get the latest version.

Alternatively you can [Build](#Building) fengari-web yourself.


### Directly

Load fengari-web in your web page:

```html
<script src="fengari-web.js" type="text/javascript"></script>
```

Now any script of type `application/lua` will be run by fengari:

```html
<script type="application/lua">
print("Hello World!")
</script>

<script src="/my-script.lua" type="application/lua" async></script>
```

Note that if you use a `src` attribute, it is strongly recommended for it to be [`async`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attr-async).


### With build process

See [fengari-loader](https://github.com/fengari-lua/fengari-loader/)


## Compatibility

fengari-web should work in all modern browsers.

Verified to work in:

  - Chrome >= 38
  - Firefox >= 19
  - Safari >= 8
  - Microsoft IE 11
  - Microsoft Edge


## API

As well as running `<script type="application/lua">` tags, fengari-web creates a `fengari` global that contains the [core `fengari` API](https://github.com/fengari-lua/fengari#the-js-api) supplemented with:

  - `L`: the main `lua_State` (in which script tags are run)
  - `interop`: containing the [fengari-interop](https://github.com/fengari-lua/fengari-interop) library
  - `load(source, chunkname)`: a function that loads the lua code in `source` with the optional chunk name `chunkname` and returns it as a function.
    This function can be used to programmatically run lua code in the main `lua_State` from JavaScript. e.g.
    ```js
    console.log(fengari.load('return 1+1')())
    ```


## Building

```bash
git clone https://github.com/fengari-lua/fengari-web.git
npm install
```

This should automatically kick off the build process.
The built files can then be found in the `dist/` directory.

If you need to rebuild, run

```bash
npm run build
```

Or [use `webpack` directly](https://webpack.js.org/api/cli/).