The Guide to Creating Your Accomplishments

Creating .accomplishment files

<-- Previous page (The theory behind Accomplishments) - - - - - Next page (blah) --->

Introduction

As you should already know .accomplishment files are crucial for the Accomplishment. This is where all essential data about accomplishment is provided.

Technically, an .accomplishment file is a KeyFile containing of one group "accomplishment" and a bunch of values.

In practice, this means that .accomplishment files have following structure (This is not a working example, but a demonstration of syntax):

[accomplishment]
key = value
another_key = different value
title = My Accomplishment
multiline_key = This value is
    spread through
    multiple lines.
one_more_key: value

Note that both '=' sign and ':' can be used.

Fields

There is a number of important fields you need to include in your accomplishment field. These include:

• title - The name of your accomplishment. It must be human readable. Use something unique, extinguishable, or fancy.

• description - Single line of summary, that briefly explains what this accomplishment represents.

• application - This is the set that the accomplishment is part of (e.g. 'ubuntu-community' for the Ubuntu Community Accomplishments set).

• category - The category this accomplishments belongs to.

  • If you are contributing accomplishments to an existing collection, make sure to reuse existing categories.
  • As for now, you can specify only one category. In future, more than one will be allowed.

• icon - The icon used for this trophy. Use just file name.

  • The icon is provided with accomplishments set, in a directory that is destined to keep all icons you use in or set. More details concerning icons are in one of the next chapters.

• depends - [optional] This field is used to specify dependency. If the user has to accomplish something else to unlock this accomplishment, specify it here, providing the accomplishment's set and name, using format <set>/<name> e.g. ubuntu-community/filed-first-bug.

  • You can specify only one dependency. Maybe in future more will be allowed.
• ...

This page is under construction. This guide is not yet complete!