.. highlight:: xml

=========================
Package description files
=========================

The package description files are written in XML. Thus you can edit them with any text editor. But an editor with syntax highlighting is recommended.

The root element of every description is `mod`::

    <mod>
        ...
    </mod>

In the root element can contain the following elements:

* name -- Name of the package(required):: 

    <name>MyMod</name>

* author -- Name of the author(required)::

    <author>Nobody</author>

* version -- Version of the package(required)::

    <version>1.2.0</version>

* revision -- Revision of the description file(increment after edit by one)::

    <revision>3</revision>

* mcversion -- Version of Minecraft, for which the package is made for(required)::

    <mcversion>1.1.0</mcversion>

* shortdesc -- Short description of the package(optional)::

    <shortdesc>This is doing something cool</shortdesc>

* description -- Long description of the package(optional)::

    <description>This is doing this and that. It can also do ...</description>

* dependencies -- List of dependencies. Can contain zero or more `dependency` elements(required)
    * dependency -- Name of a dependency(optional)::

        <dependencies>
            <dependency>...</dependency>
        </dependencies>

* downloads -- List of downloads(required)
    * download -- URL of the download. Specify target name with attribute `name` and in case the user has to download the file, use the `user` attribute::

        <downloads>
            <download name="mod.zip" user="true">http://adf.ly/...</download>
        </downloads>

* install -- List of instructions to install the package(required)
    * descr -- Description of one step. Set the type using the `type` attribute(The types are listed at :ref:`install-desc`)::

        <install>
            <descr type="...">
                ...
            </descr>
        </install>

.. _install-desc:

Install Descriptions
--------------------

Currently there are the following types:

* source2jar -- Copies files from a source to the minecraft.jar. Fields:
    * source -- The source
    * from -- File/Folder to copy. Leave empty to copy everything in the source.
    * to -- Where to place them. Leave it empty to copy it to the root directory.

    ::

        <descr type="source2jar">
            <source>somesource</source>
            <from></from>
            <to></to>
        </descr>

* zip2source -- Creates a source from a zip files contained in another source
    * source -- The source
    * from -- The zip file
    * target -- The name of the source to create

    ::

        <descr type="zip2source">
            <source>somes</source>
            <from>folder/Core.zip</from>
            <target>core</target>
        </descr>

* download2source -- Creates an source from an downloaded file
    * download -- The filename of the download
    * target -- The name of the source to create

    ::

        <descr type="download2source">
            <download>mymod.zip</download>
            <target>MyMod</target>
        </descr>