app /wiki

5Kapp/edit/

A competition to create an application using only 5K (5120 bytes) of code and resources.

##Motivation##

5K is pretty small.  It's about enough to show an idea.  Working the constraint will require some creative thinking.  With a 5K app [you ain't gonna need it](http://en.wikipedia.org/wiki/You_Ain%27t_Gonna_Need_It), so you're forced to really pare down your app to make it just do what it's meant to do.  It also shouldn't take long to write a 5K app, so it's a great way to try some experimental ideas out.

##The Rules##

* 5K is the total size of the executable app + resources:
    * The app must consist of a single "executable file" + resources below the size limit.
    * Where possible resources should be embedded in the "executable file", but it's ok to have some of them separate if that makes life easier (e.g. with html and gifs).
    * The "executable file" may be, for example, a .jar file, .swf, html file (with embedded Javascript), Python, Perl, Ruby or PHP script (basically whatever makes sense as the "standard" distribution mechanism).
    * The "executable file" must be runnable "as is", without requiring an installation or decompressing step by the user (so self-extracting is ok, if the app then runs without further prompting from the user).
    * Obfuscators etc are allowed and may be needed to help reduce compiled code size.
* Network access is allowed, but:
    * You will not load more executable code over the network.
    * You must disclose all net access.
    * Your app should not break when no network access is available (fail gracefully).
    * You may only access servers you do not run (no writing a webapp that does all the work for your 5K app).
    * Preferably all network access should use standard APIs (e.g. Flickr or Twitter APIs), though this is not a requirement, so screen-scraping etc is ok.
* All resources (images etc) count towards the 5K limit.
* You may specify certain (reasonable) installation requirements (e.g. Java/.Net/Firefox/Greasemonkey/Python/Perl/Ruby)
    * Standard/Vanilla versions of whatever runtime you wish to use should be assumed.
    * MacOS X comes with a lot of stuff installed by default, so if in doubt assume that to be fairly "standard".
    * Additional "non-standard" libraries may be used, but they will count towards your budget.
    * You may plead your if you want to use libraries that are "defacto" standards.
    * No writing libraries that do all the work for your 5K app.
* Browser-based apps must work in at least one major browser - cross-browser compatibility is a bonus not a requirement.
* No buying yourself an advantage.
* Bending the rules with style will afford you a certain amount of clemency.

##Language/Runtime Specific Notes##

Java apps should be a single .jar file that may execute either as an applet, application or webstart app.  For the applet and webstart app additional resources may be required (e.g. html file to embed applet, jnlp file for webstart) - these resources don't count to the budget, as long as they are not used to pass additional information to the app.  If they do then they count to the budget.  Effectively they are equivalent to invoking the app on the command line.

Flash apps embedded in html can be considered as similar to Java applets, so similar rules apply (not a Flash expert, so this may need changing).  Flash Crunchers are only allowed if they are a freely available tool.  Otherwise this would give an unfair advantage to those with the money to buy them.  Freely available crunchers or home made crunchers are allowed (assuming you also make your home made cruncher freely available).

Javascript/HTML apps should be contained in a single file.  To keep things clean it is recommended that a build script is used to take separate javascript, html and css and combine them into a single file.  A compressor (e.g. YUICompressor) can also be used during this step.  Images may be kept separate though (as packing binary data into your html file is a bit fiddly).

C/C++ etc compile to executables, so that should be fairly obvious.

Python, Perl, Ruby and PHP can be turned into self-extracting scripts to save space (see [notes I have on doing this in Python](http://www.psychicorigami.com/2008/12/29/packing-python-scripts-for-the-5k-app/)) and should take the form of a single file.  Images etc can be left as separate files - unless you fancy getting friendly with base64.

PHP may assume the presence of mod_php (seeing as that's the standard way to run it).

Mobile applications are of course acceptable, whether J2ME, Python, Native (or anything else).  For J2ME apps only the jar file counts towards the limit, if a jad file is required for installation it does not count.  Obviously it only has to run on one handset, so don't worry about porting.

Feel free to be creative - 5K C64 apps, robot control programs etc.  Just try and stick to the "spirit" of the rules.

##Judging##

The winner will be determined by a vote (possibly a [preference vote](http://en.wikipedia.org/wiki/Preferential_voting)) at the event.

Ideally the applications will be made publicly available prior to the event for everyone to see.  Applications will also be demoed at the event, so everyone gets a chance to see them in action before voting.

If the number of entrants makes voting at the event impossible we will instead have a period of online voting prior to the event to determine which entrants will be shortlisted for the event.

Voters should judge applications based on their:

* Utility/Fun - does the app do something useful or if it's a game is it good fun?
* Awesomeness - does the app achieve something technically impressive within the 5K budget?

Applications will be reviewed before hand to ensure they meet the rules.

**The 5K budget is a hard limit.  Your application cannot be entered if it is over budget.**

##When##

The 5K app judging was held on the 20th of April 2009 at the [£5app meet](http://fivepoundapp.com/meetup/16/).  For more details see [this blog post](http://fivepoundapp.com/blog/2009/04/25/5k-app-results/).

##Entry Submission##

Put up your entries online somewhere with supporting info (list of features, screencasts of it in action etc), so people can easily get access to the app for judging.  For applications that may not be feasible for all people to run (e.g. mobile or mac/win specific) I'd recommend you do some demo videos/screencasts.  Thay way people can at least see what your app does/looks like if they don't have the right stuff installed to run it themselves.

Once you have your app online email `demo AT fivepoundapp DOT com` or else use the google group (or mail John or Ian directly if you know our addresses) with details of your app and the URL.

**Judging has already taken place**

##See Also##

* [The 25-Line ActionScript Contest](http://www.25lines.com/)
* [<web4096>](http://web4096.message.sk/)
* [Java4K](http://www.java4k.com/index.php?action=home)
* [Java 4K tips and hints](http://www.ahristov.com/tutorial/java4k-tips/java4k-tips.html)
* [the5k](http://www.sylloge.com/5k/original.html)
* [List Apart Article on "the5k"](http://www.alistapart.com/articles/5k)

##Example Apps##

* [5KTwit](http://www.psychicorigami.com/2008/12/22/a-5k-twitter-client/) - example app by [John](http://www.psychicorigami.com/) (Twitter client in Java)
* [5KTODO](http://www.psychicorigami.com/2008/12/24/a-5k-javascript-local-storage-backed-todo-list-app/) - another example by John (Javascript with local storage of TODO items)
* [5KEdit](http://www.psychicorigami.com/2009/01/05/a-5k-python-fullscreen-text-editor/) - another example by John (Python Writeroom style text editor)
* [5KTuner](http://www.psychicorigami.com/2009/01/17/a-5k-java-guitar-tuner/) - another example by John (Guitar Tuner)
* [5KMorse](http://www.psychicorigami.com/2009/03/01/5k-morse-code-app-using-capslock-led/) - another example by John (Morse code using capslock LED)

##App Ideas##

A few ideas to get people started (feel free to add some more if you have any spare):

* Personal/Desktop wiki
* Image editor (Photoshop in 5K)
* Graphical calculator
* File encrypter/decrypter (PGP in 5K)
* P2P app (hard to beat [15 line P2P app in Python](http://linuxreviews.org/news/2005/11/11_tinyp2p/), though no GUI for it)
* Library/Cataloguing app
* Image effect apps (e.g. [Tilt-shift](http://en.wikipedia.org/wiki/Tilt-shift_miniature_faking))
* Time-lapse photography app
* Stop-motion animation app
* Bug-tracker
* Wireframe maker
* Podcast downloader/aggreagtor
* Podcast recording software
* Games (most Java 4K contests seem to be for games, so see links above)
* Apps using data from [BBC Backstage](http://backstage.bbc.co.uk/)

##Discussion##

The rules are open for amendment/discussion: [£5app google group](http://groups.google.com/group/fivepoundapp)

Enter code word, db1: use markdown syntax

[view]
[edit]
[history]

modified: 13:06 Sun 26th Apr 2009

Make a comment

Name
Email address
URL
Comment
If you enter anything in this field your comment will be treated as spam