How to Contribute a Script

From PlayOnLinux
Jump to: navigation, search

So, you have a script that you want to submit to PlayOnLinux?

There are a few things that should be followed, as far as our standards for icons, resources for install scripts, posting here for help or submitting to us for publication, and info that make this process more standardized.

Static Checks

Even before running your script, you can test it for common (or not so common) mistakes using static analysers:

  • detects Bash scripting issues; It's not PlayOnLinux specific, but since PlayOnLinux scripts are a special case of Bash scripts, it can still be very useful;
  • git clone the PlayOnLinux Tools repository then run '' (from the PlayOnLinux_ScriptChecker subdirectory) on your script; That one will detect several PlayOnLinux mistakes, specially deprecated style issues.

Testing, testing, testing

It is very important that you test your scripts thoroughly before trying to contribute them to the actual system. Although, please do feel free to post your script in the forum if you need help or want a review of it. Scripts that obviously have not been tested (because of spelling/syntax errors, non-existent Wine versions, etc..) will not be accepted and will be deleted from the contribution section, requesting that the author post in the forums for help correcting the script.

For instance, if your script has a WINEVERSION set to, say "4.2.3", it is apparent that the script was never tested to work correctly, because that Wine version does not exist. Things like this will result in deletion of the Script Contribution entry, and you will be requested to post in the forums to get the script set up correctly.

Content of your posts in the forum (Your Creations section)

Please use the following tips to help make the posts here more standardized:

  • Make the title of your post something like:
[Script] name of script
  • Post the following information in your post in this order:
  1. Description of the program (just a basic rundown of what it does)
  2. Anything you had to do or install OUTSIDE of Wine or PlayOnLinux to make it work
  3. Any extra notes about installation, or errors that it throws (if any)
  4. Contents of script

Text style: to display the right text style for your script, select it then in the forum editor click the button 'Styles', then select 'Code Playonlinux'.

Screenshot requirements

When submitting a screenshot, post them in your original post, reply to your own post with either the link to your screenshots, or just paste the screenshots into the post (we can download them and upload to our server.).

Also, do not submit screenshots with your background or desktop. Full-screen, program-only screenshots, unless you are posting the screenshots for troubleshooting of a related issue. What this means:

  • Make sure that you are only taking a screenshot of the program related to this script.
  • Window decorations are OK, as long as the program is the main feature of the picture.
  • No lewd, pornographic, or otherwise controversial screenshots of ANYTHING (this will result in negative action without question.).
  • Be sure to take screenshots of the game ACTUALLY running; no install shots.
  • Though 1 screenshot works, we prefer 2. 3 is what we really like to see.
  • Legible, fairly hi-def shots; no fuzzy text, not stretched/smashed, not distorted.

Icons and install resources

So, there are 4 different icons and pictures that are desired for the script. They are listed as follows with their EXACT dimensions and file type requirements:

Do not forget to add the file extension to the name.

The icon that will be used for the installed program:

  • Name: nameofprogram-48x48
  • File Type: PNG, JPEG
  • Size: 48x48

The icon that will be used in the PlayOnLinux script list and the site:

  • Name: nameofprogram-22x22
  • File Type: PNG, JPEG
  • Size: 22x22

Sideways banner that is on the left side of the first window when script is ran:

  • Name: left.jpg (or left.png)
  • File Type: PNG, JPEG
  • Size: 150x356 (W x H)

Top corner Icon for install script:

  • Name: top.jpg (or top.png)
  • File Type: PNG, JPEG
  • Size: 64x64 (W x H)

What to do after you have tested your script

Step 1

After you have had your script on the forum, and its been verified to work, and the script is effective, clean, and portable, then submit in the following fashion:

  1. Go to PlayOnLinux or PlayOnMac
  2. Click Supported Software
  3. Click Add a program
  4. Enter the name of the script you want to publish (ie: the exact name of the software)
  5. Fill out the form as completely as you can (not the script yet, and not the screenshots)
  6. After your submit that, click the text link Click here to see it
  7. When you return to your page, click the Contribute button
  8. Enter in a description, and below the description form, click I want to submit an improvement
  9. Copy/paste your script in that field, and click Send

Details about the check boxes

  • PlayOnMac compatible ? : can this script work on OS X ?
  • PlayOnLinux compatible ? : can this script work on a GNU/Linux distribution ?
  • PlayOnLinux testing? : optional, is this script 100% working and reliable, or is it perhaps unstable (testing) ?
  • PlayOnMac testing? : same as above.
  • Free to play? : is this software available for free (officially) ?
  • No-CD needed? : is a crack needed ? (to pass the anticopy protection)

Step 2

Now your script is awaiting approval. A staff member will look at the script and either:

  • It will be approved, and will be then available in the POL/POM Install menu
  • It will need improvements, which the staff member will inform you. Then you will have to use the Contribute button to submit a new version of the script.
    Note: The next improvement required is usually Chapter 9: Standardization.
  • Or your script will be deleted because it is empty, spam, a help request, or something else not related to that section.

After some weeks without feedback, you may post a request in the forum.