git.zerfleddert.de Git - micropolis/blob - src/ASSETS.txt

   1 Micropolis Assets:
   2
   3   This is a list of required and optional assets for Micropolis.
   4
   5   As noted, some of them are for the current TCL/Tk based version of
   6   Micropolis that we want to get out right away.  Others are for the more
   7   advanced Python version that we're developing after releasing the
   8   TCL/Tk version.
   9
  10   The TCL/Tk version currently works ok with its current assets, and
  11   these are just suggestions that would improve it but are not
  12   necessary. The Python version is not yet fully designed or
  13   implemented, and it will be more open-ended and powerful, so this is
  14   just a rough estimate of the assets it will need.
  15
  16   User Interface Graphics and Icons
  17
  18     These aren't all necessary, but it would be nice to have some of
  19     them to make the interface look nicer, more graphical, and kid
  20     friendly.
  21
  22     The style should be international, kid oriented, big, bright,
  23     saturated, simple.
  24
  25     Icons should look good and be readable when shown in desaturated
  26     gray scale on the OLPC's monochrome screen in low power reflective
  27     mode. The the brightness detail can be full resolution but the
  28     color detail should be lower resolution by about half (not
  29     depending on color detail as fine as brightness detail), because
  30     of the nature of the OLPC's screen: 200 dots per inch monochrome
  31     gray scale, with lower resolution color. For example, text on an
  32     icon should be a noticeably different brightness than the
  33     background color, instead of relying on color variation, which is
  34     not as detailed and won't show up in monochrome mode.
  35
  36     SVG is the idea source format, because it can be scaled to any
  37     size, rendered with antialiased edges, and will be easily used in
  38     the Python version. Illustrator exports SVG. For now the TCL/Tk
  39     version can use versions of the SVG files converted to "XPM"
  40     format (which I can do).
  41
  42     Later, the Python user interface will require a bunch more icons
  43     and graphics, depending on the user interface and features we
  44     decide to support. It would be great to be able to use the same
  45     SVG source graphics in the Python version, scaling them as
  46     appropriate to adapt to the screen layout. We should revisit the
  47     icons and graphics after we port Micropolis to Python.
  48
  49     What follows is a complete list of graphics we could use in the
  50     TCL/Tk version. SVG is ideal but PNG is sufficient for this time.
  51
  52     Micropolis icon for use in Sugar user interface, in SVG or PNG.
  53
  54     Logos:
  55       Micropolis logo
  56       Micropolis lettering
  57       OLPC Project logo
  58       XO Laptop logo
  59       Linux Penguin logo
  60       Python Programming Language logo
  61
  62     Small menu item icons for map overlay menus:
  63       Zones
  64         All
  65         Residential
  66         Commercial
  67         Industrial
  68         Transportation
  69       Overlays
  70         Population Density
  71         Rate of Growth
  72         Land Value
  73         Crime Rate
  74         Pollution Density
  75         Traffic Density
  76         Power Grid
  77         Fire Coverage
  78         Police Coverage
  79
  80     Small menu item icons for File menu:
  81       Save City
  82       Save City as...
  83       Add Player...
  84       Choose City!
  85       Quit Playing!
  86
  87     Small menu item icons for Options menu:
  88       Auto Budget
  89       Auto Bulldoze
  90       Disasters
  91       Sound
  92       Animation
  93       Messages
  94       Notices
  95
  96     Small menu item icons for Disasters menu:
  97       Monster
  98       Fire
  99       Flood
 100       Meltdown
 101       Air Crash
 102       Tornado
 103       Earthquake
 104
 105     Small menu item icons for Time menu:
 106       Pause
 107       Slow
 108       Medium
 109       Fast
 110
 111     Small menu item icons for Priority menu:
 112       Flat Out!
 113       Zoom Zoom
 114       Whoosh Whoosh
 115       Buzz Buzz
 116       Putter Putter
 117       Drip Drip
 118       Snore Snore
 119
 120     Small menu item icons for Windows menu (maybe the same as ones used in buttons):
 121       Budget
 122       Evaluation
 123       Graph
 124
 125     Small menu item icons for Map Options menu:
 126       Auto Goto
 127       Palette Panel
 128       Chalk Overlay
 129
 130     Small "OK" button for confirmation dialog buttons.
 131
 132     Small "Cancel" button for confirmation dialog buttons.
 133
 134     Large "Question" icon for dialogs asking questions (ok/cancel questions).
 135
 136     Large "Notice" icon for notice window (informational).
 137
 138     Large "Query" icon for zone query window (zone tricorder).
 139
 140     Medium "Generate New City" icon for button to generate new city, on start screen.
 141
 142     Medium Game Level icons for start screen radio buttons:
 143       Easy
 144       Medium
 145       Hard
 146
 147     Big "Load City" icon for load city dialog.
 148     Meduim "Load City" icon for button to load city, on start screen.
 149
 150     Big "Save City" icon for save city dialog.
 151     Small "Save City" icon for button to save city.
 152
 153     Big Evaluation icon for evaluation window.
 154     Small Evaluation icon for button to bring up evaluation window.
 155
 156     Big Graph icon for graph window.
 157     Small Graph icon for button to bring up graph window.
 158
 159     Big Simolean/Budget symbol for Budget window.
 160     Small Simolean/Budget symbol for button to bring up budget window.
 161
 162     Big Quit symbol for Quit confirmation dialog.
 163     Small Quit symbol for button to bring up Quit confirmation dialog.
 164
 165     Big About symbol for About dialog.
 166     Small About symbol for button to open About dialog.
 167
 168     Big Choose City symbol for Choose City confirmation dialog.
 169     Small Choose City symbol for button to open Choose City confirmation dialog.
 170
 171
 172   Simulation and User Interface Sounds
 173
 174     Right now it's using the original sounds, plus some interface
 175     sounds I recorded. I can convert them to the format required by
 176     the Linux sound interface we use.
 177
 178     I can supply a list of required interface sounds, but I think we
 179     can go with the sounds we have right now without any trouble.
 180
 181     Later, the Python version will require a bunch more sounds for its
 182     user interface, which will depend on the user interface features
 183     we decide to support. So we should revisit the sound effects
 184     later once Micropolis is ported to Python.
 185
 186     To be authentic, I would like to use the original sounds that the
 187     simulator made (like the Skywatch One helicopter), or re-record
 188     high quality replacements. Maybe we can get Will to record a fresh
 189     version of "Skywatch One reporting heavy traffic!" in his own
 190     voice (he made that original sound) and the sound people can add
 191     in the helicopter sound over his voice to re-create the original
 192     sound at high quality. The other sounds could be re-made from
 193     scratch without any problem or help from Will.
 194
 195     Voice overs reading the user interface text, notices, help text
 196     and documentation would be great for pre-literate children. Would
 197     need to be translated to other languages.
 198
 199
 200   Update Documentation
 201
 202     I have translated the Micropolis manual to HTML.
 203
 204     It's the original version that applies to the multi player
 205     X11/TCL/Tk version, which needs to be update in a few places where
 206     it's specific about the user interface or installation instructions.
 207
 208     It would benefit from some nice reformatting and CSS styles, as well
 209     as some illustrations and screen snapshots.
 210
 211     After we port Micropolis to Python, the interface-specific
 212     documentation will have to be rewritten, re-illustrated, and then it
 213     will have to be translated to different languages.
 214
 215     The documentation consists of the following files:
 216
 217     Index
 218       Introduction
 219       Tutorial
 220       User Reference
 221       Inside the Simulator
 222       History of Cities and City Planning
 223       Bibliography
 224       Credits
 225
 226     Help Text
 227
 228       There are also HTML files corresponding to user interface help text.
 229       The user interface components are tagged with help ids that are the
 230       base names of html files. The existing HTML help files are just
 231       placeholders that don't have any useful help text, and there are
 232       some help files for user interface components and windows that have
 233       since been removed, as well as some help files missing for user
 234       interface components and windows that have been added.
 235
 236       To finish implementing help, we need to go through the code and
 237       identify all help tags and opportunities for adding missing help
 238       tags to the user interface, then make all help files corresponding
 239       to the existing tags, delete obsolete help files, and write all the
 240       help text. It would be nice for the help text to hsve illustrations
 241       of the corresponding windows and components in use.
 242
 243       After we port Micropolis to Python, the help files will have to be
 244       re-inventoried, rewritten, re-illustrated, and translated to
 245       different languages.
 246
 247     Courseware
 248
 249       We need to include any Micropolis courseware or teacher's guides with
 250       the documentation, and update it to relect the current user
 251       interface.
 252
 253       After we port Micropolis to Python, we will need to update the
 254       courseware to reflect the features and user interface of the new
 255       user interface.
 256
 257 --
 258 Micropolis, Unix Version.  This game was released for the Unix platform
 259 in or about 1990 and has been modified for inclusion in the One Laptop
 260 Per Child program.  Copyright (C) 1989 - 2007 Electronic Arts Inc.  If
 261 you need assistance with this program, you may contact:
 262   http://wiki.laptop.org/go/Micropolis  or email  micropolis@laptop.org.
 263
 264 This program is free software: you can redistribute it and/or modify
 265 it under the terms of the GNU General Public License as published by
 266 the Free Software Foundation, either version 3 of the License, or (at
 267 your option) any later version.
 268
 269 This program is distributed in the hope that it will be useful, but
 270 WITHOUT ANY WARRANTY; without even the implied warranty of
 271 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 272 General Public License for more details.  You should have received a
 273 copy of the GNU General Public License along with this program.  If
 274 not, see <http://www.gnu.org/licenses/>.
 275
 276             ADDITIONAL TERMS per GNU GPL Section 7
 277
 278 No trademark or publicity rights are granted.  This license does NOT
 279 give you any right, title or interest in the trademark SimCity or any
 280 other Electronic Arts trademark.  You may not distribute any
 281 modification of this program using the trademark SimCity or claim any
 282 affliation or association with Electronic Arts Inc. or its employees.
 283
 284 Any propagation or conveyance of this program must include this
 285 copyright notice and these terms.
 286
 287 If you convey this program (or any modifications of it) and assume
 288 contractual liability for the program to recipients of it, you agree
 289 to indemnify Electronic Arts for any liability that those contractual
 290 assumptions impose on Electronic Arts.
 291
 292 You may not misrepresent the origins of this program; modified
 293 versions of the program must be marked as such and not identified as
 294 the original program.
 295
 296 This disclaimer supplements the one included in the General Public
 297 License.  TO THE FULLEST EXTENT PERMISSIBLE UNDER APPLICABLE LAW, THIS
 298 PROGRAM IS PROVIDED TO YOU "AS IS," WITH ALL FAULTS, WITHOUT WARRANTY
 299 OF ANY KIND, AND YOUR USE IS AT YOUR SOLE RISK.  THE ENTIRE RISK OF
 300 SATISFACTORY QUALITY AND PERFORMANCE RESIDES WITH YOU.  ELECTRONIC ARTS
 301 DISCLAIMS ANY AND ALL EXPRESS, IMPLIED OR STATUTORY WARRANTIES,
 302 INCLUDING IMPLIED WARRANTIES OF MERCHANTABILITY, SATISFACTORY QUALITY,
 303 FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT OF THIRD PARTY
 304 RIGHTS, AND WARRANTIES (IF ANY) ARISING FROM A COURSE OF DEALING,
 305 USAGE, OR TRADE PRACTICE.  ELECTRONIC ARTS DOES NOT WARRANT AGAINST
 306 INTERFERENCE WITH YOUR ENJOYMENT OF THE PROGRAM; THAT THE PROGRAM WILL
 307 MEET YOUR REQUIREMENTS; THAT OPERATION OF THE PROGRAM WILL BE
 308 UNINTERRUPTED OR ERROR-FREE, OR THAT THE PROGRAM WILL BE COMPATIBLE
 309 WITH THIRD PARTY SOFTWARE OR THAT ANY ERRORS IN THE PROGRAM WILL BE
 310 CORRECTED.  NO ORAL OR WRITTEN ADVICE PROVIDED BY ELECTRONIC ARTS OR
 311 ANY AUTHORIZED REPRESENTATIVE SHALL CREATE A WARRANTY.  SOME
 312 JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF OR LIMITATIONS ON IMPLIED
 313 WARRANTIES OR THE LIMITATIONS ON THE APPLICABLE STATUTORY RIGHTS OF A
 314 CONSUMER, SO SOME OR ALL OF THE ABOVE EXCLUSIONS AND LIMITATIONS MAY
 315 NOT APPLY TO YOU.