kwk XML Project File

Kwikのプロジェクトファイルである .kwkとKwikがどのように動作しているのかを解説します。

フォルダーの構造

各プロジェクトは、Settings->Generalで、設定されているフォルダの配下に作成されます

  • ~/Documents/Kwik

新しくプロジェクトを作成した時にフォルダを自動的に作成します。プロジェクト名の空白は、_ (アンダースコア)に置換されます。

  • ~/Documents/Kwik/YourProject

プロジェクトのフォルダの中に、.kwkの拡張子でプロジェクトファイルが作成されます。

  • ~/Documents/Kwik/YourProject/YourProject.kwk

YourProject.kwkは、XMLファイル(テキストフォーマットの一種)です。プロジェクトの設定に加えて,インタラクション,アニメーション等など、ユーザがKwikで設定した情報が全て格納されています。

初めてPublishボタンを押した時に,Kwikはプロジェクトフォルダーの下にbulid4という名前のフォルダーを作成します。Corona Simulatorを用いて、表示・ビルドする時に必要な全てのコードと画像、オーディアファイルなどが、ここにパブリッシュされます。

build4 フォルダー

下記のフォルダ構造となっています。

  • assets
    • audios
    • images
    • particles
    • sprites
    • thumbnails
    • videos
    • www
  • commands
  • components
  • contexts
  • custom
  • extlib
  • lib
  • mediators
  • views
  • vo

下記のLuaファイルが直下に存在します。

  • Application.lua
  • assemble.bat
  • assemble.command
  • build.settings
  • config.lua
  • main.lua

サブフォルダについて

  • assetsフォルダに 画像、オーディオやスプライトシートなどが出力されます。

    • imageフォルダには、各ページのレイヤー画像がファイルとして出力されます。
  • commandsフォルダは、Action/Buttonに設定されているアクションが出力されます。

  • componentsフォルダは、animation, button, dynamic textなどが出力されます。p\ / \.lua に出力されます

  • contextsは,eventsとcommandsを定義します

  • customフォルダは、commandsもしくはcomponentsのカスタムファイルを置くことができるフォルダーです。カスタムファイルはオリジナルのものの代わりに読み込まれます。

  • extlibは、kwiksher's githubに記載されているサードパーティ製のluaファイルが格納されています。

  • libフォルダは、ユーザが自由に使うことができるフォルダです。独自のluaファイルを格納してください。

  • mediatorsは、eventとpageの制御です。

  • viewsは、Corona SDKのcomposerを利用した各ページビューを定義します。

  • voは、各ページの各レイヤーの名前を定義します。

Lua ファイルについて

  • Application.luaはシステムを起動させます

  • assemble.batは、画面をCorona Simulatorを用いてキャプチャするものです.デバイスにビルドする時にはこれを削除してください

  • assemble.commandは、画面をCorona Simulatorを用いてキャプチャするものです.デバイスにビルドする時にはこれを削除してください

  • build.settingsは、ターゲットプラットフォームとリソースに関する設定ファイルです。

  • config.luaは、プラットフォームの解像度に関する設定が記載されています。

  • main.luaは、Corona Simulatorが最初に読み込むファイルです


kwk プロジェクトファイル

.kwk ファイルはプロジェクトの情報を保持しているファイルです。レイヤーやページ,プロジェクト全体に関連づけている全てのアクションやコンポネントが含まれます。kwkファイルを任意のテキストエディターで開いてみましょう。

このXMLファイル(Markup言語)は,以下のようなルールで構成されています.インデントのある部分をchild(子)と呼びます.例えば\は\の子です.\は\の子で,さらに\は\の子です.

プロジェクトをパブリッシュする時に,Kwikは .psdファイルから、それぞれのレイヤーを画像として出力します。各レイヤーの位置情報、透明度などと設定情報をluaファイルに出力します。

ファイルパスの編集

.psdや.mp3といったファイルのパスを変更したい時が生じると思います.Kwikのデフォルトのプロジェクトフォルダーは~/Documents/Kwik/YourProjectです.もし,ドキュメントフォルダーをデスクトップに変更したい時には,.kwkを編集する必要があります.

~\Desktop\K4にプロジェクトフォルダーを設定してください

Before

  <pages>
    <page id="page1">
      <name>page1</name>
      <number>1</number>
      <file>~/Documents/Kwik/HelloWorld/page1.psd</file>
      <fileName>page1.psd</fileName>
    </page>
  </pages>

After

  <pages>
    <page id="page1">
      <name>page1</name>
      <number>1</number>
      <file>~/Desktop/K4/HelloWorld/page1.psd</file>
      <fileName>page1.psd</fileName>
    </page>
  </pages>

プロジェクトフォルダー内の他フォルダについて

以下のフォルダーがプロジェクトフォルダー内にあることが確認できると思います.これはKwikによって自動で生成されたものです.

  • backups
  • build4
  • json
  • kaboom
  • temp
  • tmplt

backupsは.kwkのバックアップファイルが格納されています。バックアップを利用したいときには、このフォルダーのファイルを kwkファイルと置き換えてください。.

jsonは、luaファイルを作成するためのjsonファイルを生成するkwikの内部用のワークフォルダです。

kaboomは、パーティクル(particle)を作成/編集するためのkwikの内部用のワークフォルダです。

tempも同様にkwikのワークファルダです。

tmpltは、kwikがluaファイルを生成する時に使用するテンプレートファイルが格納されています。tmpltフォルダーのファイルは、カスタマイズすることが可能です。Kwikがアップデートされた時,templateフォルダーはProject Properties > Update tmpltをクリックすることで、アップデートされます。以前のtmpltフォルダーは、アップデートの時にバックアップとして残ります。

Tmpltのアップデート

GitHub

KwiksherのGitHubから最新のtmpltファイルを入手することも可能です。gitを使用したい場合,以下のサイトからcloneしてください.

results matching ""

    No results matching ""