release
dev builds
extras
themes manual
wiki
device status forums
mailing lists
IRC bugs
patches
dev guide



Search | Go
Wiki > Main > DocsIndex > SubmitWPS (r2)

Submitting your WPS for inclusion in Rockbox

If you would like to share a customised WPS you have designed with others, then you can submit it to the Rockbox project for inclusion in the Rockbox distribution.

How to submit your WPS

If your WPS contains images it should be submitted as a ZIP file containing the WPS file and the image directory. So, example.zip might contain
example.wps
example/graphic1.bmp
example/graphic2.bmp

If your WPS is a single file, it may be submitted as is.

This file should be uploaded to the Rockbox patch tracker with category set to WPS. When submitting, please follow the guidelines below:

WPSes submitted for inclusion in Rockbox must be:

  1. Submitted by (or with the permission of) the original author
  2. Licensed under the GPL
  3. Contain only images that are the intellectual property of the author or of the Rockbox project, or are licensed under a GPL compatible license.
  4. Tags for the track title, album and artist should be encoded in such a way that they fall back to the file name (%fn), the name of the directory immediately above (%d1), and the directory immediately above that (%d2) respectively i.e.

    %?it<%it|%fn>
    %?id<%id|%d1>
    %?ia<%ia|%d2>

    or variants.

  5. Must include the following information in the text submitted with your patch (NOT just inside the ZIP file):

    # Name of the WPS (_including_ .wps extension)
    Name:
    # Real name of the creator of the WPS
    Author:
    # Preferred font (including .fnt extension - leave blank for player):
    Font:
    # Whether the WPS is designed to have the statusbar on or off
    Statusbar:
    # The minimum required pixel height for the WPS
    #  176 for H3xx, 128 for H1xx, 64 for Recorder/Ondio, 14 for player
    Height:
    # The minimum required pixel width for the WPS (160 for iRiver,
    #  220 for H3xx, 160 for H1xx, 112 for Recorder/Ondio, 55 for player
    Width:

    Also a link to a screen capture of the WPS (can be from the simulator).

  6. Must contain a statement that the submitter has read and complied with the guidelines for WPS files laid out at http://www.rockbox.org/twiki/bin/view/Main/SubmitWPS.

Please note that patches not conforming to these guidelines are unlikely to be processed.
Edit | Attach | Print version | History: r5 | r4 < r3 < r2 < r1 | Backlinks | View wiki text | More topic actions...
r2 - 04 Mar 2006 - 15:43:53 - DaveWiard?

Parents: DocsIndex
Copyright by the contributing authors.