Sha256: c3cbe4430d221479916c5b40c5aa7be6b352636b158ab9fa6a05295035e8879e

Contents?: true

Size: 1.05 KB

Versions: 9

Compression:

Stored size: 1.05 KB

Contents

# <%= name %>

A Gamefic game project

## Installation

    $ bundle install

## Running on the Command Line

    $ rake ruby:run

## Building a CLI Game

    $ rake ruby:build

The script will be saved in the `ruby/build` directory.

## Web-Based Games

The Gamefic SDK also supports web-based versions of games. The project gets built into a single-page application with the Ruby game code compiled into JavaScript.

First you need to install the web project scaffold:

    $ rake web:generate
    $ npm install

## Running a Web Game

To run the app in debug mode:

    $ rake web:run

Open http://localhost:9000 in a browser.

## Building a Web Game

    $ rake web:build

The application will be saved in the `web/build` directory.

## Unit Tests

To run the test suite with Ruby:

    $ rspec

To run the test suite with Opal:

    $ rake opal

The Opal tests can be useful for finding bugs in the web build that do not occur in standard Ruby.

## More Information

Go to https://gamefic.com for documentation.

Version data entries

9 entries across 9 versions & 1 rubygems

Version Path
gamefic-sdk-4.1.1 scaffolds/project/README.md.gf.erb
gamefic-sdk-4.1.0 scaffolds/project/README.md.gf.erb
gamefic-sdk-4.0.1 scaffolds/project/README.md.gf.erb
gamefic-sdk-4.0.0 scaffolds/project/README.md.gf.erb
gamefic-sdk-3.4.1 scaffolds/project/README.md.gf.erb
gamefic-sdk-3.4.0 scaffolds/project/README.md.gf.erb
gamefic-sdk-3.3.0 scaffolds/project/README.md.gf.erb
gamefic-sdk-3.2.1 scaffolds/project/README.md.gf.erb
gamefic-sdk-3.2.0 scaffolds/project/README.md.gf.erb