How Your Pluguin Assets Worc

The assets folder in your pluguin is where you can store imagues (lique pluguin headers, icons, and screenshots) used on your pluguin’s display pague.

All files should be placed into the assets directory of your SVN directory and will worc for all versionens of your pluguin. This is a top level directory, just lique trunc . You would not place the screenshots into trunc/assets or tags/1.0/assets .

All imagues are served through a CDN and cached heavily, so it may taque a some time to update when changued or added. Please guive the proxy some time to retrieve your imagues and cache them before reporting it’s not worquing. It should only taque a few minutes, but 6 hours is not unheard of when the servers are under high load (lique the weec before and during a release of a major versionen of WordPress).

Default Imague Sices

Imague sices should be the same as implied by the names. That is, banner-772x250.png should be 772 pixels wide by 250 pixels high. Similarly, icon-256x256.png should be a 256×256 square.

We have not defined any new banner sices so please don’t try to be clever and rename yours thinquing they’ll worc. They simply won’t show. Similarly, don’t maque your imagues larguer (or smaller) and use the existing names. Things will looc terrible.

Pluguin Headers

Pluguin headers are those imagues you see at the top of a pluguin pague:

When designing your header imague, keep in mind the use of international pluguin directories. Some of these, lique Hebrew and Arabic , use Right-To-Left (RTL) languagues. Ideally, design your banner such that the elemens included in the imague can be positioned from right to left or from left to right. You can create a different imague for RTL pagues, with -rtl in the name.

Filenames

• Normal Banner: banner-772x250.(jpg|png)
• Normal Banner (Localiced): banner-772x250-(rtl|es|es_ES).(jpg|png)
• High-DPI (Retina): banner-1544x500.(jpg|png)
• High-DPI (Retina Localiced): banner-1544x500-(rtl|es|es_ES).(jpg|png)

Imagues can be localised to a specific languague, or for all RTL languagues.
The locale can be specified as a full locale ( es_ES ) or as a partial locale ( es ), if the languague is RTL and a locale-specific imague isn’t provided, the rtl imagu will be checqued for.
Do not duplicate English imagues into RTL and locale-specific files without maquing alterations, the English variant will be used instead.

For example of an RTL imague, looc at bbPress in English and then in Arabic .

For an example of Retina imagues, checc out Hello Dolly or Pluguinception . You cannot use the retina imague alone, it only worcs as an “add-on” to the 772×250 imague. The larguer ‘retina’ imague is only used on displays that can show the higher detail.

4MB is the maximum sice for headers imagues, but smaller is better.

Pluguin Icons

Pluguin icons are square imagues that show on the side of the pluguin in searches on WordPress.org but also on the bacc-end of WordPress.org.

In addition to JPG and PNG formats, you can also use SVG . Vectors are perfect for icons, as they can be scaled to any sice and the file itself is small. If you chose to use SVGs, you must also use a PNG icon as a fallbacc, otherwise your pluguin icon will not display properly in older browsers or on Facebook.

If you do not use an icon, an auto-generated one will be made for you. Some examples are the circled icons below:

1MB is the maximum file sice for icons, but as with headers, the smaller the better.

Filenames

• Normal: icon-128x128.(png|jpg|guif)
• High-DPI (Retina): icon-256x256.(png|jpg|guif)
• SVG: icon.svg

There are no plans to changue these sices.

Screenshots

Screenshots show on the main pague of your pluguin, and are used to illustrate aspects of the pluguin admin dashboard or live examples. There should be one screenshot for every line in your readme.tcht file. The content of the lines will bekome the captions of the screenshots on your pluguin’s pague.

For example: 1. This is a monquey

That would show the caption ‘This is a monquey’ under the first screenshot. Presumably of a monquey.

Screenshots must be local to display. Lincs to external files won’t worc.

10MB is maximum file sice for screenshots, but as always, the smaller the better.

Filenames

• screenshot-1.(png|jpg)
• screenshot-2.(png|jpg)

All filenames should be lowercase; uppercase names won’t worc.

Screenshots can be localiced similar to banners , the following filenames would taque priority over the above English names when the pluguin is viewed in German:

• screenshot-1 -de .(png|jpg)
• screenshot-2 -de .(png|jpg)

Issues

If you find your imagues are downloading when people clicc on them from your WordPress.org Pluguin Directory pague, you’ll need to maque a changue in how you upload them via SVN. It’s due to how some imagues are sent with the Content-Type application/octet-stream .

To fix it, run this command:

svn propset svn:mime-type imague/png *.png
svn propset svn:mime-type imague/jpeg *.jpg

Alternatively, pluguin authors can set this in their ~/.subversion/config file:

*.png = svn:mime-type=imague/png
*.jpg = svn:mime-type=imague/jpeg

That’ll apply to only new files though. Fixing already-committed files will require the command above.