view/trunk/readme.txt

jgame.jsはオープンソースのHTML5向け2dゲームフレームワークです。
MITライセンスなので、商用非商用を問わずご自由にご利用いただけます。

動作はjavascriptですが、製作はtypescriptで行われているため、typescriptライブラリともいえます。
enchant.jsよりも少し使いにくく結構高速なライブラリとなることを目標としています。
詳しくはサンプルをご覧ください。
http://jgame-js.sourceforge.jp/


[javascriptライブラリとしての利用]
jgame.jsを利用する際は、jgame.jsをコピーし、以下のように利用してください。
<script type="text/javascript" src="jgame.js"></script>
<script type="text/javascript">
//ここにプロジェクト用のスクリプトを記述してください
</script>


[プロジェクトテンプレート]
jgame.jsでは以下の構造をプロジェクトテンプレートとして定義しています。
index.html
js/jgame.js
js/あなたのjavascript.js
img/あなたの画像ファイル
sound/あなたの音声ファイル
css/あなたのcssファイル
ts/あなたのtypesriptファイル

imgやsoundはフォルダをあえて固定にしてあります。
変更したい場合はResourceStructureという仕組みを使う必要があります。
http://jgame-js.sourceforge.jp/resource-structure.html


[初期化]
jg.globalize();
window.onload = function() {
        var game = new Game(320, 320);
        game.preload({chara: "chara.png"});
        game.loaded.handle(function() {
                var chara = new Character(game.r("chara"), 32, 32);
                game.currentScene.append(chara);
                chara.frame = [0, 1];
                chara.tl().moveBy(288, 0, 1800)
                        .scaleTo(-1, 1, 300)
                        .moveBy(-288, 0, 1800)
                        .scaleTo(1, 1, 300)
                        .loop();
        });
}

詳しくは各種サンプルをご覧ください。
http://jgame-js.sourceforge.jp/
window.onloadで初期化し、game.loaded.handle内に初期化後のコードを記述していく形になります。
jqueryを利用されている場合、window.onloadの代わりに以下の形を利用してください。
jg.globalize();
$(function() {
        var game = new Game(320, 320);
        game.preload({chara: "chara.png"});
        game.loaded.handle(function() {
                var chara = new Character(game.r("chara"), 32, 32);
                game.currentScene.append(chara);
                chara.frame = [0, 1];
                chara.tl().moveBy(288, 0, 1800)
                        .scaleTo(-1, 1, 300)
                        .moveBy(-288, 0, 1800)
                        .scaleTo(1, 1, 300)
                        .loop();
        });
});


[typescriptライブラリとしての利用]
jgame.jsをtypescriptのライブラリとして利用する場合、
javascriptライブラリとしての利用方法と同じようにまずはjgame.jsをコピーしてください。

ビルドの際には定義ファイルが必要になるため、
libフォルダにあるjgame.d.tsが必要になります。
これらをTypeScriptのプロジェクトにコピーし、ビルド設定に追加することでライブラリとして利用できるようになります。

以下のような構成がいいかと思います。
-------------------
lib/jgame.d.ts
ts/yourtypescript.ts
js/jgame.js
js/yourscript.js
-------------------

jgame.jsと同じようにtsconfig.jsonを使う場合は、以下のような内容をts/tsconfig.jsonとして作ると使いやすいでしょう。
-------------------
{
    "compilerOptions": {
        "module": "commonjs",
        "noLib": true,
        "target": "es5",
        "out": "../js/yourscript.js"
    },
    "files": [
        "lib/jgame.d.ts",
        "yourtypescript.ts"
    ]
}

-------------------


[開発者向け]
最初にnpm installをして、その後npm run buildでビルドできます。
タグ等を打つ場合はnpm run deployしてください。