diff --git a/README.md b/README.md index bd111148..875e70b6 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ HappyFunTimes * [Example Descriptions](docs/examples.md) * [Setting Up for Party or Installation](docs/network.md) * [Notes](#notes) +* [Migrating from 0.x.x to 1.x.x](docs/migration.md#migrate-from-0xx-to-1xx) [![Build Status](https://travis-ci.org/greggman/HappyFunTimes.svg?branch=master)](https://travis-ci.org/greggman/HappyFunTimes) diff --git a/docs/makinggames.md b/docs/makinggames.md index 0157d013..91230047 100644 --- a/docs/makinggames.md +++ b/docs/makinggames.md @@ -13,7 +13,7 @@ Making games with HappyFunTimes * **[Games in JavaScript](#making-a-game)** * **[game.js](#game-js)** * **[Handling Players](#handling-players)** -* **[package.json](#package.json)** +* **[package.json](#packagejson)** * **[Required Fields](#required-fields)** * **[Other Languages](#other-languages)** * **[hft commands](#hft-commands)** diff --git a/docs/migration.md b/docs/migration.md new file mode 100644 index 00000000..06e7466b --- /dev/null +++ b/docs/migration.md @@ -0,0 +1,194 @@ +Migrating Older Games +===================== + +* [Migrating from 0.x.x to 1.x.x](#migrate-from-0xx-to-1xx) + +## Migrating from 0.x.x to 1.x.x + +I'm really sorry but to separate the games and turn happyfuntimes into a kind +of virtual console required some non-backward compatible changes. I'll do my +best not to break things in the future. + +If you made a game for HappyFunTimes before they were separated from HappyFunTimes +here are some of the steps you need to take. + +* First, [install happyfuntimes](http://superhappyfuntimes.net/install) and run it at least once. + +* copy everything to a new folder outside of happyfuntimes + + pre version 1 all games existed side happyfuntimes in `public/examples/gameid` or + `public/games/gameid`. Now they should be completely outside of happyfuntimes + in their own folder + +* add a `.gitignore` file. Copy one from one of the examples. Ideally of the same type + so for example if it's a unity game [use this one](https://github.com/greggman/hft-unitycharacterexample/blob/master/.gitignore). + If it's an html5 game [try this one](https://github.com/greggman/hft-boomboom/blob/master/.gitignore). + +* inside that the folder type `.git init` + +* edit `package.json' + + [It should only have these fields](makinggames.md#packagejson). + Delete any others and edit appropriately + +* if you were using audio in HTML5 or TDL from one of the previous samples [copy a bower.json file](https://github.com/greggman/hft-jumpjump/blob/master/bower.json) + + * edit bower.json + + "name" + "deps" + private: true // this is not itself a bower package + + * run `bower install` + +* Make an icon.png/jpg/gif (64x64 or 128x128) + +* Make a screenshot.jpg/png/gif (640x480) + +* delete `gameview.html` and `index.html` + + Note: in the past there was a script, `build.py` that copied the contents of `game.html` into + `gameview.html` and `controller.html` into `index.html`. These operation now happen at runtime. + + But, because the old process was manual many people edited `index.html` and `gameview.html` + by hand so before you delete them make sure you copy the relavent changes into `game.html` + and `controller.html` + +* if you had a script before like `mygame.js` or `mycontroller.js` they must be specifically + called `scripts/game.js` and `scripts/controller.js`. They will get included automatically + so don't add any `