Difference between revisions of "Toltecs"

From ScummVM :: Wiki
Jump to navigation Jump to search
(Moved contents of Toltecs TODO.txt to Toltecs Engine Page)
(Use Tracker template instead of BugTrackSF)
 
(16 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
{{EngineDescription|
 
{{EngineDescription|
 
name=toltecs|
 
name=toltecs|
        developer=[[User:johndoe|johndoe]], [[User:md5|md5]]|
+
developer=[[User:johndoe|johndoe]], [[User:md5|md5]]|
 
companies=[[Revistronic]]|
 
companies=[[Revistronic]]|
 
usedBy=[[3 Skulls of the Toltecs]]|
 
usedBy=[[3 Skulls of the Toltecs]]|
 
dateAdded=November 20, 2011 |
 
dateAdded=November 20, 2011 |
release=None|
+
release=1.6.0|
 
}}
 
}}
  
==Status==
+
== Status ==
 +
* The game is completable with some minor glitches (see [[Toltecs#Bugs|bugs]]).
  
* WIP Engine is now in ScummVM source tree.
+
== Future TODO ==
 +
'''These are minor issues which would be good to be fixed in the future'''
 +
* Check if background resources are used before purging them when changing scenes - check the comments inside sfLoadScene
 +
* When saving a game, save the whole screen when an animation is playing e.g. when playing animations (the script controlled ones, not the movies) it should save the whole screen when the game is saved when such an animation is running since it uses delta-frames so currently, once restored, the screen is wrong. This is only observed in a few places.
 +
* Some sounds are cut off prematurely (e.g. when an animation finishes before the sound sample, when changing scenes and a dialog is immediately started afterwards). This is by design (new animations and scene changes stop sounds that are already playing), so this requires changes to the way new scenes are started. We need to verify what the original does here.
  
==NOTES==
+
== Bugs ==
 +
* Pathfinding bugs in Fort Apache and the Indian village - e.g. when moving to the door on the right, the hero walks around a big path. Same when moving to the tent on the top in the Indian village. ('''this also happens in the original''' - check [https://www.youtube.com/watch?v=ksvgHdkAJsk#t=8m42s this video])
 +
* Offering (pick-up/give) the Union Flag to the 'sleeping' Sergeant in the cell initiates voice playback of "I've already seen it" but subtitle on screen displays "I doubt it would interest him". The text is correct but the voice is not - '''this also happens in the original''', {{Tracker|id=6228}}
 +
* When getting the piano player off the well, he walks up facing to the left (his side animation is shown) - probably related to pathfinding?
 +
* Sometimes, some stray lines are drawn below fonts - probably because the text doesn't fit inside the screen and the surface is cut off incorrectly.
 +
* Some artifacts are drawn on screen occasionally (e.g. when text is shown over an animation).
  
* The game is completable with revision 20 with some minor glitches (see BUGS).
+
== Done ==
 
+
* Some of the menu colors are wrong
==TODO==
+
* Sound streaming in movies is problematic. Right now, part of the sound of a movie is preloaded and if there's still a sound buffer, it's loaded on the fly. When the sound buffer is later on loaded on the fly, the sound gets off sync. This is notable during the intro of the game (which is the longest video in the game)
* Finish music support (volume, looping perhaps?)
+
* Save sound volume and panning in saved games
* Check if background resources are used before purging them when changing scenes - check
+
* Implement music volume
the comments inside sfLoadScene.
 
* Sometimes, some stray lines are drawn below fonts - probably because the text doesn't
 
fit inside the screen and the surface is cut off incorrectly.
 
* Fix some occasional artifacts on screen (e.g. when text is shown over an animation)
 
sometimes.
 
* Pathfinding bugs in Fort Apache and the Indian village - e.g. when moving to the door
 
on the right, the hero walks around a big path. Same when moving to the tent on the top
 
in the indian village.
 
* When getting the piano player off the well, he walks up facing to the left (his side
 
animation is shown).
 
 
* Load/start sound and music of the saved scene when loading.
 
* Load/start sound and music of the saved scene when loading.
* Some sounds are cut off prematurely (e.g. when an animation finishes before the sound
 
sample, when changing scenes and a dialog is immediately started afterwards).
 
* When saving a game, save the whole screen when an animation is playing
 
e.g. when playing animations (the script controlled ones, not the movies) it should save
 
the whole screen when the game is saved when such an animation is running since it uses
 
delta-frames so currently, once restored, the screen is wrong. This is only observed in
 
a few places.
 
 
==BUGS==
 
None known (see TODO).
 
 
==DONE==
 
 
* Crashes sometimes on scene changes
 
* Crashes sometimes on scene changes
(I guess because some talktext is still running although the slot used by it has changed)
+
** (I guess because some talktext is still running although the slot used by it has changed)
Crashes sometimes (e.g. when inside the barn and going up the ladder)
+
* Crashes sometimes (e.g. when inside the barn and going up the ladder)
These crashes are caused by non-stopping background sounds, see TODO above.
+
** These crashes are caused by non-stopping background sounds, see [[Toltecs#TODO|TODO]] above.
* The game music is in XMIDI. I'm assuming that the rest of the formats were because of badly
+
* The game music is in XMIDI. I'm assuming that the rest of the formats were because of badly dumped resources - finalize() calls were missing and the resulting music could contain anything.
dumped resources - finalize() Calls were missing and the resulting music could contain anything.
 
 
* Implement dirty rectangles (low priority)
 
* Implement dirty rectangles (low priority)
* Optimize segment mask redrawing (only redraw what's neccessary)
+
* Optimize segment mask redrawing (only redraw what's necessary)
 
* Add movie playback functionality (movie format is known, needs implementing)
 
* Add movie playback functionality (movie format is known, needs implementing)
 
* Add sound support (after rewrite of the resource system)
 
* Add sound support (after rewrite of the resource system)
 
* Still some clipping issues (walking upstairs in the saloon, when on top of the tower in the hideout)
 
* Still some clipping issues (walking upstairs in the saloon, when on top of the tower in the hideout)
 
* Add game menu
 
* Add game menu
** Rewrite from scratch with only minor stuff from the disasm since the original menu is one huge
+
** Rewrite from scratch with only minor stuff from the disasm since the original menu is one huge messy function
messy function
 
 
* Rewrite the resource system to something similar as used by M4
 
* Rewrite the resource system to something similar as used by M4
 
** each resource type gets its own class, the resource cache manages the resource instances
 
** each resource type gets its own class, the resource cache manages the resource instances
Line 62: Line 48:
 
* Extend savegame format (savegame version, description, more data)
 
* Extend savegame format (savegame version, description, more data)
  
==External Links==
+
==External links==
* [http://www.mobygames.com/game/3-skulls-of-the-toltecs Mobygames page on 3 Skulls of the Toltecs]
+
* [http://www.mobygames.com/game/3-skulls-of-the-toltecs MobyGames entry for 3 Skulls of the Toltecs]
  
 
[[Category:Engines]]
 
[[Category:Engines]]

Latest revision as of 19:19, 21 February 2016

toltecs
Engine developer johndoe, md5
Companies that used it Revistronic
Games that use it 3 Skulls of the Toltecs
Date added to ScummVM November 20, 2011
First release containing it 1.6.0


Status

  • The game is completable with some minor glitches (see bugs).

Future TODO

These are minor issues which would be good to be fixed in the future

  • Check if background resources are used before purging them when changing scenes - check the comments inside sfLoadScene
  • When saving a game, save the whole screen when an animation is playing e.g. when playing animations (the script controlled ones, not the movies) it should save the whole screen when the game is saved when such an animation is running since it uses delta-frames so currently, once restored, the screen is wrong. This is only observed in a few places.
  • Some sounds are cut off prematurely (e.g. when an animation finishes before the sound sample, when changing scenes and a dialog is immediately started afterwards). This is by design (new animations and scene changes stop sounds that are already playing), so this requires changes to the way new scenes are started. We need to verify what the original does here.

Bugs

  • Pathfinding bugs in Fort Apache and the Indian village - e.g. when moving to the door on the right, the hero walks around a big path. Same when moving to the tent on the top in the Indian village. (this also happens in the original - check this video)
  • Offering (pick-up/give) the Union Flag to the 'sleeping' Sergeant in the cell initiates voice playback of "I've already seen it" but subtitle on screen displays "I doubt it would interest him". The text is correct but the voice is not - this also happens in the original, [Bug #6228]
  • When getting the piano player off the well, he walks up facing to the left (his side animation is shown) - probably related to pathfinding?
  • Sometimes, some stray lines are drawn below fonts - probably because the text doesn't fit inside the screen and the surface is cut off incorrectly.
  • Some artifacts are drawn on screen occasionally (e.g. when text is shown over an animation).

Done

  • Some of the menu colors are wrong
  • Sound streaming in movies is problematic. Right now, part of the sound of a movie is preloaded and if there's still a sound buffer, it's loaded on the fly. When the sound buffer is later on loaded on the fly, the sound gets off sync. This is notable during the intro of the game (which is the longest video in the game)
  • Save sound volume and panning in saved games
  • Implement music volume
  • Load/start sound and music of the saved scene when loading.
  • Crashes sometimes on scene changes
    • (I guess because some talktext is still running although the slot used by it has changed)
  • Crashes sometimes (e.g. when inside the barn and going up the ladder)
    • These crashes are caused by non-stopping background sounds, see TODO above.
  • The game music is in XMIDI. I'm assuming that the rest of the formats were because of badly dumped resources - finalize() calls were missing and the resulting music could contain anything.
  • Implement dirty rectangles (low priority)
  • Optimize segment mask redrawing (only redraw what's necessary)
  • Add movie playback functionality (movie format is known, needs implementing)
  • Add sound support (after rewrite of the resource system)
  • Still some clipping issues (walking upstairs in the saloon, when on top of the tower in the hideout)
  • Add game menu
    • Rewrite from scratch with only minor stuff from the disasm since the original menu is one huge messy function
  • Rewrite the resource system to something similar as used by M4
    • each resource type gets its own class, the resource cache manages the resource instances
    • generic resource class which has a method that creates a MemoryReadStream
    • rewrite parts of the engine to use the new resource system
  • Extend savegame format (savegame version, description, more data)

External links