HOWTO-Engine Release

From ScummVM :: Wiki
Revision as of 20:59, 28 April 2017 by Csnover (talk | contribs) (Initial instructions for new engine release)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Once an engine has been accepted into the master branch, finished, and is ready to be playtested, do this stuff to get it ready:

  1. Change any ADGF_UNSTABLE flags in the engine’s detection table to ADGF_TESTING
  2. Change the [build-by-default] flag in the engine’s configure.engine file to yes
  3. Update the game’s information pages in the wiki:
    1. Change the game’s category from Category:Unsupported Games to Category:Supported Games
    2. Set the Support status in the infobox to the next ScummVM release version
    3. Fill out any other missing information in the infobox
  4. Add the new game(s) to the NEWS file
  5. If necessary, add special notes to section 3 of the README file
  6. Add the engine author(s) to the AUTHORS file
  7. Make sure Datafiles is up-to-date
  8. Publish a news entry announcing game testing at scummvm/scummvm-web:data/news/ (e.g. Full Pipe announcement)
  9. Update the compatibility data at scummvm/scummvm-web:data/compatibility/compat-DEV.xml with compatibility information for the new game(s)
  10. If necessary, update the demos list at scummvm/scummvm-web:data/game_demos.xml with new game demos