Difference between revisions of "HOWTO-Engine Release"

Jump to navigation Jump to search
added Twitter
(Update instructions for datafiles list)
(added Twitter)
(5 intermediate revisions by 2 users not shown)
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'
## Fill out any other missing information in the infobox
## Fill out any other missing information in the infobox
# 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]
# If necessary, add special notes to section 3 of the [https://github.com/scummvm/scummvm/blob/master/README.md README file]
# When the engine is using GUIO, add their description to the [https://docs.scummvm.org/en/v2.2-docs/settings/engine.html documentation] ([[Developer_Central#Contribution_guide_for_technical_writers|here]] is how to edit the 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:
Line 21: Line 22:
## Copy the news to the forums, General Discussion subforum, mark the post as an announcement
## Copy the news to the forums, General Discussion subforum, mark the post as an announcement
## Ask [[User:Sev|sev]] to publish on Facebook and provide the game screenshots
## Ask [[User:Sev|sev]] to publish on Facebook and provide the game screenshots
## Ask [[User:Sev|sev]] to publish the link on Twitter
## Copy the announcement text to #news channel on Discord
## Copy the announcement text to #news channel on Discord
# Update the Website
# Update the Website
## Update the compatibility data at [https://docs.google.com/spreadsheets/d/1QzwFleEKXOsE59cYMOcQB7C2f0Np48uAQOCG8kicX_s/edit#gid=854570757 the ScummVM Data spreadsheet] with compatibility information for the new game(s)
## Update the compatibility data at [https://docs.google.com/spreadsheets/d/1QzwFleEKXOsE59cYMOcQB7C2f0Np48uAQOCG8kicX_s/edit#gid=854570757 the ScummVM Data spreadsheet] with compatibility information for the new game(s) (ping [[User:Sev|sev]] or [[User:Mataniko|Mataniko]] for the access)
### If necessary, add the company to 'companies' tab
### 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 'games' tab, don't forget to provide the game hook to the Datafiles

Navigation menu