https://github.com/veelenga/lua.cr

Crystal to Lua bridge
https://github.com/veelenga/lua.cr

bindings crystal lua

Last synced: 3 months ago
JSON representation

Crystal to Lua bridge

• Host: GitHub
• URL: https://github.com/veelenga/lua.cr
• Owner: veelenga
• License: mit
• Created: 2017-04-05T14:45:52.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-05-11T12:30:59.000Z (over 1 year ago)
• Last Synced: 2024-10-18T23:42:16.180Z (3 months ago)
• Topics: bindings, crystal, lua
• Language: Crystal
• Homepage:
• Size: 81.1 KB
• Stars: 61
• Watchers: 6
• Forks: 8
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# lua.cr [![Build Status](https://travis-ci.org/veelenga/lua.cr.svg?branch=master)](https://travis-ci.org/veelenga/lua.cr)

Bindings to liblua and a wrapper around it. **UNDER CONSTRUCTION** :construction:

Only [Lua 5.4](http://www.lua.org/ftp/) or higher is supported.

## Installation

Add this to your application's `shard.yml`:

```yaml

dependencies:

  lua:

    github: veelenga/lua.cr

```

## Usage

First you need to `require` Lua:

```crystal

require "lua"

```

Then you can run a chunk of Lua code:

```crystal

Lua.run %q{

  local hello_message = table.concat({ 'Hello', 'from', 'Lua!' }, ' ')

  print(hello_message)

} # => prints 'Hello from Lua!'

```

Or run a Lua file and obtain results:

```crystal

p Lua.run File.new("./examples/sample.lua") # => 42.0

```

Or even evaluate a function and pass arguments in:

```crystal

lua = Lua.load

sum = lua.run %q{

  function sum(x, y)

    return x + y

  end

  return sum

}

p sum.as(Lua::Function).call(3.2, 1) # => 4.2

lua.close

```

More features coming soon. Try it, that's fun :)

## Contributing

1. Fork it https://github.com/veelenga/lua.cr/fork

1. Create a feature branch `git checkout -b my-new-feature` and implement your feature

1. Run tests `crystal spec` and format code `crystal tool format`

1. Commit your changes `git commit -am 'Add some feature'`

1. Push to the branch `git push origin my-new-feature`

1. Create a new Pull Request