Difference between revisions of "HOWTO-Engine Release"
Jump to navigation
Jump to search
m (Fix formatting) |
(Don't forget engine wiki) |
||
Line 3: | Line 3: | ||
# Change any <code>ADGF_UNSTABLE</code> flags in the engine’s detection table to <code>ADGF_TESTING</code> | # Change any <code>ADGF_UNSTABLE</code> flags in the engine’s detection table to <code>ADGF_TESTING</code> | ||
# Change the <tt>[build-by-default]</tt> flag in the engine’s <tt>configure.engine</tt> file to <tt>yes</tt> | # Change the <tt>[build-by-default]</tt> flag in the engine’s <tt>configure.engine</tt> file to <tt>yes</tt> | ||
# Update the game’s information pages in the wiki: | # Update the engine’s and game’s information pages in the wiki: | ||
## Change the engine’s category from [[:Category:Engines Not Added to ScummVM]] to [[:Category:Engines Added to ScummVM]] | |||
## Change the game’s category from [[:Category:Unsupported Games]] to [[:Category:Supported Games]] | ## 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 in form 'Since ScummVM X.X.0' | ## Set the Support status in the infobox to the next ScummVM release version in form 'Since ScummVM X.X.0' | ||
Line 9: | Line 10: | ||
# Add the new game(s) to the [https://github.com/scummvm/scummvm/blob/master/NEWS.md NEWS file] | # Add the new game(s) to the [https://github.com/scummvm/scummvm/blob/master/NEWS.md NEWS file] | ||
# When the engine is using GUIO, add their description to the [https://docs.scummvm.org/en/v2.2-docs/settings/engine.html documentation] | # When the engine is using GUIO, add their description to the [https://docs.scummvm.org/en/v2.2-docs/settings/engine.html documentation] | ||
# 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. | # 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. | ||
# If the engine uses a data file, make sure it is added to the list of files to distribute: | # If the engine uses a data file, make sure it is added to the list of files to distribute: |
Revision as of 21:51, 7 June 2021
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 engine’s and game’s information pages in the wiki:
- Change the engine’s category from Category:Engines Not Added to ScummVM to Category:Engines Added to ScummVM
- 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 in form 'Since ScummVM X.X.0'
- Fill out any other missing information in the infobox
- Add the new game(s) to the NEWS file
- When the engine is using GUIO, add their description to the documentation
- Add the engine author(s) to the credits.pl file and run make credits to update the AUTHORS and credits.h files.
- If the engine uses a data file, make sure it is added to the list of files to distribute:
- Add it to DIST_FILES_ENGINEDATA in Makefile.common
- Add it to dists/scummvm.rc
- Add it to dists/irix/scummvm.idb
- Add it to devtools/create_project/xcode.cpp (in the XcodeProvider::getResourceFiles() function).
- Add it to scumm_package_master in the buildbot master.cfg file.
- Make sure list of datafiles on the game pages are up to date (for example see Beneath_a_Steel_Sky#Required_data_files as a template)
- Make sure the engine and game are added to the bug tracker (engine in Components, game in Custom Fields->game)
- Publish a news entry announcing game testing at scummvm/scummvm-web:data/en/news/ (e.g. Full Pipe announcement). Also, provide to sev several screenshots for the Facebook post
- Copy the news to the forums, General Discussion subforum, mark the post as an announcement
- Ask sev to publish on Facebook and provide the game screenshots
- Copy the announcement text to #news channel on Discord
- Update the Website
- Update the compatibility data at the ScummVM Data spreadsheet with compatibility information for the new game(s)
- If necessary, add the company to 'companies' tab
- Add game to the 'games' tab, don't forget to provide the game hook to the Datafiles
- Add game to the 'compatibility' tab
- If necessary, update the demos list at the ScummVM Data spreadsheet with new game demos
- Run composer update-data for updating the website
- Update the compatibility data at the ScummVM Data spreadsheet with compatibility information for the new game(s)
- Upload demos if any
- After uploading demos, put the links to the data spreadsheet
- Add the game category icon as described here