Invincibility stars sparkle when close to Tux
[supertux.git] / TODO
diff --git a/TODO b/TODO
index f1aad98..efaf691 100644 (file)
--- a/TODO
+++ b/TODO
@@ -35,62 +35,54 @@ Coding Standard Stuff
 
 * split files with multiple classes into multiple files with one class each
 
-* static vs anonymous namespace
+* Decide what to do with magic constants of objects (static vs anonymous namespace vs lisp property)
 
-* check the code with Valgrind
+* check the code with Valgrind and profilers
 
 * use Vector in Physics for 'a' and 'v'
 
-* replace random generator with mersene twister and/or move to external/
-
-* write/finish scripts for include sorting and include guard checking that
-  can be run automatically
+* replace random generator with mersenne twister and/or move to external/ (maybe use boost's random stuff)
 
 * md5.hpp and random_generator.hpp could go to external/
 
-* write scripts to automatically check for:
+* write/finish scripts to automatically:
+
+  - make all includes relative to top level dir
 
-  - all includes are relative to top level dir
+  - sort includes (.hpp file, then system includes, then other project files)
 
-  - include guards are proper
+  - include guards proper and of the form HEADER_SUPERTUX_${PATH_TO_FILE}_HPP
 
 TODO
 ====
 
+* implement a system that allows to attach comments to specific regions in a level
+
+* implement a tool to "screenshot" a complete level
+
 * GameObject::RemoveListenerListEntry: Ughs, somebody trying to
   implement a list class within in the GameObject?!
 
-* add --datadir DIR (data/) and --userdir DIR (~/.supertux/)
-
-* make gravity a constant
+* add --datadir DIR (data/) and --userdir DIR (~/.supertux/), allow multiple --datadir's
 
-* funky side effect of too much global variables: when having a
-  savegame with large or firetux and then starting that game, Tux in
-  the menu background will grow and be visible that way for a fraction
-  of a second
+* make gravity constant
 
 * rename Vector -> Vector2f
 
 * get rid of global SDL_Screen* screen variable
 
-* identify all global variables and make them ugly (g_ or globals::)
-
-* get rid of SCREEN_WIDTH/SCREEN_HEIGHT
-
-* is version.h actually needed?
+* get rid of SCREEN_WIDTH/SCREEN_HEIGHT overuse, give them a proper name at least
 
 * resolution menu entry moves the wrong way around
 
 * having dictionary_manager in Lisp is extremely ugly
 
-* enforce proper naming of files to match their class
-
-* get rid of NDEBUG and conditional compilation, these should be
-  reserved for a few tiny cases, not spread all over the code
+* enforce proper naming of files to match their class (SomeClass -> some_class.?pp or so)
 
-* split particlesystem_interactive
+* file naming is inconsistent: some times we use '_' to separate
+  words, sometimes we don't
 
-* collect all manager classe into globals.hpp
+* collect all manager classes into globals.hpp
 
 * more moving directories around?
 
@@ -118,7 +110,7 @@ supertux/
 
 * having hitbox in Sprite is fugly
 
-* write decal object
+* write decal object that doesn't have hitbox
 
 * implement surface and/or sprite scaling (MipMaps?)
 
@@ -127,9 +119,6 @@ supertux/
 
   * last line has been repeated X times
 
-* file naming is inconsistent: some times we use '_' to separate
-  words, sometimes we don't
-
 * implement: http://standards.freedesktop.org/basedir-spec/basedir-spec-0.6.html
 
 * workaround for Ubuntu pulseaudio/OpenAL brokeness:
@@ -141,17 +130,15 @@ drivers = oss
 
 * peaking left/right should make Tux look into that direction (up/down to, needs new sprites)
 
-* add pipe graphics that makes a 90 degree turn
-
-* keep possible future SDL1.3 upgrade in mind
+* keep possible future SDL1.3 upgrade in mind (what has changed?)
 
 * cleanup scripting interface
 
-* remove cloud tiles, replace with decal
+* replace cloud tiles with decals
 
 * option menu has text overlap in "aspect ratio"
 
-* jumping up from an enemy doesn't make a sound
+* jumping up from an enemy doesn't make a sound?
 
 * add support for automatic scrolling backgrounds
 
@@ -180,12 +167,32 @@ drivers = oss
 * gluBuild2DMipmaps leads to blurriness, maybe lack of magic offset
   (0.375f, 0.375f, 0.0f) or something else
 
+* font system has blending artifacts at non-1x magnifications, need to
+  have an transparent pixel between letters
+
+* add a (border #t) flag to fonts, that allows to use fonts which have
+  a 1px transparent border around glyphs, which is needed to get rid
+  of blending artifacts in OpenGL
+
+* mouse cursor has blend artifact on high magnification
+
+* shadow font glyphs bleed into other glyphs
+
+* in DrawingRequest "void* request_data;" is only free'ed, but the
+  destructor never gets called
+
+* sprite/sprite.cpp: frame should never get out of range:
+
+  if((int)frame >= get_frames() || (int)frame < 0)
+    log_warning << "frame out of range: " << (int)frame << "/" << get_frames() << " at " << get_name() << "/" << get_action() << std::endl;
+
+* Surface::hflip() is used exactly once, should probally be part of the constructor
 \f
 Scenegraph and Physics Engine Restructuring
 ===========================================
 
 * random idea to restructure engine stuff (might lead to nicer code
-  and easier scriptability and a need to rewrite lots of stuff...):
+  and easier scriptability (and a need to rewrite lots of stuff...):
 
 class SomeBadGuy : public PhysicsCallbackListener // or use boost::function
 {
@@ -222,109 +229,7 @@ public:
         // respond
       }
 };
-\f
-Subversion->Git/Mercurial/Bzr Move
-==================================
-
-* right now a switch doesn't seem to be worth it
-
-* core issue right now isn't SVN, but old SVN version on lethargik.org
-  (lacks merge tracking and issues with viewvc)
-
-* cleanup SVN to make import into other version control systems possible:
-
- - Should we merge trunk/supertux-milestone1 and trunk/supertux when switching to Git/Hg/...?
-
-Mistakes: incorrect branch creation: r5201-5207
-
-tags/start           # unknown
-tags/supertux        # unknown
-tags/supertux_0_1_0
-tags/supertux_0_1_1
-tags/supertux_0_1_2
-tags/supertux_0_1_3
-
-branches/cobble      # unknown
-branches/milestone1  # unknown
-branches/new-collision-detection # unknown
-branches/README      # documentation that will be lost in conversion
-branches/supertux    # unknown
-branches/supertux_0_1_1_branch
-branches/supertux-box2d  # mathnerd (trash)
-branches/supertux-editor-newdrawing # editor
-branches/supertux-editor-newdrawing2 # editor
-branches/supertux-milestone1-olpc    # supertux-milestone1
-branches/supertux-milestone2-grumbel # supertux
-branches/supertux-nogl               # supertux(?)
-branches/supertux-sharp              # another supertux editor
-branches/unison-video                # ???
-branches/vendor                      # ??? CVS crap
-
-trunk/cobble          # some editor?
-trunk/CVSROOT         # ??? CVS crap
-trunk/htdocs          # htdocs
-trunk/jnrcol
-trunk/media
-trunk/SDL_tty
-trunk/setup2x
-trunk/supertux
-trunk/supertux-editor
-trunk/supertux-milestone1
-trunk/supertux-portable
-trunk/supertux-sharp
-trunk/wiz-test
-
-
-Potential Git Issues
-====================
-
-* lack of sparse/narrow/shallow checkout, this means initial checkout
-  will be 200MB instead of 100MB
-
-* no free hoster that allows >1GB repositories (haven't checked all,
-  but those I did came out way short) -> could use lethargik.org
-
-* some free hosters that might allow >1GB repositories don't allow
-  having multiple repositories
-
-* git submodule doesn't seem to be quite ready to replace our
-  trunk/supertux, trunk/supertux-editor, trunk/media/, ... layout as
-  it for example doesn't support automatic tracking of HEAD from the
-  remote repositories, it also feels rather hacky and not properly
-  integrated into git
-
-* lack of metadata versioning, if you delete a branch in git that you
-  haven't merged, then its gone after the next gc/repack (+ two weeks
-  time limit it seems), in SVN on the other side you can checkout the
-  way the tree was at a specific date, its impossible to lose history
-  unless you hack the repository
-
-svn2bzr.py
-==========
-
-Committed revision 5727
-Committed revision 5728
-Committed revision 5729
-Committed revision 5730
-Traceback (most recent call last):
-  File "./svn2bzr.py", line 194, in <module>
-    main()
-  File "./svn2bzr.py", line 187, in main
-    log=log)
-  File "./svn2bzr.py", line 88, in svn2bzr
-    creator.run()
-  File "/mnt/bzr/svn2bzr/branchcreator.py", line 622, in run
-    entries = self.filter_entries(entries)
-  File "/mnt/bzr/svn2bzr/branchcreator.py", line 671, in filter_entries
-    entries = self.filter_moves(entries)
-  File "/mnt/bzr/svn2bzr/branchcreator.py", line 727, in filter_moves
-    entries = self.filter_simult_fren_dirmove(entries)
-  File "/mnt/bzr/svn2bzr/branchcreator.py", line 784, in filter_simult_fren_dirmove
-    newfname = svnrelpath(newdpth, newfpth)
-  File "/mnt/bzr/svn2bzr/branchcreator.py", line 60, in svnrelpath
-    raise errors.PathNotChild(path, base)
-bzrlib.errors.PathNotChild: Path "trunk/media/images/creatures/mr_cherry/cherrybomb.xcf" is not a child of path "trunk/media/images/creatures/mr_bomb"
-\f
+
 Random Notes
 ============
 
@@ -336,8 +241,8 @@ def calc(parallax, screen, tiles):
     return (1 - parallax) * screen + parallax * tiles * 32
 
 \f
-Supported Resolution
-====================
+Supported Resolutions
+=====================
 
 SuperTux shall support resolutions from 640x480 to 1280x800 at a magnification of 1x.
 For resolutions higher, such as 2560x1600, upscaling will be used.
@@ -348,4 +253,32 @@ Lower res graphics for 0.5x maginification might be provided as well.
 
 Resolution and magnification can be freely configured by the user within the given limits.
 
+In tiles this means we have 40x25 (=1280x800px) tiles per screen.
+\f
+Graphic Tasks
+=============
+
+* animate cave background torch: data/images/tiles/background/backgroundtile3.png
+
+* do parallax tiles
+
+* remove lightmap tiles
+
+* redraw/replace data/images/tiles/waterfall/
+\f
+Music Recode
+============
+
+Currently the music makes up a large chunk of the total tarball
+size. Compression could fix this:
+
+  ,-- Size of data/music/*.ogg
+  V
+40MB - Current quality in SVN
+24MB - Default oggenc quality (3)
+14MB - oggenc at 0 quality
+10MB - oggenc at -1 quality
+
+No audible difference on my sound setup. -- grumbel
+\f
 # EOF #