1,285
edits
Changes
Jump to navigation
Jump to search
Line 33:
Line 33: − MANIFEST (list of bundle contents) Line 40:
Line 39: − contents (manifest for bundle contents -- not supported by Sugar) − contents.sig (credentials for signed bundle -- not supported by Sugar) − permissions.info (optional; '''not a stable API''') Line 53:
Line 49: − − ;MANIFEST − − This optional file lists the files that will packaged in the .xo file. If missing, all files in the Activity directory which do not match a default ignore list are packaged. The default ignore list includes the dist and .git subdirectories, and the .gitignore, MANIFEST, *.pyc, *~, *.bak, pseudo.po files. Line 93:
Line 85: + + Line 103:
Line 97: − + Line 147:
Line 141: + + + + + + Line 199:
Line 199: − +
Development Team/Almanac/Activity Bundles (view source)
Revision as of 21:40, 17 July 2017
, 21:40, 17 July 2017no edit summary
Web.activity/
Web.activity/
activity/
activity/
activity.info (activity info file)
activity.info (activity info file)
text-plain.svg (icons for documents, e.g. "text-plain.svg" for "text/plain")
text-plain.svg (icons for documents, e.g. "text-plain.svg" for "text/plain")
text-html.svg
text-html.svg
bin/
bin/
web-activity (launcher script or activity executable)
web-activity (launcher script or activity executable)
mylib.so (native library)
mylib.so (native library)
icons/
icons/
;activity
;activity
tags = exploration;web
tags = exploration;web
single_instance = no
single_instance = no
max_participants = 4
repository = https://github.com/sugarlabs/browse-activity
A more detailed explanation of the valid properties follows:
A more detailed explanation of the valid properties follows:
activity_version = 156
activity_version = 156
: Each activity.info file must have a "activity_version" key. The version is a single positive float. Larger versions are considered "newer". The value assigned to this key should be considered '''opaque''' to the activity; the only requirement of the activity is that it must be larger for new activity builds.
: Each activity.info file must have a "activity_version" key. Example versions are 1, 1.2, 1.2.3, 1.2.3-peru, and 1.2.3~me. Larger versions are considered "newer". An activity should not use the value, as it may be changed by developers and packagers. The value must be newer for newer activities.
host_version = 1
host_version = 1
single_instance = yes
single_instance = yes
: This key is optional. If not present, or if present with a value of "no", multiple instances of the activity can be launched at once. If present with a value of "yes", then only one instance of the activity will be open at any one time. This key was added in order to flag activities that use resources that cannot be shared.
: This key is optional. If not present, or if present with a value of "no", multiple instances of the activity can be launched at once. If present with a value of "yes", then only one instance of the activity will be open at any one time. This key was added in order to flag activities that use resources that cannot be shared.
max_participants = 4
: This key is optional. If not present, or if present with a value of <=1, the activity is not shared. Otherwise, it limits the number of participants who can join a shared activity. Note that setting max_participants in activity.py is deprecated.
summary = ...
summary = ...
: A short summary of the activity is displayed in the List View.
: A short summary of the activity is displayed in the List View.
repository = https://...
: The URL of the master git repository for the activity, for use by {{code|git clone}}. Since activities are not all hosted in a single repository, it is important to include a link so that users can readily find the activity. Some git hosting services allow the URL to be used by web browser as well as {{code|git clone}}.
== Localization/translation of the activity name and tags ==
== Localization/translation of the activity name and tags ==
== activity/permissions.info ==
== activity/permissions.info ==
'''Note: the API described in this section is NOT STABLE and will probably change in future releases; perhaps drastically.'''
'''Note: the API described in this section is DEPRECATED.'''
Bitfrost describes a variety of security-related settings which activity authors can specify about their activity. At the option of the activity author, these settings can be described in a file called 'permissions.info' which can be placed alongside 'activity.info' in the 'activity' directory of the bundle.
Bitfrost describes a variety of security-related settings which activity authors can specify about their activity. At the option of the activity author, these settings can be described in a file called 'permissions.info' which can be placed alongside 'activity.info' in the 'activity' directory of the bundle.