https://github.com/artcom/asset-generator

Generate assets based on a configuration file
https://github.com/artcom/asset-generator

Last synced: about 1 month ago
JSON representation

Generate assets based on a configuration file

• Host: GitHub
• URL: https://github.com/artcom/asset-generator
• Owner: artcom
• License: mit
• Created: 2023-02-21T08:15:37.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T13:31:07.000Z (9 months ago)
• Last Synced: 2024-11-07T06:36:20.351Z (3 months ago)
• Language: JavaScript
• Size: 50.8 KB
• Stars: 0
• Watchers: 11
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Asset Generator

This is a command-line tool for generating custom assets. The tool uses the [ffmpeg](https://www.ffmpeg.org/) and [ImageMagick](https://imagemagick.org/index.php) libraries to generate MP4 and WebM video files with text overlays.

## Requirements

You need to have [Node.js](https://nodejs.org/en/) installed on your computer. You can check if you have Node.js installed by running the command `node -v` in your terminal. If you don't have Node.js installed, you can download it from the [Node.js website](https://nodejs.org/en/).

You need to have magick and ffmpeg installed on your computer. You can check if you have them installed by running the command `magick -version` and `ffmpeg -version` in your terminal. If you don't have them installed, you can download them from the [ImageMagick website](https://imagemagick.org/index.php) and the [ffmpeg website](https://www.ffmpeg.org/). You can also install them using [Homebrew](https://brew.sh/) on macOS.

## Installation

Clone this repository: `git clone https://github.com/artcom/asset-generator`

Install the dependencies: `npm install`

## Usage

To use the tool, you need to create a JSON file that describes your asset collections and options. Here's an example:

```

json

Copy code

{

  "assetCollections": [

    {

      "folder": "collection-1",

      "pngs": [

        { "name": "image-1", "size": "large", "transparent": true },

        { "name": "image-2", "size": "medium" },

        { "name": "image-3", "size": "small", "transparent": true }

      ],

      "mp4s": [

        { "name": "video-1", "size": "large" },

        { "name": "video-2", "size": "medium" }

      ]

    },

    {

      "folder": "collection-2",

      "pngs": [

        { "name": "image-4", "size": "small" },

        { "name": "image-5", "size": "medium" }

      ],

      "mp4s": [

        { "name": "video-3", "size": "large" }

      ]

    }

  ],

  "sizes": {

    "small": { "width": 320, "height": 240 },

    "medium": { "width": 640, "height": 480 },

    "large": { "width": 1280, "height": 720 }

  },

  "options": {

    "parentFolder": "assets",

    "globalPrefix": "My Company\n"

  }

}

```

Save this file as config.json.

To generate the assets, run the command `node generateAssets.js ./config.json.` This will generate a set of PNG and video files in the assets directory. Otherwise you can run `npm start` to generate the assets.

## Customization

You can customize the tool by editing the generateAssets.js file. Here are some things you can do:

Change the font size and color of the text overlay in the generatePng and generateTransparentPng functions.

Change the duration and transition of the video fade effect in the generateMp4 function.

Add support for other video formats (e.g. AVI, MOV) by modifying the generateMp4 and generateWebM functions.

Change the output directory by modifying the ASSET_PATH variable.

## License

This project is licensed under the MIT License. See the LICENSE file for details.