initial commit

This commit is contained in:
Bruno Dias 2015-04-13 00:08:06 -03:00
commit 93cdb0f069
9 changed files with 97 additions and 0 deletions

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
node_modules

0
Gulpfile.js Normal file
View File

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2015 Bruno Dias
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

53
README.md Normal file
View File

@ -0,0 +1,53 @@
# Raconteur Development Template
A scaffold for Raconteur projects.
## Installation
You'll need [Node.js] and [Gulp] installed.
git clone [this repository]
cd raconteur-template
npm install
## Pieces
Raconteur is designed to be used with a toolchain made of several powerful web development tools.
- Node.js
- npm
- Gulp
- Browserify
- CoffeeScript
- Less
## File Structure
Inside the scaffold, you will find:
```
.
|-- game
| `-- main.coffee
|-- html
| `-- index.html
|-- img
|-- less
| |-- main.less
| `-- mobile.less
|-- Gulpfile.js
`-- package.json
```
- `game/main.coffee`: The main entry point for your game. Contains a skeleton of a Raconteur story.
- `html/index.html`: The html page for your story.
- `img/`: This directory holds all of your game's image assets. Anything with the .png or .jpeg extensions, in this folder (including subfolders), will be copied over to `build/img/` or `dist/img/` when you build your game, so that the relative path for all of your images will be `img/image.png` and so on.
- `less/`: Holds your Less files. `less/main.less` is the entry point for Less; all other files have to be imported by this file. `less/mobile.less` has mobile-specific definitions, but you're free to reorganise these files as you like.
- `Gupfile.js`: The Gulpfile is the configuration file for the build system. Ideally, you won't have to edit this unless you want to change your folder organisation or build setup.
- `package.json`: This barebones package.json file only holds a list of dependencies to install, so that `npm install` will install dependencies automagically.
## Usage
This scaffold comes prepped for usage with Gulp as a build system, Less for CSS preprocessing, Browserify for bundling JavaScript, and CoffeeScript as a JS transpiler.
Running `gulp` will build your game in the `build/` directory. `gulp serve` will build and then start up a local server with live reload, so you can point your browser. `gulp dist` will make a distribution-ready copy of your game in `dist/`, with minified/gzipped JavaScript and CSS.

0
game/main.coffee Normal file
View File

0
html/index.html Normal file
View File

View File

0
less/raconteur.less Normal file
View File

22
package.json Normal file
View File

@ -0,0 +1,22 @@
{
"dependencies": {
"undum": "git://github.com/sequitur/undum.git#commonjs",
"raconteur": "git://github.com/sequitur/raconteur.git#stable",
"jquery": "^2.1.3",
"markdown-it": "^4.1.0"
},
"private": true,
"devDependencies": {
"babelify": "^6.0.2",
"browser-sync": "^2.6.0",
"browserify": "^9.0.8",
"gulp": "^3.8.11",
"gulp-less": "^3.0.2",
"gulp-sourcemaps": "^1.5.1",
"gulp-util": "^3.0.4",
"lodash": "^3.6.0",
"vinyl-buffer": "^1.0.0",
"vinyl-source-stream": "^1.1.0",
"watchify": "^3.1.0"
}
}