1== Halcyon and Potlatch 2.0 - ActionScript 3 renderer and editor ==
3Potlatch 2.0 is the new version of the OpenStreetMap online editor.
5Halcyon is its rendering engine. It's rules-based (like, say, Mapnik) and does dotted lines, text on a path, casing, icons for POIs, all of that.
7Both are written in ActionScript 3. Potlatch 2.0 additionally uses the Flex framework.
9Many icons used in halcyon/potlatch2 are based on the awesome CC0-licensed SJJB icons project. http://www.sjjb.co.uk/mapicons/
11=== What you'll need ===
13* Flex SDK 4.5
14** Product page: http://www.adobe.com/products/flex/
15** Flex download page: http://www.adobe.com/devnet/flex/flex-sdk-download-all.html (free, OS X/Windows/Linux)
16* AS3 docs - http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/
17* Flash debug player - http://www.adobe.com/support/flashplayer/downloads.html
18* Basically you might as well just sell your soul to Adobe
21If you happen to have Adobe Flex Builder 3/Flash Builder 4, you can create a project and import files into it.
22See http://wiki.openstreetmap.org/wiki/Potlatch_2/Developer_Documentation for details.
24You'll only need OSM Rails port installed on your local machine if you are doing hard-core
25server-communication coding, but if generally you can use the dev server at api06.dev.openstreetmap.org
26for development and testing.
29=== How to compile and run ===
31Compiling Potlatch 2:
331) Copy the properties template file
34 cp build.properties.template build.properties
362) Edit the FLEX_HOME variable in build.properties
37 eg, FLEX_HOME=c:/flex_sdk/18.104.22.16867
41The following command will compile potlatch2 in debug configuration
42The result is put at resources/potlatch2.swf
46The following command will compile potlatch2 in release configuration
48* ant release
50Compiling Halcyon as standalone viewer:
52* ant halcyon
54You can create class documentation (in resources/docs) using asdoc
56* ant docs
58You can create and run the unit tests (not that there are that many) using flexunit
60* ant test
62For those that don't need I8n, the following give a much speedier build as it skips the all the language translation build steps.
63As an extra bonus, this uses much less memory and you may get away without needing to tell ant to use more memory (see below).
65* ant debug-no-locales
67* ant release-no-locales
69If you're using Mac OS X, you may need to tell ant to use more memory, by
70typing export ANT_OPTS="-Xms768m -Xmx1024m -XX:MaxPermSize=768m -XX:ReservedCodeCacheSize=512m"
71beforehand (you can put this in your .profile).
74Compiling during development:
76Compiling optimized versions from scratch takes a _long_ time. There are
77several ways to make it faster during development and also add useful
78debug stack traces and enable the commandline debugger (at the expense
79of a much larger swf file.. but we're developing so that doesn't matter!).
82 - launches the Flex Compiler SHell -- stops the compiler having to
83 bootstrap itself each time you invoke it. You don't /need/ this, but it
84 does make things slightly faster (about a second a shot for me)
86* mxmlc -load-config+=debug-config.xml potlatch2.mxml
87 - compile potlatch2 in debug configuration -- build is incremental so you
88 can run it again and mxmlc will only compile changes. Output has debug
89 enabled along with decent stack traces.
90 (you can substitute halcyon_viewer.as in the above to compile that)
92* compile 1
93 - when using fcsh recompile the first command
95* compile 1
96 - type it again to compile again. You'll really wish that up-arrow,enter
97 worked, but Adobe is laughing at you RIGHT NOW.
100 - if you have it on your system (e.g. linux), rlwrap is a godsend. Launch
101 fcsh with 'rlwrap path/to/fcsh' and up arrows will work, even persistantly
102 across one fcsh session to the next.
106* Flash security model sucks. If you want to use internet resource (e.g. map calls to the dev
107 server) the binary must have been served from "teh internets". Run resources/server.py to launch a local
108 server, then go to http://localhost:3333/potlatch2.html to get started (or if you're already running e.g.
109 Apache locally, feel free to use that instead.)
111 Alternatively, you can update your global Flash security settings to "always trust files" in your local dev area:
113 Then you can run the swf file directly.
115* If you are doing offline development, you will need a rails_port install. You
116 will need to add an OAuth application by going to
118 Enter the following details (assuming the above point):
119 * Name (Required): Potlatch2 (local)
120 * Main Application URL (Required): http://localhost:3333/resources/potlatch2.html
121 And then update resources/potlatch2.html replacing the domains.
123=== Some other stuff you might need to know ===
125* Flex compiler runs at about the speed of a tortoise soaked in molasses which happens also to be dead.
126* Running the debug player helps when coding, since it'll pop up the runtime errors. You don't see them
127 with the normal player.