Difference between revisions of "HOWTO-Engine Release"
Jump to navigation
Jump to search
(Initial instructions for new engine release) |
(Clarify credits update) |
||
Line 9: | Line 9: | ||
# Add the new game(s) to the [https://github.com/scummvm/scummvm/blob/master/NEWS NEWS file] | # Add the new game(s) to the [https://github.com/scummvm/scummvm/blob/master/NEWS NEWS file] | ||
# If necessary, add special notes to section 3 of the [https://github.com/scummvm/scummvm/blob/master/README README file] | # If necessary, add special notes to section 3 of the [https://github.com/scummvm/scummvm/blob/master/README README file] | ||
# Add the engine author(s) to the [https://github.com/scummvm/scummvm/blob/master/ | # Add the engine author(s) to the [https://github.com/scummvm/scummvm/blob/master/devtools/credits.pl credits.pl file] and run ''make credits'' to update the AUTHORS and credits.h files. | ||
# Make sure [[Datafiles]] is up-to-date | # Make sure [[Datafiles]] is up-to-date | ||
# Publish a news entry announcing game testing at [https://github.com/scummvm/scummvm-web/tree/master/data/news scummvm/scummvm-web:data/news/] (e.g. [https://github.com/scummvm/scummvm-web/blob/master/data/news/20161201.xml Full Pipe announcement]) | # Publish a news entry announcing game testing at [https://github.com/scummvm/scummvm-web/tree/master/data/news scummvm/scummvm-web:data/news/] (e.g. [https://github.com/scummvm/scummvm-web/blob/master/data/news/20161201.xml Full Pipe announcement]) | ||
# Update the compatibility data at [https://github.com/scummvm/scummvm-web/blob/master/data/compatibility/compat-DEV.xml scummvm/scummvm-web:data/compatibility/compat-DEV.xml] with compatibility information for the new game(s) | # Update the compatibility data at [https://github.com/scummvm/scummvm-web/blob/master/data/compatibility/compat-DEV.xml scummvm/scummvm-web:data/compatibility/compat-DEV.xml] with compatibility information for the new game(s) | ||
# If necessary, update the demos list at [https://github.com/scummvm/scummvm-web/blob/master/data/game_demos.xml scummvm/scummvm-web:data/game_demos.xml] with new game demos | # If necessary, update the demos list at [https://github.com/scummvm/scummvm-web/blob/master/data/game_demos.xml scummvm/scummvm-web:data/game_demos.xml] with new game demos |
Revision as of 21:26, 28 April 2017
Once an engine has been accepted into the master branch, finished, and is ready to be playtested, do this stuff to get it ready:
- Change any
ADGF_UNSTABLE
flags in the engine’s detection table toADGF_TESTING
- Change the [build-by-default] flag in the engine’s configure.engine file to yes
- Update the game’s information pages in the wiki:
- Change the game’s category from Category:Unsupported Games to Category:Supported Games
- Set the Support status in the infobox to the next ScummVM release version
- Fill out any other missing information in the infobox
- Add the new game(s) to the NEWS file
- If necessary, add special notes to section 3 of the README file
- Add the engine author(s) to the credits.pl file and run make credits to update the AUTHORS and credits.h files.
- Make sure Datafiles is up-to-date
- Publish a news entry announcing game testing at scummvm/scummvm-web:data/news/ (e.g. Full Pipe announcement)
- Update the compatibility data at scummvm/scummvm-web:data/compatibility/compat-DEV.xml with compatibility information for the new game(s)
- If necessary, update the demos list at scummvm/scummvm-web:data/game_demos.xml with new game demos