Skip to content

Commit

Permalink
updated the readme set version number to 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
cmclark00 committed Mar 15, 2023
1 parent cfe9215 commit fe5e34e
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,35 @@
### The purpose of this script is to extract, move, and organize all of your XBLA game archives for easy integration into EmulationStation Desktop Edition

## Why it's necessary:
### Due to the way that XBLA games are packaged ES-DE can't normally recognize the games as being in your Roms/xbox 360 folder. This is because XBLA games are packaged in a pirs file which is only used for the xbox 360, and which have no file extension, which ES-DE uses to recognize the game files. It is possible to do all of the work this program does by hand, it's just a little tedious.
### The way that Xbox Live Arcade games were packaged was kind of weird. They were stored in a pirs container, which is like a weird archive format that only the xbox 360 used. In the past ES-DE couldnt see these files because they dont actually have a file extension. Now That it can it is much easier to organize your XBLA library using this tool.

## How it works:
### The way the script works is by calling the patoolib module to extract the archives from the XBLA folder to the XBLA_Unpacked folder.
### At this point there is code in place to rename all of the subdirectories in the directory created from the archive to match the main directory.
### Finally, the code will rename the default.xex file to the same name as the main directory and then do some subdirectory cleanup by moving all of the game files up a few levels into that main directory and deleting any unused and unnecessary subdirectories and files.
### It then renames the innermost file, the pirs file, to the name of the top level directory, which is your game name.
### Next it moves the newly renamed pirs file to the XBLA_Unpacked folder and deletes the original directory that the pirs file was in.
### At this point the program will ask if you want it to delete the original Rar archives for you. If you enter "Y" the program will delete the archives and give a confirmation message and end, otherwise the program will give a termination message.
### Now you should have a nice clean folder full of all of your XBLA games organized, named correctly, and without any unnecessary junk.
### The final step is all on you, it's time to move all of the game folders over to your Roms/xbox 360 folder in your EmulationStation DE directory.

## Important note: When scraping in ES-DE make sure you use thegamesDB as your source, for some reason ScreenScraper doesn't seem towork well with these files.
## Important note: When scraping in ES-DE make sure you use thegamesDB as your source, for some reason ScreenScraper doesn't seem to work well with these files.



Prerequisites:

Make sure you have a modern version of Python 3 installed, you can check this with python --version in the command line.
Make sure you have some kind of unarchiving program that can handle Rar files.
Make sure the archive name is less than 250 characters. This is a limit made by wxPirs and i can't do anything about it.
Make sure there are no random files in your archive. There shouldn'tn be any text files. If there are, delete them. The only file that should be in your archive is the PIRS file at the innermost subdirectory.
Make sure there are no random files in your archive. There shouldn't be any text files. If there are, delete them. The only file that should be in your archive is the PIRS file at the innermost subdirectory.
Make sure there are no apostrophe's in the Rar files name. For instance, if you try to use this tool with Alan Wake's American Nightmare, it will fail. Just remove the apostrophe and you're all good.

Instructions for use:

In the comand line install patool using "pip install patool".
Also install pynput the same way.

Download the zipped project file and extract all of its contents to your home directory.
In Windows this is usually C:\Users\username.
In Linux this is usually /home/username.

Delete the text files named delete me from both the XBLA and XBLA_Unpacked folders.

Place all of your archived XBLA games in the XBLA folder.
If the archive name doesn't match the title of the game then fix that now.

Expand All @@ -46,4 +43,3 @@ Now you can move all of the game folders over to your Roms/xbox 360 folder in yo

### If you need to run the script again make sure the XBLA_Unpacked folder is empty. If it isn't empty the script will crash.

Special note for Linux users, you will have to use wine to run wxPirs. Linux is not currently supported because wxPirs does some weird things when ran through wine. I am working on it, but since Xenia doesn't officially support linux either at the moment it just isn't a priority.

0 comments on commit fe5e34e

Please sign in to comment.