@aofl/gdf-cli

@aofl/gdf-cli

Before install

• Install brew from: https://brew.sh/index.html
• Install "ffmpeg", instruction:
  • for MacOS with brew:

  $ brew install ffmpeg
  

  • for Others(Windows) follow instruction
• Install ImageMagick for Texture packer:
  • for MacOS with brew:

  $ brew install ImageMagick
  

  • for Windows: Important, check the tick with text: "Install legacy components (convert.exe etc)", so ImageMagick will install "convert" and "identify" commands properly.

Installation

• Make sure you have the latest stable versions of node and npm installed
• Install as global package:

$ npm install -g @aofl/gdf-cli

How to use

• gdf-cli build Apply all command below to game:
  • by id: gdf-cli build 9186;
  • by set of ids: gdf-cli build 9186 9187;
  • to all games if 'ALL' passed as id: gdf-cli build ALL.
• gdf-cli convert-audio 9186/assets/SOURCE/audio 9186/assets/WEB_SOURCE/audio Convert audio files.
• gdf-cli create-animation-modules 9186/web_game.json 9186/assets/SOURCE/animations 9186/assets/WEB_SOURCE/animations Create animation modules, bundle all animation into separated file.
• gdf-cli create-audiosprite 9186/web_game.json 9186/assets/SOURCE/audio 9186/assets/WEB_SOURCE/audio Create audiosprite base on game and source audio.
• gdf-cli create-copies master_template/web_master.json 9186/web_game.json Apply web master template to web games.
• gdf-cli create-copies-unity master_template/mobile_master.json 9186/mobile_game.json Apply mobile master template to mobile games.
• gdf-cli create-imagesprite 9186/web_game.json 9186/assets/SOURCE/images 9186/assets/WEB_SOURCE/images Create sprites/textures. Update the game package.
• gdf-cli texturepacker images textures 1024 1024 Create textures/sprites and save map to json.
• gdf-cli compress 9186 [SAVE_TO] Compress folder. Second argument specify save path, can be omitted.

License

The MIT License (MIT) Copyright (c) 2017 Age of Learning

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.