TODO

   1 SuperTux TODO
   2 =============
   3
   4 This is a list of tasks and issues that might be worth to implement or
   5 fix. This list is however not an authorative list of things that must
   6 be done, its a collection of random things that pop up during
   7 development, therefore not everything in here might be well thought
   8 out or worth to implement. Use your brain before implementing anything
   9 on this list and always think about how useful a new feature would be
  10 in the context of the whole game or if a potential performance
  11 enhanchment, actually enhanchmes anything at all.
  12
  13 Coding Standard Stuff
  14 =====================
  15
  16 * make code clean: "-O2", "-g3",
  17                      "-ansi",
  18                      "-pedantic",
  19                      "-Wall",
  20                      "-Wextra",
  21                      "-Wnon-virtual-dtor",
  22                      "-Weffc++",
  23                      "-Wconversion",
  24                      "-Werror",
  25                      "-Wshadow",
  26                      "-Wcast-qual",
  27                      "-Winit-self", # only works with >= -O1
  28                      "-Wno-unused-parameter",
  29
  30 * remove overuse of multi-inheritance
  31
  32 * remove overuse of friend'ship
  33
  34 * maybe mark interfaces as interfaces (ISerializable or SerializableInterface)
  35
  36 * split files with multiple classes into multiple files with one class each
  37
  38 * static vs anonymous namespace
  39
  40 * check the code with Valgrind
  41
  42 * use Vector in Physics for 'a' and 'v'
  43
  44 * replace random generator with mersene twister and/or move to external/
  45
  46 * write/finish scripts for include sorting and include guard checking that
  47   can be run automatically
  48
  49 * md5.hpp and random_generator.hpp could go to external/
  50
  51 * write scripts to automatically check for:
  52
  53   - all includes are relative to top level dir
  54
  55   - include guards are proper
  56
  57 TODO
  58 ====
  59
  60 * GameObject::RemoveListenerListEntry: Ughs, somebody trying to
  61   implement a list class within in the GameObject?!
  62
  63 * add --datadir DIR (data/) and --userdir DIR (~/.supertux/)
  64
  65 * make gravity a constant
  66
  67 * funky side effect of too much global variables: when having a
  68   savegame with large or firetux and then starting that game, Tux in
  69   the menu background will grow and be visible that way for a fraction
  70   of a second
  71
  72 * rename Vector -> Vector2f
  73
  74 * get rid of global SDL_Screen* screen variable
  75
  76 * identify all global variables and make them ugly (g_ or globals::)
  77
  78 * get rid of SCREEN_WIDTH/SCREEN_HEIGHT
  79
  80 * is version.h actually needed?
  81
  82 * resolution menu entry moves the wrong way around
  83
  84 * having dictionary_manager in Lisp is extremely ugly
  85
  86 * enforce proper naming of files to match their class
  87
  88 * get rid of NDEBUG and conditional compilation, these should be
  89   reserved for a few tiny cases, not spread all over the code
  90
  91 * split particlesystem_interactive
  92
  93 * Renderer::apply_config() needs to handle fullscreen switching
  94
  95 * collect all manager classe into globals.hpp
  96
  97 * more moving directories around?
  98
  99 addon/
 100 audio/
 101 control/
 102 gui/
 103 lisp/
 104 math/
 105 physfs/
 106 sprite/
 107 util/
 108 video/
 109 squirrel/
 110   for generic squirrel code
 111 supertux/
 112   worldmap/
 113   trigger/
 114   scripting/
 115     for scripting wrapper code
 116   badguy/
 117   object/
 118
 119 * implement PNG screenshot
 120
 121 * GL_ARB_texture_non_power_of_two returns 1 on MatroxG450, while it
 122   returns "Missing" in glewinfo, something wrong
 123
 124 * having hitbox in Sprite is fugly
 125
 126 * write decal object
 127
 128 * implement surface and/or sprite scaling (MipMaps?)
 129
 130 * add code that compares the last Log line with the current, if they
 131   are the same reject them and just output something like:
 132
 133   * last line has been repeated X times
 134
 135 * file naming is inconsistent: some times we use '_' to separate
 136   words, sometimes we don't
 137
 138 * implement: http://standards.freedesktop.org/menu-spec/menu-spec-latest.html
 139
 140 * workaround for Ubuntu pulseaudio/OpenAL brokeness:
 141
 142 $ cat ~/.alsoftrc
 143 drivers = oss
 144
 145 * peaking up/down doesn't work properly
 146
 147 * peaking left/right should make Tux look into that direction (up/down to, needs new sprites)
 148
 149 * add pipe graphics that makes a 90 degree turn
 150
 151 * keep possible future SDL1.3 upgrade in mind
 152
 153 * cleanup scripting interface
 154
 155 * remove cloud tiles, replace with decal
 156
 157
 158 Subversion->Git/Mercurial/Bzr Move
 159 ==================================
 160
 161 * right now a switch doesn't seem to be worth it
 162
 163 * core issue right now isn't SVN, but old SVN version on lethargik.org
 164   (lacks merge tracking and issues with viewvc)
 165
 166 * cleanup SVN to make import into other version control systems possible:
 167
 168  - Should we merge trunk/supertux-milestone1 and trunk/supertux when switching to Git/Hg/...?
 169
 170 Mistakes: incorrect branch creation: r5201-5207
 171
 172 tags/start           # unknown
 173 tags/supertux        # unknown
 174 tags/supertux_0_1_0
 175 tags/supertux_0_1_1
 176 tags/supertux_0_1_2
 177 tags/supertux_0_1_3
 178
 179 branches/cobble      # unknown
 180 branches/milestone1  # unknown
 181 branches/new-collision-detection # unknown
 182 branches/README      # documentation that will be lost in conversion
 183 branches/supertux    # unknown
 184 branches/supertux_0_1_1_branch
 185 branches/supertux-box2d  # mathnerd (trash)
 186 branches/supertux-editor-newdrawing # editor
 187 branches/supertux-editor-newdrawing2 # editor
 188 branches/supertux-milestone1-olpc    # supertux-milestone1
 189 branches/supertux-milestone2-grumbel # supertux
 190 branches/supertux-nogl               # supertux(?)
 191 branches/supertux-sharp              # another supertux editor
 192 branches/unison-video                # ???
 193 branches/vendor                      # ??? CVS crap
 194
 195 trunk/cobble          # some editor?
 196 trunk/CVSROOT         # ??? CVS crap
 197 trunk/htdocs          # htdocs
 198 trunk/jnrcol
 199 trunk/media
 200 trunk/SDL_tty
 201 trunk/setup2x
 202 trunk/supertux
 203 trunk/supertux-editor
 204 trunk/supertux-milestone1
 205 trunk/supertux-portable
 206 trunk/supertux-sharp
 207 trunk/wiz-test
 208
 209
 210 Potential Git Issues
 211 ====================
 212
 213 * lack of sparse/narrow/shallow checkout, this means initial checkout
 214   will be 200MB instead of 100MB
 215
 216 * no free hoster that allows >1GB repositories (haven't checked all,
 217   but those I did came out way short) -> could use lethargik.org
 218
 219 * some free hosters that might allow >1GB repositories don't allow
 220   having multiple repositories
 221
 222 * git submodule doesn't seem to be quite ready to replace our
 223   trunk/supertux, trunk/supertux-editor, trunk/media/, ... layout as
 224   it for example doesn't support automatic tracking of HEAD from the
 225   remote repositories, it also feels rather hacky and not properly
 226   integrated into git
 227
 228 * lack of metadata versioning, if you delete a branch in git that you
 229   haven't merged, then its gone after the next gc/repack (+ two weeks
 230   time limit it seems), in SVN on the other side you can checkout the
 231   way the tree was at a specific date, its impossible to lose history
 232   unless you hack the repository
 233
 234
 235 Random Notes
 236 ============
 237
 238 * calculate the size of an background image:
 239
 240    (parallax - 1) * screen_size + level_size
 241    ----------------------------------------- = image_size
 242                    parallax
 243
 244 * how to calculate the exact position of a background image so that it
 245   looks correct on different magnifications?
 246
 247 # EOF #