# Greenworks

* Greenworks is a [node.js addon](https://nodejs.org/api/addons.html) that
allows you to integrate your HTML5 game (or app) with
[Steamworks](https://partner.steamgames.com/) by exposing a number of
Steamworks APIs to JavaScript.
* Greenworks was originally developed by
[Greenheart Games](http://www.greenheartgames.com) to enable Steam integration
in [Game Dev Tycoon](http://www.greenheartgames.com/app/game-dev-tycoon/).
Since then, it has been open-sourced and is
[used in many other projects](https://github.com/greenheartgames/greenworks/wiki/Apps-games-using-greenworks).
* Currently Greenworks supports:
  * node v0.8, v0.10, v0.12, v4, v5, v6, v7, v8, v9 and v10+
  * NW.js v0.8, v0.11+
  * Electron v1.0.0+
  * Steam SDK v1.62
* Greenworks is built using [Native Abstractions for Node.js](https://github.com/nodejs/nan) to
support different node versions.

## Download

Prebuilt binaries of Greenworks for NW.js can be found on
the [releases](https://github.com/greenheartgames/greenworks/releases) page.

## Documentation

Guides and the API references are located in [docs](docs) directory.

## Contributions

This project is maintained on a best-effort basis. While it is stable and used in production by many, please be aware that active development is not a priority.

Responses to issues and pull requests may be slow due to limited time. If you need dedicated support or have a great idea you'd like to see implemented, please reach out to the [maintainer](https://github.com/hokein).

If this library has helped you, please consider becoming a sponsor to support its continued maintenance and development.

## License

Greenworks is published under the MIT license. See the [license file](https://github.com/greenheartgames/greenworks/blob/master/LICENSE) for details.

## Twitter

If you use Greenworks, please let us know at
[@GreenheartGames](https://twitter.com/GreenheartGames)
and feel free to add your product to our
[product list](https://github.com/greenheartgames/greenworks/wiki/Apps-games-using-greenworks).