XNA Game Studio Cleanup Tool User’s Guide


XNA Game Studio Cleanup Tool User’s Guide

Introduction

The XNA Game Studio cleanup tool is designed to automatically perform a set of steps to remove selected versions of XNA Game Studio from a computer.  It will remove files, directories, registry keys and values and Windows Installer product registration information for XNA Game Studio.  The tool is intended primarily to return your system to a known (relatively clean) state in case you are encountering XNA Game Studio installation, uninstallation or repair errors so that you can try to install again.

There is a very important caveat that you should review before using this tool to remove any version of XNA Game Studio from your system:

  • This tool is designed as a last resort for cases where install, uninstall, repair or patch installation did not succeed for unusual reasons.  It is not a substitute for the standard uninstall procedure.  You should try to uninstall XNA Game Studio from Add/Remove Programs prior to using this tool.

Download location

The XNA Game Studio cleanup tool is available for download at the following locations:

The .zip file that contains the tool also contains a file named history.txt that lists when the most recent version of the tool was published and what changes have been made to the tool over time.

Supported products

The XNA Game Studio cleanup tool supports removing the following products:

  • XNA Game Studio 2.0
  • XNA Game Studio 3.0
  • XNA Game Studio 3.1
  • XNA Game Studio 4.0
  • XNA Game Studio 4.0 Refresh
  • Windows Phone Developer Tools 7.0
  • Windows Phone SDK 7.1

Silent installation mode

The XNA Game Studio cleanup tool supports running in silent mode.  In this mode, the tool will run without showing any UI, and the user must pass in a version of XNA Game Studio to remove as a command line parameter.  To run the cleanup tool in silent mode, you need to download the cleanup tool, extract the file cleanup_tool.exe from the zip file, and then run it using syntax like the following:

cleanup_tool.exe /q:a /c:”cleanup.exe /p <name of product to remove>”

The value that you pass with the /p switch to replace <name of product to remove> in this example must exactly match one of the products listed in the Supported products section above.  For example, if you would like to run the cleanup tool in silent mode and remove XNA Game Studio 3.0, you would use a command line like the following:

cleanup_tool.exe /q:a /c:”cleanup.exe /p XNA Game Studio 3.0″

Unattended installation mode

The XNA Game Studio cleanup tool supports running in unattended mode.  In this mode, the tool will run and only show a progress dialog during removal, but will require no user interaction.  Unattended mode requires the user to pass in a version of XNA Game Studio to remove as a command line parameter.  To run the cleanup tool in unattended mode, you need to download the cleanup tool, extract the file cleanup_tool.exe from the zip file, and then run it using syntax like the following:

cleanup_tool.exe /q:a /c:”cleanup.exe /p <name of product to remove> /u”

For example, if you would like to run the cleanup tool in unattended mode and remove XNA Game Studio 2.0, you would use a command line like the following:

cleanup_tool.exe /q:a /c:”cleanup.exe /p XNA Game Studio 2.0 /u” 

Exit codes

The cleanup tool can return the following exit codes:

  • 0 – cleanup completed successfully for the specified product
  • 3010 – cleanup completed successfully for the specified product and a reboot is required to complete the cleanup process
  • 1 – cleanup tool requires administrative privileges on the machine
  • 2 – the required file cleanup.ini was not found in the same path as cleanup.exe
  • 4 – a product name was passed in that does not exist in cleanup.ini
  • 100 – cleanup was able to start but failed during the cleanup process
  • 1602 – cleanup was cancelled

Log files

The cleanup tool creates the following log files:

  • %temp%\cleanup_main.log – a log of all activity during each run of the cleanup tool; this is a superset of the logs listed below as well as some additional information
  • %temp%\cleanup_actions.log – a log of actions taken during removal of each product; it will list files that it finds and removes, product codes it tries to remove, registry entries it tries to remove, etc.
  • %temp%\cleanup_errors.log – a log of errors and warnings encountered druing each run of the cleanup tool

 

xnags_cleanup_tool.zip

Comments (31)

  1. nunorelvao says:

    It seems that i have already tried everything including this tool , but sill the problem presists…

    It always asks me to uninstall Windows Phone Developer Tools.

    Tried already to:

    -Uninstall:

     – All Silverlight CTP , SDK, Toolkits even the runtime.

     – All XNA Framework related all versions

     – I have now only the VS2010 Ultimate

    Remove:

     – Use your tool and remove all and reboot

     – Manually delete all keys encountered with "Windows Phone".

    Sill i have no luck the problem is the same still!

  2. Hi Nunorelvao – If you’ve already tried the uninstall tool and you’re still being blocked from installing the CTP Refresh due to incompatible products, then can you please use the tool in the blog post at http://blogs.msdn.com/astebner/archive/2005/07/01/434814.aspx to gather a list of installed products on your system, then post the log file it creates to a file server (such as http://skydrive.live.com/) and reply here with a link I can use to download the log and take a look?

    Also, a note for the future for anyone else reading this blog post – you should never need to manually remove registry keys to solve this type of problem.  Doing so can be dangerous because it will leave your computer in an unknown state.  You should allow the normal uninstall process to remove registry keys for you.

  3. Hi Nunorelvao – Thanks for posting the file.  It looks like you’re also discussing this issue on the XNA Creators Club forums at http://forums.xna.com/forums/p/52634/319291.aspx, so I’m going to go ahead and reply there rather than duplicating replies in 2 places.

    If anyone else runs into similar issues in the future, please post a question on the XNA Creators Club forums as well.

  4. Morten says:

    Do you have an updated version that works with the newer CTP? I can't uninstall that to put the new beta on, which was released today.

  5. Hi Morten – I just uploaded an updated version of the cleanup tool.  However, the previous version was already configured to allow you to remove the previous CTPs so you shouldn't need a new version for that scenario.  What exact error did you see while trying to uninstall the previous CTP on your system?

  6. Evgheni says:

    Having the same issue. There is no error message on uninstall. After running the July 12th version of the tool, "Windows Phone Developer Tools" is still listed in 'Add Remove Programs'.

    'Windows Install Clean Up' tool does not show it in lists.

    Removing all registry entries with 'Windows Phone' and restarting does not help either.

    Can you please tell, how 'vm_web.exe' installer detects previous version?

  7. Lucas says:

    Hey, the only program that I can't uninstall is Microsoft Windows Phone Developer Tools CTP.

    My problem is exactly the same as the guy's problem in this page: social.msdn.microsoft.com/…/45d21430-f1e6-4da8-80dd-71e9c4452bf6

    But, if I use the cleanup tool, it doesn't work… What do I have to do?

  8. Hi Evgheni and Lucas – The WPDT beta setup uses information in the file blocker.sdb that is packaged inside of vm_web.exe to decide whether or not old versions of the product are still installed.  I uploaded a copy of this file for the WPDT beta setup to cid-27e6a35d1a492af7.office.live.com/…/WPDT%5E_Beta%5E_Blocker.sdb.  What I do in this scenario is look in %temp%dd_install_vm_xcor_100.txt to see the exact name of the component that it thinks is an older version, then I go to blocker.sdb and look for the information about what registry key is being used to check the version number.

    Can you please give that a try and see if it helps you narrow this down further?  If it doesn't help, please post your file %temp%dd_install_vm_xcor_100.txt to a file server such as http://skydrive.live.com, then reply back here with a link that I can use to download the log file and take a further look.

  9. Lucas says:

    Thanks! I got it!

    [Microsoft Windows Phone Developer Tools CTP Refresh]

    VersionCheck=FileRegVerCheck

    DetectKey=HKLM,SOFTWAREMicrosoftWindowsCurrentVersionUninstall{8D6C687E-56A5-3563-86F7-ECF3B4FD3C0F}

    DetectKeyVal=DisplayVersion

    DetectKeyValData=

    HelpLink=Block_on_Non_Dev10_RC_component_vm_exp.htm

    I have deleted the reg "DisplayVersion". Now it installs… Let me see if it is going to work…

    Thanks!!!!

  10. ED says:

    I'm having the same problem, I uninstalled XNA 4 CTP then tried to uninstall Win Phone Dev Tools CTP – ENU, but that just says "install these apps" and it lists a few… I tick them all and it downloads and tries to install, but all of them fail.

    I tried using the xnags_cleanup_tool but that says its succesfull but it still detects Win Phone Dev Tools CTP when trying to install XNA 4.

  11. Hi ED – Do the steps in my previous comment (using dd_install_vm_xcor_100.txt and blocker.sdb) help resolve your issue?  If not, please post your file %temp%dd_install_vm_xcor_100.txt to a file server such as http://skydrive.live.com, then reply back here with a link that I can use to download the log file and take a further look.

  12. Lucas says:

    Everything Workds, but the Windows Phone 7 Emulator doesnt…

    It gives me an error:

    "Failed to connect to "Windows Phone 7 Emulator".  ( The rest is in portuguese(my windows's language) saying that the configuration data for this product are corrupted. )

    I guess I have to reinstall the Windows Phone 7 Emulator, but from where I can get it?

  13. Hi Lucas – It might help to do the following for this error:

    1.  Close Visual Studio

    2.  Delete the following folders – %LocalAppData%MicrosoftPhone Tools and %ProgramData%MicrosoftXDE

    3.  Re-open Visual Studio again and try to deploy to the emulator

    If this doesn't help, then I'd suggest posting a question on the Windows Phone forums at social.msdn.microsoft.com/…/windowsphone to see if someone there is able to provide some additional suggestions for you to try.

  14. Andrew says:

    Hi, I can't even find an uninstaller for XNA 4 CTP in Add/Remove programs, been looking for 30mins on a way to remove this, and I can't try the original CTP installer as Microsoft has replaced the page with the Beta version. Compared my add/remove list to a recent install on my colleagues PC and his is correct. What's the recommended manual solution? cheers

  15. Ziyan-Junaideen says:

    Astebner,

    You seem to be the angle who could save me. I was so curious, I straight away ran the setup of the new 'Developer Tools' and it prompted that some things needed to be uninstalled first. I managed to uninstall some but one remained not possible (uninstaller turns arround and downloads file to install itself).

    As you instructed Lucas I opened up "dd_install_vm_xcor_100.txt" and it seems as though 'Developer Tools' is the problem maker for me.

    "[07/13/10,23:37:26] VS Scenario: ***ERRORLOG EVENT*** : Error: CVSScenario::ExecuteEachBlocker returned false

    [07/13/10,23:37:26] Setup.exe: AddGlobalCustomProperty

    [07/13/10,23:37:26] VS Scenario: ***ERRORLOG EVENT*** : Error:There is a blocking condition met, the installer is blocking because of Section :

    [07/13/10,23:37:26] Setup.exe: AddGlobalCustomProperty

    [07/13/10,23:37:26] VS Scenario: ***ERRORLOG EVENT*** : Microsoft Windows Phone Developer Tools CTP Refresh"

    I took a look in to the 'blocker.sdb' which you posted.

    So what should be my next move? Delete the registry? I haven't done any thing like this, would like to have instructions. I would like to get moving within the next couple hours 😉

    Thank you,

  16. Hi Andrew – The uninstall process for the Windows Phone Developer Tools CTP will automatically uninstall the XNA Game Studio 4.0 CTP, so that might be why you don't see it in your Programs and Features control panel.  What I'd recommend in your case is to remove the rest of the Windows Phone Developer Tools CTP using the XNA Game Studio cleanup tool and then run setup for the Windows Phone Developer Tools Beta.

    There are some additional details about this scenario at blogs.msdn.com/…/10037442.aspx as well, so you may want to review the information in that post as well.

  17. Hi Ziyan-Junaideen – I'd suggest that you try to use the steps at blogs.msdn.com/…/487096.aspx to locate and manually remove the Windows Phone Developer Tools CTP – ENU product, then try to re-run WPDT Beta setup.

    If you don't have a Windows Phone Developer Tools CTP – ENU product installed on your computer when you use those instructions, then I'd suggest manually renaming the registry key listed in blocker.sdb for this component as a last resort.

  18. john says:

    hi, i tried to install the beta tool.  but i did not do the uninstall in that order.  so, now i am stuck with .net framework 4 multi-targeting pack, which i thought i manually uninstalled already.  so, here is my dd log.

    [07/13/10,23:17:21] VS Scenario: [2] Error: CVSScenario::ExecuteEachBlocker returned false

    [07/13/10,23:17:21] VS Scenario: [2] Error:There is a blocking condition met, the installer is blocking because of Section :

    [07/13/10,23:17:21] VS Scenario: [2] .NET Framework 4 Multi-Targeting Pack

    [07/13/10,23:17:24] VS Scenario: [2] Failed to pass the Warnings/Blocks checks in CVSScenario::Start()

    here is my msiinv output.

    cid-7c88adc00befb492.office.live.com/…/msiinv%5E_output.txt

    so, how do i remove multi-targeting pack?

    thanks

    jw

  19. Hi John – Your msiinv output doesn't show the .NET Framework 4 Multi-Targeting Pack being installed on your system.  In this scenario, I think you will need to manually rename the registry value that is causing the WPDT Beta installer to think that you still have this multi-targeting pack installed on your system.  That registry key should be located at the following location:

    [HKEY_LOCAL_MACHINESOFTWAREMicrosoftDevDivnetfxServicing4dtp]

    Version < 30319.01

    On a 64-bit OS, this key will be at the following location instead:

    [HKEY_LOCAL_MACHINESOFTWAREWow6432NodeMicrosoftDevDivnetfxServicing4dtp]

    Version < 30319.01

  20. Vlada says:

    Hello,

    I am another one, who traing uninstall Phone Developer Tools CTP form April in bad order.

    The solution from Lucas seems to be function.

    The only one thing, it can't be uninstalled is just "Microsoft Windows Phone Developer Tools CTP", but all other parts was uninstalled (Phone emulator too).

    So i do the same, as Lucas…

    first run the cleanup tool from this page.

    And after it, delete (rename) "DisplayVersion" key value in

    HKLM,SOFTWAREMicrosoftWindowsCurrentVersionUninstall{8D6C687E-56A5-3563-86F7-ECF3B4FD3C0F}

    Now the instalation of new beta was successfull.

    But the "Microsoft Windows Phone Developer Tools CTP" item still stay in "Add/Remove Programs".

    I am not sure, if it can be any problem… ?

  21. Hi Vlada – The items listed in the Programs and Features control panel are controlled by the registry entries under HKEY_LOCAL_MACHINESoftwareMicrosoftWindowsCurrentVersionUninstall.  Just because something is listed there doesn't mean it is actually installed though.  In your case, since the beta installed fine, you can probably just go to that registry location and manually remove the entry for the CTP.  It won't hurt anything to leave it as is though.

  22. Roger says:

    Thanks for this…

  23. fuacici says:

    Excellent tool!Thanks so much.

  24. Terry says:

    Hi.  Thanks for the explanations.  I have the same problem as Lucas and others.  Problem is that I cannot find the file, dd_install_vm_xcor_100.txt.  Could it be missing?  

    Thanks in advance.

  25. Hi Terry – What is the exact problem you are running into?  I'm not sure if you're having trouble uninstalling a previous beta or installing the final release of the Windows Phone Developer Tools.

    It might help to take a look at the post at blogs.msdn.com/…/10037442.aspx to see if either of the workarounds there help solve this issue on your computer.

  26. Ben says:

    Worked a treat for cleaning up sdk 7.1 . Many Thanks

  27. Yves says:

    Hi. I think Windows Phone SDK 7.1 was not installed properly. I try to re-install it's impossible. I use the xnags cleanup tool but still can't install Windows Phone SDK 7.1.

  28. Rafi says:

    Oh you saved me with your "magic" tool !!!!!!!! Thanks a lot, really. I appreciate your work

  29. James G says:

    I am looking for the exact order to uninstall all parts of the Windows phone SDK 7.1.1 from my old windows 7 laptop, i dont need it anymore, and just want to uninstall everything in the correct order that is all thanks.

  30. Hi James G – I'm sorry, but I don't have an exact list of components.  Instead, I'd suggest doing one of the following:

    1.  Go to the Programs and Features control panel and uninstall the item named Windows Phone SDK 7.1.  This will automatically uninstall all sub-components for you in the correct order.

    or

    2.  Run the XNA Game Studio cleanup tool (using one of the download links at the top of this blog post) and choose to remove the Windows Phone SDK 7.1.  This also will automatically uninstall all sub-components for you in the correct order.