62
edits
Difference between revisions of "HOWTO-Engine Release"
Jump to navigation
Jump to search
Update engine data steps, remove steps that are now automated
(Swapped some items for more logical order) |
(Update engine data steps, remove steps that are now automated) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 15: | Line 15: | ||
## 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] | ||
# When the engine is using GUIO, add their description to the [https://docs.scummvm.org/en/ | # When the engine is using GUIO, add their description to the [https://docs.scummvm.org/en/latest/settings/game.html documentation] ([[Developer_Central#Contribution_guide_for_technical_writers|here]] is how to edit the documentation) | ||
# Add the engine author(s) to the ''engines/<your-engine>/credits.pl'' file, in alphabetical order by last name (see [https://github.com/scummvm/scummvm/blob/master/engines/scumm/credits.pl SCUMM engine example]) and run ''make credits'' to update the ''AUTHORS'' and ''credits.h'' files. You should also have scummvm-web repository checked out next to your scummvm directory, and then commit to both repositories. For the web repo the typical commit log message is "WEB: Sync credits". | # Add the engine author(s) to the ''engines/<your-engine>/credits.pl'' file, in alphabetical order by last name (see [https://github.com/scummvm/scummvm/blob/master/engines/scumm/credits.pl SCUMM engine example]) and run ''make credits'' to update the ''AUTHORS'' and ''credits.h'' files. You should also have scummvm-web repository checked out next to your scummvm directory, and then commit to both repositories. For the web repo the typical commit log message is "WEB: Sync credits". | ||
# 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: | ||
## Add it to '' | ## Add it to ''DIST_FILES_LIST'' in ''dists/engine-data/engine_data.mk'' | ||
## On the Buildbot, in the [https://github.com/scummvm/dockerized-bb/blob/master/buildbot-config/builds.py ''buildbot-config/builds.py''] file: | ## On the Buildbot, in the [https://github.com/scummvm/dockerized-bb/blob/master/buildbot-config/builds.py ''buildbot-config/builds.py''] file: | ||
### If there is no <code>DATA_FILES</code> variable defined under the <code>ScummVMStableBuild</code> class, copy the <code>DATA_FILES</code> variable from the <code>ScummVMBuild</code> class to <code>ScummVMStableBuild</code>, | ### If there is no <code>DATA_FILES</code> variable defined under the <code>ScummVMStableBuild</code> class, copy the <code>DATA_FILES</code> variable from the <code>ScummVMBuild</code> class to <code>ScummVMStableBuild</code>, | ||
| Line 35: | Line 30: | ||
### Add engine to the 'engines' tab, make sure it is marked as enabled | ### Add engine to the 'engines' tab, make sure it is marked as enabled | ||
### 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 | ||
### Add game to the 'compatibility' tab | ### Add game to the 'compatibility' tab (to the very bottom, it is sorted by the release) using 'DEV' as the release | ||
## If necessary, update the demos list at [https://docs.google.com/spreadsheets/d/1QzwFleEKXOsE59cYMOcQB7C2f0Np48uAQOCG8kicX_s/edit#gid=713475305 the ScummVM Data spreadsheet] with new game demos | ## If necessary, update the demos list at [https://docs.google.com/spreadsheets/d/1QzwFleEKXOsE59cYMOcQB7C2f0Np48uAQOCG8kicX_s/edit#gid=713475305 the ScummVM Data spreadsheet] with new game demos | ||
# Upload the demos if any | # Upload the demos if any | ||
| Line 45: | Line 40: | ||
## 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 | ## Ask [[User:Sev|sev]] to publish the link on Twitter | ||
## Ask [[User:Rootfather|rootfather]] to publish the news on Mastodon | |||
## Ask [[User:Sev|sev]] to copy the announcement text to the #news channel on Discord | ## Ask [[User:Sev|sev]] to copy the announcement text to the #news channel on Discord | ||
# Publish the website changes | # Publish the website changes | ||
## Access the URL <code>https://www.scummvm.org/admin/update</code> for updating the website. You need to be a member of the website admin group in order to do so. | ## Access the URL <code>https://www.scummvm.org/admin/update</code> for updating the website. You need to be a member of the website admin group in order to do so. | ||