Skip to content

Commit

Permalink
README file and help option updated.
Browse files Browse the repository at this point in the history
  • Loading branch information
Dracovanys committed Jan 12, 2025
1 parent 5e33596 commit 1639f91
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,19 @@ A tool to set up your POPS! Created based on the quickstart created by ShaolinAs
- Conversion of CUE files to VCD format (CUE2POPS).
- Merging of multiple tracks (binmerge).
- Creation of POPSTARTER files for each VCD.
- Automatic writing of the "conf_apps.cfg" file for POPS access in OPL.
- Automatic writting of the "conf_apps.cfg" file for POPS access in OPL.
- Deep verification of CUE and BIN files to prevent errors.
- Automated multi-disc setup.

## Usage/Example

Currently, it is only possible to use CidPOPS on Windows OS through a terminal. Additionally, I have only programmed the setup for USB, but in the near future, I will be programming setups for SMB and HDD. Below is the help text for the program:

```
usage: CidPOPS.exe [-h] [-c [CONVERTVCD]] [-m [MERGETRACKS]] [--opl] [--ps1_pfx] [games_dir] [pops_iox]
usage: main.py [-h] [-c [CONVERTVCD]] [-m [MERGETRACKS]] [-md5 [GETMD5]] [--opl] [--ps1_pfx] [games_dir] [pops_iox]
A tool for setup your POPS! || By Dracovanys || Credits: israpps/ErikAndren (CUE2POPS); putnam/cgarz (binmerge); krHACKen/shaolinassassin (POPStarter)
A tool to setup your POPS! || Version: 1.1 || By Dracovanys || Credits: israpps/ErikAndren (CUE2POPS); putnam/cgarz (binmerge); krHACKen/shaolinassassin
(POPStarter)
positional arguments:
games_dir Directory where all your PS1 games are stored.
Expand All @@ -27,8 +30,10 @@ options:
Convert a CUE file to VCD. (Usage.: -c "D:\Downloads\Crash Bandicoot (USA)\Crash Bandicoot (USA).cue")
-m [MERGETRACKS], --mergeTracks [MERGETRACKS]
Merge tracks and generate a new CUE file. (Usage.: -m "D:\Downloads\Crash Bandicoot (USA)\Crash Bandicoot (USA).cue")
-md5 [GETMD5], --getMD5 [GETMD5]
Return MD5 hash of a file. (Usage.: --md5 "D:\Downloads\Crash Bandicoot (USA)\Crash Bandicoot (USA).cue")
--opl Just create "conf_apps.cfg" file.
--ps1_pfx Add "PS1 - " prefix to all OPL shortcuts on "conf_apps.cfg" file (Ex.: "PS1 - Crash Bandicoot (USA)").
--ps1_pfx Add "PS1_" prefix to all OPL shortcuts on "conf_apps.cfg" file (Ex.: "PS1 - Crash Bandicoot (USA)").
```

### POPS Setup (For USB only, at the moment)
Expand Down Expand Up @@ -98,8 +103,6 @@ After that, in the same folder as the CUE file, another folder with the "_Merged

- Automated setup for SMB and HDD.
- GUI using the Tkinter library.
- Deep verification of CUE and BIN files to prevent errors.
- Automated multi-disc setup.

## Credits and Acknowledgements

Expand Down
4 changes: 2 additions & 2 deletions main.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@
# Build root = os.path.dirname(os.path.abspath(sys.argv[0].replace('\\CidPOPS.exe', '')))

# Setting up arguments
parser = argparse.ArgumentParser(description='A tool to setup your POPS! || By Dracovanys || Credits: israpps/ErikAndren (CUE2POPS); putnam/cgarz (binmerge); krHACKen/shaolinassassin (POPStarter)')
parser = argparse.ArgumentParser(description='A tool to setup your POPS! || Version: 1.1 || By Dracovanys || Credits: israpps/ErikAndren (CUE2POPS); putnam/cgarz (binmerge); krHACKen/shaolinassassin (POPStarter)')
# parser.add_argument('setup_type', help='Specify setup type (usb, smb, hdd).')
parser.add_argument('games_dir', nargs='?', help='Directory where all your PS1 games are stored.')
parser.add_argument('pops_iox', nargs='?', help='Path to "POPS_IOX.PAK" if not on CidPOPS directory.')
parser.add_argument('-c', '--convertVCD', nargs='?', help='Convert a CUE file to VCD. (Usage.: -c "D:\\Downloads\\Crash Bandicoot (USA)\\Crash Bandicoot (USA).cue")')
parser.add_argument('-m', '--mergeTracks', nargs='?', help='Merge tracks and generate a new CUE file. (Usage.: -m "D:\\Downloads\\Crash Bandicoot (USA)\\Crash Bandicoot (USA).cue")')
parser.add_argument('-md5', '--getMD5', nargs='?', help='Return MD5 hash of a file. (Usage.: --md5 "D:\\Downloads\\Crash Bandicoot (USA)\\Crash Bandicoot (USA).cue")')
parser.add_argument('--opl', action='store_true', help='Just create "conf_apps.cfg" file.')
parser.add_argument('--ps1_pfx', action='store_true', help='Add "PS1 - " prefix to all OPL shortcuts on "conf_apps.cfg" file (Ex.: "PS1 - Crash Bandicoot (USA)").')
parser.add_argument('--ps1_pfx', action='store_true', help='Add "PS1_" prefix to all OPL shortcuts on "conf_apps.cfg" file (Ex.: "PS1_Crash Bandicoot (USA)").')
args = parser.parse_args()

# Convert VCD
Expand Down

0 comments on commit 1639f91

Please sign in to comment.