PACKAGE_DESC.txt

Package information.

PACKAGE_DESC.txt is a configuration file that should be included at the top directory of a dialog context. It sets some contents-dependent properties.

A simple example of PACKAGE_DESC.txt is as follows. It specifies that content will be displayed on menu with “My Contents” as text label and “banner.png” as its image. The full text written in README.txt in the content will be displayed at the first time (and after-update) launch of this content. A file start.mdf will be launched by MMDAgent-EX on startup. Additionaly, since readmeForceAgreement=true is specified, users are asked to press either “Accept” or “Decline” when the document is displayed at start up, and can play this content only if “Accept” is pressed.

label=My Contents
image=banner.png
execMDFFile=start.mdf
readme=README.txt
readmeForceAgreement=true

Common options

These settings are valid for all types of dialogue content. (local, mmda and web)

label=string

Text label of this content to be displayed at the contents menu and history. If not specified, the package file name will be applied instead. If set to blank (just label= only), no label will be displayed on the menu.

(moved from web to common at 2019/7/5)

image=img_path

Specify menu’s background image file of this content. The image aspect ratio should be 7:1. If not, the image will be stretched to fit the menu item on the screen.

If not specified, MMDAgent tries to use “banner.png” at the same directory of MDF file. If it is not found, no image will be applied.

(moved from web to common at 2019/7/5)

readme=text_file

Display a text file at the first stage of content launch, and wait till user press button to proceed.

readmeForceAgreement=true or false

Force users to accept some conditions written in the readme file before playing the content. If this is set to true, when displaying a text file specified by readme, two buttons “Accept” and “Decline” will be shown instead of “OK” at the bottom of the page, and when “Decline” was selected by user, the content will not be played. Default is false.

logUploadURL=url_string

Specify a server URL to send log files. This content’s logs between LOG_START message and LOG_FINISH message are stored in the local device, and will be sent to the specified server when LOG_UPLOAD message is issued. Default is none.

logUploadHTTPVersion=STRING

Specify HTTP protocol name used to send this content’s log. You can change it to any string such as “HTTP/1.0”. Default is “HTTP/1.1”.

logSpeechInput=true or false

Enable or disable audio input logging at this content. When enabled, input audio triggered by Julius are also saved and will be sent to server together when the text log is sent. Maximum amount is set to 20 MB, i.e. about 15 minutes of audio data. Default is false (disabled).

logIdentifier=string

A string that identifies this content. This string will be embedded to the log. Set a unique string to distinguish logs among contents or among versions. Specify both name and version is recommended, like this: “logIdentifier=contentName_v1.1”.

kafkaBroker=host:port

Broker address for Apache Kafka logging.

kafkaPartition=partition_number

Partition number of the broker to connect.

kafkaProducerTopic=topic_string

Producer name to connect. When this option is specified, the app will connect to the Kafka server as “producer” at startup, and start sending all logs to the topic channel at real time.

The app can be either producer or consumer, but not both. Do not specify both KafkaProducerTopic and KafkaConsumerTopic.

kafkaConsumerTopic=topic_string

Consumer name to connect. When this option is specified, the app will connect to the Kafka server as “consumer” at content startup, and start receiving feeded messages from the topic channel and processing them at real time.

The app can act either producer or consumer, but not both. Do not specify both KafkaProducerTopic and KafkaConsumerTopic.

kafkaCodec=codec_string

Compression codec.

Web-specific options

The following settings are valid for web-based contents only. They are invalid for .mmda and local contents.

execMDFFile=some/where/foobar.mdf

Specify which .mdf file to run. If not specified, all the “*.mdf” file included in the content are searched and the one in the deepest folder will be used.

sticky=true

Make this content “sticky”. At app restart, a sticky content will keep playing, whereas non-sticky content will ends and default content will start.

nonBrowse=true

Inhibit users to browse inside this content by internal file browser. A user on desktop OS still can see the content files by system browser.

nonDesktop=true

Inhibit playing this content on desktop OS (win/mac/linux) and allow to play only for smart devices (iOS/Android).

autoUpdatePeriod=20

check for updates periodically while playing at the specified period. The files to be checked should be specified by autoUpdateFiles. Application will poll the server by the given interval to check for updates, and download them if the server’s file is newer than local. This feature can be used to push contents from server to client automatically.

autoUpdateFiles=xxx.mdf[,xxx.fst,…]

A list of files in this content to be updated periodically. Use with autoUpdatePeriod.


Last modified May 4, 2020: Reorganizing en doc (fbca242)