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



Search | Go
Wiki > Main > WpsGallery (r297)

The WPS Gallery


What is the WPS Gallery?

The WPS (While Playing Screen) Gallery is a testament to the creativity of many of the people who have visited and participated in the Rockbox site. This is the result of their desire to make their player look the way they want it to, and to share that vision with others Please note that some of these themes require custom builds which are not supported by the Rockbox team or may be out of date and not appear as intended.

There are guides to creating your own WPS here and here, and a guide to uploading your completed WPS here.


WPS Galleries (model-specific)

The WPS Gallery has been split into different pages for each model, which can be accessed with the following links:

WPS Graveyards (model-specific)

The WPS Galleries have been cleared of all WPSs without licenses permitting modification. No uploads to the graveyards are accepted, but you are welcome to license and move your theme.


WPS Upload Guide

Please do not upload themes to these pages. Use the Rockbox Theme site instead

PLEASE DO NOT UPLOAD CONTENT FOR WHICH YOU DO NOT OWN THE COPYRIGHT
Any copyrighted content will be removed. We will also honour any requests from copyright owners to remove copyrighted materials we might have missed. Perhaps a different, suitably licensed image might work as a replacement. See the FreeImages page for some links to sources of images with open licenses.

This is a guide for posting your own WPS creations in the galleries, it will walk you through the steps required to get your WPS shared with the Rockbox community. Please read the ThemeGuidelines page before getting started. For an example of what the final product will look like if it's done properly, click here.


0) SIGN IN/REGISTER

If you have not registered with the Rockbox Wiki yet, you need to do so in order to contribute to the WPS Gallery. Click here to register, and be sure to take note of the second step.

If you have registered already, and took note of the second step when you did, you're ready for step 1.


1) PACKAGE YOUR FILES

If your WPS is simply a .WPS file and does not involve any extra files (i.e. images, fonts, icons, etc.), you can skip to step 2.

A .ZIP file of your WPS and all its associated files needs to be created. Here's what you do:

  1. Create a folder called ".rockbox" (note the . at the start)
  2. Inside that folder make another called "WPS". Inside this folder is where you put your WPS files.
  3. Your WPS file with the ".WPS" extension that contains all the code should go in here.
  4. Any pictures or WPS backgrounds need to be in a folder with the exact same name as the .WPS without the extension. (eg: test.WPS would have a folder named "test") This folder should be placed in the "WPS" folder.
  5. If you are including a theme file you need to place it in a folder called "themes" and place the folder inside of the ".rockbox" folder.
  6. If you are including a menu background you need to place it in a "backdrops" folder inside of the ".rockbox" folder.
  7. The same goes for a font that isn't part of the font package. Put it in a folder called "fonts" inside of the ".rockbox" folder.
  8. If you are NOT including a menu background then the null background line must be included in your theme file. (eg: "backdrop:" )
  9. You can now create a zip file of the .rockbox folder using a program like 7-Zip, WinZip, WinRar or anything else that can get the job done.

If theme files, menu backgrounds, fonts, and so on are required by your WPS but aren't included they will not display properly for others and they will think you are a very bad artist.


2) TAKE SCREENSHOTS

You must include a screenshot of your WPS to display on the page so that people can see what they're downloading before expending precious time and bandwidth. Your screenshot should be displayed at the native resolution of your target device. Please do not upload oversized "screenshots". If your WPS changes the appearance of the menu as well, you might as well grab an image of that, too. There are two ways to obtain screenshots:

  1. Use a simulator and take a screenshot using F5 or 0 (zero). It will be saved in the "archos" directory.
  2. Use the screendump option on the player itself. To enable the screendump, select Menu->Info->Debug (keep out) ->Screendump. Then connect the player via USB and an image of the screen will be "dumped" to the root directory of the Rockbox unit instead of connecting to your computer. If the unit has RTC (real-time clock), the files are named "YYYY-MM-DD HH-MM-SS.bmp" (YYYY=year, MM=month, DD=day, HH=hour, MM=minute, SS=second). Otherwise, they are numbered sequentally, dump_0001.bmp etc. To disable the screendump afterwards, select it again in the Debug menu.

It is requested that you convert the images to .PNG files before uploading because .BMPs cause bigger files, are sometimes blurry, and are not supported by all browsers.


3) CHECK YOUR WORK

  1. Ensure your new theme complies with the ThemeGuidelines.


4) UPLOAD YOUR FILES

  1. Upload all files and screenshots to the wiki itself. We do not want any off-site hosting used!
  2. Go to the WPS Gallery for the player your WPS is designed for (links at the top of this page). You probably want to open it in a new tab or window so you can continue to follow the guide.
  3. Scroll to the bottom of the page and click "Attach".
  4. At the bottom of the page in the "Attach new file" section click the Browse button and find the files you have created (.WPS, .ZIP, .PNG).
  5. Add a brief description for each file in the "Comment:" textfield.
  6. Check the "Hide File" box. This does not hide the file itself but stops it from automatically being displayed at the bottom of the gallery and making a mess of it.
  7. Click "Upload file".
  8. Repeat if you have more than one file to upload.

If the WPS does not need any images or files to be inculded, uploading a .ZIP file is not necessary as you can just attach the .WPS file.


5) POST IT!

Once you've uploaded all of the necessary files, return to the WPS Gallery page, scroll to the bottom, and click "Edit". If you followed step 0 correctly, the page editor window should pop up.

Now, being the kind, selfless person you are, you're going to put your WPS after everyone else's (how nice!) OR if you see the gallery in alphabetical order, keep it that way. Scroll down to the bottom of the code and hopefully the last line will be three dashes (---). This indicates a line break separating the previous WPS on the page from what will soon be yours. The basic template for a post looks like something like this:


---
---++ClockedWcab Theme Collection

<img src="%ATTACHURLPATH%/ClockedWcabAqua.png" alt="ClockedWcabAqua.png"  width="176" height="220"  />
<img src="%ATTACHURLPATH%/ClockedWcabBlue.png" alt="ClockedWcabBlue.png"  width="176" height="220"  />
<img src="%ATTACHURLPATH%/ClockedWcabBlueDk.png" alt="ClockedWcabBlueDk.png"  width="176" height="220"  />
<img src="%ATTACHURLPATH%/ClockedWcabGreen.png" alt="ClockedWcabGreen.png"  width="176" height="220"  />
<img src="%ATTACHURLPATH%/ClockedWcabGreenLt.png" alt="ClockedWcabGreenLt.png"  width="176" height="220"  />
<img src="%ATTACHURLPATH%/ClockedWcabGrey.png" alt="ClockedWcabGrey.png"  width="176" height="220"  />
<img src="%ATTACHURLPATH%/ClockedWcabOEM.png" alt="ClockedWcabOEM.png"  width="176" height="220"  />
<img src="%ATTACHURLPATH%/ClockedWcabOrange.png" alt="ClockedWcabOrange.png"  width="176" height="220"  />
<img src="%ATTACHURLPATH%/ClockedWcabPink.png" alt="ClockedWcabPink.png"  width="176" height="220"  />
<img src="%ATTACHURLPATH%/ClockedWcabPurple.png" alt="ClockedWcabPurple.png"  width="176" height="220"  />
<img src="%ATTACHURLPATH%/ClockedWcabRed.png" alt="ClockedWcabRed.png"  width="176" height="220"  />
<img src="%ATTACHURLPATH%/ClockedWcabRedDk.png" alt="ClockedWcabRedDk.png"  width="176" height="220"  />
<img src="%ATTACHURLPATH%/ClockedWcabYellow.png" alt="ClockedWcabYellow.png"  width="176" height="220"  />

Download: [[%ATTACHURL%/ClockedWcab.zip][Zip file contains all versions of the theme.]]

This collection of themes is based on the Widecabbie theme. 
   * The Colors have been changed.
   * A variety of colors are available.
   * A clock display has been added.  When the sleep timer is set the clock display will alternate between the time and the remaining time on the sleep timer
   * Themes use the same Icon set and font as Widecabbie and are licensed under the same license.

-- Main.PatWilborn - 09 Mar 2009
---

Where everything inside circular brackets (like this) is something you need to change. Remove the brackets and the text between when entering your info but leave the rest untouched. The width and height ("x" and "y") can be found from your picture's properties or you can just look further up in the code and see what other people have put for the dimensions. If you're on the right page, they should be the same as yours. (This is generally a good trick if you run into problems. Plagiarism is the highest form of flattery, right?)

Now preview the page, making sure everything's looking good and proper (no attachments lingering at the bottom of the page, no broken code uglying up the place, your screenshots shining like diamonds). Once you approve of what you see, scroll to the bottom and click "Save Changes".

You have now uploaded your WPS for the world to see. Well done! Now get cracking on your next one!
Edit | Attach | Print version | History: r298 < r297 < r296 < r295 | Backlinks | View wiki text | More topic actions...
r297 - 24 Mar 2009 - 23:01:54 - JonasHaeggqvist
Copyright by the contributing authors.