README

Gesso.js

Gesso lets you create <canvas> applications for the browser using the powerful server-side tools you're used to, such as npm and require(), all without writing any HTML or CSS.

What?

Gesso is a command-line tool that:

Builds your project on-the-fly so you can see changes immediately
Eliminates boilerplate by running the result in a canvas on localhost
Lets you deploy by adding a single <script> element to your website

Gesso also includes an optional base library, and a plugin system to handle ambitious canvas projects.

Teaser

Why?

Sometimes you just want to make good art in the browser. And that inspiration shouldn't be wasted on boilerplate or build details.

Installation

Install with npm.

$ npm install -g gesso

Usage

Initialize a new package:
```
$ npm init
```
Add Gesso as a dependency:
```
$ npm install -S gesso
```

Create a new index.js file and add your code. For example:

var Gesso = require('gesso');

var game = new Gesso();
var t = 0;
var x;

game.update(function () {
  t += 1;
  var center = (game.width - 300) / 2;
  x = center + Math.sin(t / 15) * 20;
});

game.render(function (ctx) {
  ctx.fillStyle = 'rgba(255, 255, 255, 0.2)';
  ctx.fillRect(0, 0, game.width, game.height);

  ctx.font = '36px Verdana';
  ctx.fillStyle = '#f34';
  ctx.fillText('Hello,', 270, 200);
  ctx.fillText('Browser Games!', x, 252);
});

game.run();

Note: See hello for a complete project around this example.

Build and serve:

$ gesso server
version: x.y.z
 * Running on http://localhost:63550/
 * Watching for changes

Now visit http://localhost:63550 to see it in action.

Commands

The command-line interface provides commands to help you build, test, and publish an idea quickly.

You can also type gesso -h for inline help.

serve

Builds and serves your app, rebuilding on file changes.

$ gesso serve [options]

Aliases: server, s

--port, -p <port>: The port to serve on (default 63550)
--host <address>: The host to serve from (default 0.0.0.0)

build

Builds your app and bundles it into the output file (dist/gesso-bundle.js by default).

$ gesso build [options]

Aliases: b

--out <path>: The output file (default dist/gesso-bundle.js)

Project layout

Gesso projects are normal Node projects. The only additional requirements are:

You need to include gesso as a dependency. The CLI delegates all commands to the local installation so you can use different versions of Gesso in different projects.
Your project must expose an entry point. This is implicit if you create an index.js file. Or you can be explicit by providing a main field.

Gesso uses browserify to construct a require() dependency tree, including npm-installed packages, then combines them into a single JavaScript file. You can also use many Node built-in modules since they're wrapped to work in the browser.

API

Detailed documentation is currently being written and will be live by version 1.0.

Please take a look at the spinning example's index.js for now.

Deploying

Build your project
```
$ gesso build
```
Move the generated dist/gesso-bundle.js to your website
Add the following on your page where you want your project to be rendered:
```
<canvas id="gesso-target"></canvas>
```

Note: If this is the only canvas on the page, then you can omit the id.

Add the following just above the </body> close tag:
```
<script src="gesso-bundle.js"></script>
```

Contributing

Check the open issues or open a new issue to start a discussion around your feature idea or the bug you found
Fork the repository, make your changes, and add yourself to authors.md
Send a pull request

If your PR has been waiting a while, feel free to ping me on Twitter.

Use this software often? Please consider supporting me on

Usage no npm install needed!