Difference between revisions of "TODO"

Jump to navigation Jump to search
2,533 bytes removed ,  19:41, 6 December 2017
Remove some obsolete TODO items
(→‎Wiki: We have a wiki theme since some time actually.)
(Remove some obsolete TODO items)
(20 intermediate revisions by 9 users not shown)
Line 23: Line 23:
* Add port specific user documentation (dreamcast/palm especially). That would include things like:
* Add port specific user documentation (dreamcast/palm especially). That would include things like:
** How to use ScummVM on system XYZ
** How to use ScummVM on system XYZ
** Which Palm / WinCE devices will run ScummVM, which definitely will not run it (or with which limitations)?
* Update/enhance man page
* Update/enhance man page
* Write a high level overview of how ScummVM and its engines work?
* Write a high level overview of how ScummVM and its engines work?
Line 43: Line 42:
* Add big (green?) shiny buttons in the middle of the page for (1) Donations and (2) Downloads ?
* Add big (green?) shiny buttons in the middle of the page for (1) Donations and (2) Downloads ?
* Show "Release Date" on download page
* Show "Release Date" on download page
* Use Javascript to improve the downloads page, by only showing the most important ports/downloads by default, and then uncovering the rest upon a click by the user (with gracious fallback if Javascript is disabled). A first draft of something like this can be seen on http://fredrik_w.users.sourceforge.net/downloads/
* Change all screenshot filenames to match our rules as described [[Screenshots|here]]. E.g. rename <code>data/screenshots/agos/simon/scummvm_2_4_0.jpg</code> to <code>data/screenshots/agos/simon/simon-0.jpg</code> etc.; also some stuff should maybe be moved to other directories.
* Change all screenshot filenames to match our rules as described [[Screenshots|here]]. E.g. rename <code>data/screenshots/agos/simon/scummvm_2_4_0.jpg</code> to <code>data/screenshots/agos/simon/simon-0.jpg</code> etc.; also some stuff should maybe be moved to other directories.


=== [[Buildbot]] ===
=== [[Buildbot]] ===
* Run unit tests as part of the builds (i.e. add a build which, if the native build succeeded, runs "make test")
* Build the ScummVM tools via buildbot (of course only for desktop platforms)
* Switch it to do verbose builds (seeing which exact command was used to invoke the compiler when debugging errors is quite helpful)
* Track the size of the resulting binaries.
* Track the size of the resulting binaries.
** This would greatly help in tracking down when and why the size of the ScummVM binary increased.
** This would greatly help in tracking down when and why the size of the ScummVM binary increased.
Line 56: Line 51:
** For bonus points, allow the user of that webpage to dynamically change it using javascript: i.e. selecting which ports to show, which range of revisions; mousing over a data point shows a little box with details on the commit; clicking on a revision number jumps to the corresponding page in our SVN repository viewer; etc. ;).
** For bonus points, allow the user of that webpage to dynamically change it using javascript: i.e. selecting which ports to show, which range of revisions; mousing over a data point shows a little box with details on the commit; clicking on a revision number jumps to the corresponding page in our SVN repository viewer; etc. ;).
* Install the new required dependencies (libpng and libtheora for [[Sword25]]) into the cross compiler environments of all ports that have a chance of supporting [[Sword25]].
* Install the new required dependencies (libpng and libtheora for [[Sword25]]) into the cross compiler environments of all ports that have a chance of supporting [[Sword25]].
* Install the new required dependencies (libpng, libfreetype, boost and wx-widgets) into the cross compiler environments of all desktop ports to support building of tools.


=== [[Doxygen]] ===
=== [[Doxygen]] ===
Line 79: Line 75:
     ./scummvm --add new_target --path=/foo monkey2
     ./scummvm --add new_target --path=/foo monkey2
     ./scummvm --remove new_target
     ./scummvm --remove new_target
* Maybe allow launching games even if no target is specified? I.e. the user only has to specify a path (or run ScummVM from the right directory), and ScummVM auto-detects the game in that location
    ./scummvm --auto-detect
* The following things should be put into namespaces:
* The following things should be put into namespaces:
** MIDI related classes either to Audio, or a new "MIDI" namespace
** MIDI related classes either to Audio, or a new "MIDI" namespace
** backend specific stuff into ??? (maybe new namespace "Backends" ?)  not sure about this one.
** backend specific stuff into ??? (maybe new namespace "Backends" ?)  not sure about this one.
* Get rid of getenv in as many places as possible. Ideally, we'd only use it to query HOME on Unix systems.
* Get rid of getenv in as many places as possible. Ideally, we'd only use it to query HOME on Unix systems.


==== Iterator handling ====
==== Iterator handling ====
Line 98: Line 91:
is valid for which event type. Implementation wise, we might want to use
is valid for which event type. Implementation wise, we might want to use
the classic union-of-structs trick. It goes roughly like this:
the classic union-of-structs trick. It goes roughly like this:
<syntax type="C++">
<source lang="cpp">
struct BasicEvent {
struct BasicEvent {
     EventType type;
     EventType type;
Line 119: Line 112:
     ...
     ...
};
};
</syntax>
</source>


However, this approach is contrary to classic OO paradigms. Indeed, its
However, this approach is contrary to classic OO paradigms. Indeed, its
Line 130: Line 123:
casting in code using events. The passing around of pointers could be
casting in code using events. The passing around of pointers could be
mitigated by using
mitigated by using
<syntax type="C++">
<source lang="cpp">
typedef Common::SharedPtr<BasicEvent> Event
typedef Common::SharedPtr<BasicEvent> Event
</syntax>
</source>
or something like that. Yet this would mean increased overhead in all
or something like that. Yet this would mean increased overhead in all
our code, yet the gain is unclear. In conclusion, we probably are best
our code, yet the gain is unclear. In conclusion, we probably are best
off by staying with the existing monolithic struct Event, we should just
off by staying with the existing monolithic struct Event, we should just
enhance its documentation.
enhance its documentation.
==== Event recorder ====
Currently there is an implementation based on {{PatchTrack|num=1214168}} but it needs more work
* Try to avoid warpMouse() calls at playback, so the system will be useable
* Perhaps we need to indicate recording mode. May be draw triangle/circle in some corner. Use OSD overlay for that
* Still it is possible that time will drift away even with current implementation. Do something about it, at least try to detect
* Remove temporary file
* Perhaps autogenerate record file name based on target name
* Perhaps combine 2 files which get created currently into one
* We should store unique game ID in the record files. I.e. ideally it should be engine name and some game MD5 or anything else which could be re-generated on game start. Then when this method is called in playback mode, recorder matches this against values stored in the record and refuses to play if they do not match.
  registerGame("scumm", "60ba818dc3bede86d40357e3913f8505");
* Perhaps add special flag when game started from a save, i.e. not from the very beginning but with -x command line switch
** Perhaps embed the save into the recording then
* getMillis() currently is hacked into SDL. It has to be moved one level up
* delayMillis() perhaps has to be wrapped too, so time drift could be avoided


=== Build System ===
=== Build System ===
Line 211: Line 185:
* Game edit dialog: Consider adding some warnings to the platform/language fields ("Don't mess with these unless you know what you are doing"), or move them to an "advanced" tab
* Game edit dialog: Consider adding some warnings to the platform/language fields ("Don't mess with these unless you know what you are doing"), or move them to an "advanced" tab
* Make the gameid editable via an "advanced" tab entry?
* Make the gameid editable via an "advanced" tab entry?
* There is no way to reset the save/extra/theme paths. Adding a tiny button labeled "c" for clearing them (like for the soundfont path button) is not the way to solve this, I think. One approach would be to extend the Browser dialog, to allow an (optional) extra button, with customizable label. When pressed, the browser dialog closes and returns a special code. Well, and we'd use labels like "Use default savepath" or "Reset extrapath", or just always "Use default value".
* <s>There is no way to reset the save/extra/theme paths. Adding a tiny button labeled "c" for clearing them (like for the soundfont path button) is not the way to solve this, I think. One approach would be to extend the Browser dialog, to allow an (optional) extra button, with customizable label. When pressed, the browser dialog closes and returns a special code. Well, and we'd use labels like "Use default savepath" or "Reset extrapath", or just always "Use default value".</s>
* The global options dialog may show a button for configuring the savepath even on systems where it is fixed -> not good. This button should be hidden/removed for these systems
* The global options dialog may show a button for configuring the savepath even on systems where it is fixed -> not good. This button should be hidden/removed for these systems
* separate launcher code even more from rest of ScummVM, to make custom launchers easier?
* separate launcher code even more from rest of ScummVM, to make custom launchers easier?
Line 230: Line 204:
* Make it possible to reach the  "key remapper" and "virtual keyboard" from the GMM, if available?
* Make it possible to reach the  "key remapper" and "virtual keyboard" from the GMM, if available?
* Sugar on the cake: In addition to the ScummVM logo and version, how about showing the engine name and game title at the top of the GMM?
* Sugar on the cake: In addition to the ScummVM logo and version, how about showing the engine name and game title at the top of the GMM?
=== Error handling ===
Sometimes, bugs are reported that are not easily reproducible, e.g. [https://sourceforge.net/p/scummvm/bugs/6751/ Bug #6751]. In such cases, it would be useful to have the error handler in ScummVM generate (and, optionally, automatically send) minidumps that can be used by us to successfully examine crashed ScummVM processes. Integration of something like [https://chromium.googlesource.com/breakpad/breakpad/ Google Breakpad] is one reasonable option. While it is not likely to be able to get such crash handling into all ports, just supporting the most popular platforms would be enough to make this feature very useful.


== Engines / frontends ==
== Engines / frontends ==
Line 245: Line 223:
=== [[Cine]] ===
=== [[Cine]] ===
* see [[Cine/TODO|Cine TODO]] list
* see [[Cine/TODO|Cine TODO]] list
=== [[CruisE]] ===
* see [[Cruise/TODO|CruisE TODO]] list


=== [[Drascula]] ===
=== [[Drascula]] ===
Line 254: Line 235:
=== [[Groovie]] ===
=== [[Groovie]] ===
* see [[Groovie/TODO|Groovie TODO]] list
* see [[Groovie/TODO|Groovie TODO]] list
=== [[Hopkins]] ===
* see [[Hopkins/TODO|Hopkins TODO]] list


=== [[Hugo]] ===
=== [[Hugo]] ===
Line 260: Line 244:
=== [[Kyra]] ===
=== [[Kyra]] ===
* see [[Kyra/TODO|Kyra TODO]] list
* see [[Kyra/TODO|Kyra TODO]] list
=== [[Lastexpress]] ===
* see [[Lastexpress/TODO|Lastexpress TODO]] list


=== [[MADE]] ===
=== [[MADE]] ===
Line 282: Line 269:
=== [[Sword2|Broken Sword 2]] ===
=== [[Sword2|Broken Sword 2]] ===
* Fix the credits so they look more like the original. (Did we ever get the source code for that?)
* Fix the credits so they look more like the original. (Did we ever get the source code for that?)
* Maybe work around script bug which causes the mop to disappear briefly when trying to pick it up from the top of the boat at the London docks. (The event to hide the mop is sent too early.) {{BugTrack|num=1214168}}.
* Maybe work around script bug which causes the mop to disappear briefly when trying to pick it up from the top of the boat at the London docks. (The event to hide the mop is sent too early.) {{Tracker|id=2058}}.
* Maybe (but probably not) work around a graphics glitch where George can be drawn partially in front of a metal beam he's walking behind. (He's obscured properly by the beam sprite, but part of the beam is only background.) {{BugTrack|num=2828179}}.
* Maybe (but probably not) work around a graphics glitch where George can be drawn partially in front of a metal beam he's walking behind. (He's obscured properly by the beam sprite, but part of the beam is only background.) {{Tracker|id=4483}}.
* Unify some of the code with Broken Sword 1 (e.g. in router.cpp).
* Unify some of the code with Broken Sword 1 (e.g. in router.cpp).


Line 291: Line 278:
=== [[Tinsel]] ===
=== [[Tinsel]] ===
* see [[Tinsel/TODO|Tinsel TODO]] list
* see [[Tinsel/TODO|Tinsel TODO]] list
=== [[Tony]] ===
* see [[Tony/TODO|Tony TODO]] list
=== [[Toon]] ===
* see [[Toon/TODO|Tooon TODO]] list


=== [[Touche]] ===
=== [[Touche]] ===
Line 300: Line 293:
=== [[Tucker]] ===
=== [[Tucker]] ===
* see [[Tucker/TODO|Tucker TODO]] list
* see [[Tucker/TODO|Tucker TODO]] list
=== [[Wintermute]] ===
* see [[Wintermute/TODO|Wintermute TODO]] list


== Backends and ports ==
== Backends and ports ==
Line 306: Line 302:
* Add API to query backend for a list of available music engines. Useful for Options dialog. See [[Music drivers redesign]].
* Add API to query backend for a list of available music engines. Useful for Options dialog. See [[Music drivers redesign]].
* Right now gBitFormat is part of common/scaler.cpp; we might want to move it to common/system.cpp, or replace it with something better. No hasty changes here, please, make sure you understand how it is used right now before messing with it ;-)
* Right now gBitFormat is part of common/scaler.cpp; we might want to move it to common/system.cpp, or replace it with something better. No hasty changes here, please, make sure you understand how it is used right now before messing with it ;-)
=== Android ===
* Right now, Java files are stored in org/inodes/gus/scummvm corresponding to the Java package org.inodes.gus.scummvm. It would be nice to eventually change this to org.scummvm or maybe org.scummvm.android. However, changing it would affect all installed users (it's an entirely new package as far as Android market is concerned, so no clean upgrades, save games and scummrc will be lost, etc).  Gus intends to think a bit more about what the right tradeoff is. Any input on this matter is welcome.
* Add Android support on Buildbot. This is primarily a matter of getting the right toolchain installed on our buildbot server.
* <s>Get rid of backends/platform/android/scummvm-android-themeengine.patch -- this should not be needed anymore in latest SVN, but somebody should verify that.</s>
* Fix issues with Android 2.x, and get a new release out as soon as possible. Right now various unofficial android versions are floating around, leading to lots of user confusion. This is bad for our reputation, as to an end user the distinction between official and unofficial port is not always clear.


=== SDL backend ===
=== SDL backend ===
* Right now, the WinCE and the Symbian backend subclasses the regular SDL backend. They both overload a lot of methods (mostly the graphics stuff). Since graphics.cpp uses the scalers (e.g. hq3x), these derived backends carry that baggage around, too, even though they don't need that code. Idea: split the SDL backend into two classes, one base class which only has the code which is used by all subclasses; and a "desktop" subclass, which implements the rest. Then WinCE/Symbian would only subclass the "base" SDL class.
* Right now, the WinCE and the Symbian backend subclasses the regular SDL backend. They both overload a lot of methods (mostly the graphics stuff). Since graphics.cpp uses the scalers (e.g. hq3x), these derived backends carry that baggage around, too, even though they don't need that code. Idea: split the SDL backend into two classes, one base class which only has the code which is used by all subclasses; and a "desktop" subclass, which implements the rest. Then WinCE/Symbian would only subclass the "base" SDL class.
* The <tt>kFeatureAutoComputeDirtyRects</tt> feature is not entirely reliable, and perhaps it cannot ever be. It is currently known to cause glitches in [[AGOS/TODO|The Feeble Files]].
=== WinCE backend ===
* Improve the code in <code>backends/platform/wince/CEScaler.cpp</code>, it could be a lot faster with some simple changes.


=== Windows ===
=== Windows ===
53

edits

Navigation menu