Uma Musume: Pretty Derby Toolbox

.NET CLI implementation of Rockisch's umamusu-utils project. Thank you Rockisch! I couldn't have done this without your script!

I've recreated the data_download.py script and added a config file called, appsettings.json. It's already in this repo if you want to check it out!

For those who don't know about the original project, this program will download the game's assets (models, videos, etc.) onto your computer for PERSONAL USE ONLY. You will want to use something like Perfare's Asset Studio to properly extract these files.

I've also added detailed error messages for easier troubleshooting because there are a few assets we can't download due to "forbidden" access (error code 403). Though, I've noticed that re-running the program after a while can remedy this issue.

NOTE: The only non-configurable option that's different from Rockisch's script is that I have this process set to 200 concurrent (asynchronous) downloads. This works in batches. Meaning it won't move onto the next 200 assets until the current batch has finished downloading.

Initial Setup

If you don't already have .NET 6 on your computer, you'll need to download the latest for either the ".NET Runtime" (to run the program) or the "SDK" (for building the solution and development).

To check if you've installed it correctly, open either command prompt or terminal and use this command:

dotnet --version

If it returns with a version number of at least 6.0, you're good to run the program after you unzip it.

One last thing I have to stress to you. SET UP THE appsettings.json FILE! By default, it's set up to my folder locations and I doubt you have a user profile name of "kento". I left it there as a working example so you don't have to assume anything. Check below for a further explanation of the config file.

Config File Explanation

• IsDebugMode
  • If set to true, this will output additional info in your console, specifically when it is downloading a single file and has finished downloading that file. Creates a lot of text on the screen, but if you want to keep a closer eye on the progress, this is here for you.
  • If set to false, then all you see are error messages and "complete X of Y files". The progress message will only show up when it's taking on another batch of files.
• MasterDbFilepath
  • This file is the core of where all of the data is stored for this game. Typically on a Windows machine using DMM, the master.mdb file is stored in the path below. The reason for the double backslash \\ is to "escape" the backslash character. Please don't forget this if you're using a Windows machine!
    • Typical path: C:\\Users\\<your_username>\\AppData\\LocalLow\\Cygames\\umamusume\\master\\master.mdb
• MetaDbFilepath
  • This file is the meta file to grab the assets of the game. Please read above why the \\ exist in this example.
    • Typical path: C:\\Users\\<your_username>\\AppData\\LocalLow\\Cygames\\umamusume\\meta
• SkipExistingFiles
  • If set to true, this will only attempt to download missing files in the saved location you pointed this program to.
  • If set to false, this will download all of the files, regardless if they exist already.
• TimeoutFromMinutes
  • This is the limit of how long a download can take before it times out. I personally have mine set to 5 minutes on a 5 MB/s download because the default 100 seconds that's built-in didn't work for me for some of the bigger assets.
• UserSavedLocation
  • This is where your downloaded files will be stored. It will create the directory path if it doesn't exist. Make sure you have permission to the file path you've set this to. I picked the %USERPROFILE% location because its the current user's directory.
    • Example path: C:\\Users\\<your_username>\\uma_storage

TODO List

• Create a VS code configuration and make this Linux friendly.
• Recreate the items_extract and story_extract scripts as separate projects within this solution.