App Catalog

What you will find here

This documentation page is about App Catalog, a service that is part of PatchKit. Here you will find the idea behind the App Catalog and how it can be used from the administrator and developer’s side.

What is App Catalog?

App Catalog is a service that collects many PatchKit applications into a single, browsable entity (a catalog), with extra information like descriptions, screenshots, videos, prices, etc. The idea behind the App Catalog was to create a way to build an application collection that is eligible to use as a database of an online application store. App Catalog is a requirement for the PatchKit Multi-Launcher.

App Catalog pre-requirements

App Catalog is accessible from the main menu from the panel. If you don’t see App Catalog entry on your panel, please contact the support.

Creating App Catalog

To create a new App Catalog, navigate to the App Catalog page on your panel and then, click on the New App Catalog button. On the next form, choose the App Catalog name and click on the Create button. The name is only for internal use and won’t be shared publicly.

Applications

Creating a new application

To create a new application, click on the New Application button on the Applications tab of your App Catalog. You will be asked to choose Name (internal) and Display name. When done, click on the Create button.

Your newly created application has the visibility set to hidden by default. It means that you can take your time working on it and publish it only when everything is set up correctly.

Managing settings

Your application consists of multiple settings under the General Settings tab. Most of the fields are self-explanatory, like Icon or Long Description, but some others not.

Visibility setting

Visibility decides if and how this application information can be accessed. There are three visibility options:

  • Hidden - The application is not visible to anyone.
  • Private - The application is not listed in the application list but can be fetched by the id.
  • Public - The application is listed on the application list.

Platforms setting

Here you can manage application platforms. By default, PatchKit applications are single-platform only. When it comes to the App Catalog, it makes sense that the same application built for multiple platforms can be displayed as a single entity.

Click on the corresponding Set up button next to the platform name to set up a platform. Here, you will be asked to select an existing PatchKit application from the list or to create a new PatchKit application. If you make any mistakes, you can easily remove the association from the same screen.

Managing screenshot & videos

On the application view, you can switch to the Screenshot & Videos tab. From there, you can upload a new screenshot using the New Screenshot button or a new video with the New Video button.

Screenshot requirements

App Catalog does not force any pre-requirements on the screenshots you’re uploading. Being said, you have to be careful with your uploads not to cripple the user experience. We recommend uploading optimized PNG files for application screenshots with the limited color palette or optimized JPG files for games and screenshots with many colors (like photographs).

Video requirements

App Catalog does not store videos on its own. Instead, it stores the information about videos location. Therefore, by adding a video, you must pass a video URL. Please note that if you want to use PatchKit Multi-Launcher, it must support the video source. Currently, YouTube videos are supported as a source. If you wish to use a different source, please contact the support.

Managing news & articles

On the application view, you can switch to the News & Articles tab. From there, you can create new articles that will be stored within your application entity.

The article will be served from the database as-is. This means that App Catalog does not transform the provided text when provided through the API. Being said, fields like Body Format are only a piece of the additional information passed through the API that may or may not be used to transform the text correctly.

Did this page help you? If you have any questions, please use the chatbox on the bottom-right or use our contact form.

Copyright © 2015 - 2022 Upsoft
All Rights Reserved.