Skip to content

Commit

Permalink
Edit readme for clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
nianeyna committed Nov 12, 2024
1 parent ad7fef7 commit f2e4f2b
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ As of January 17, 2023 I have changed how file names are generated (again). All
- You may change certain behaviors of the script by editing the file <!--CHECK-->settings.ini<!--INI_FILE_NAME-->. Current configurable options are:
- Whether the script should save your password - if set to 'false', you will need to re-enter your password every time you log in via the script.
- How many seconds to pause between requests to Ao3 - the default is 0 seconds, which means that pauses will only be initiated when Ao3 requests them. Normally you should not need to adjust this, but it can be useful if you are running into odd behavior related to the rate limit.
- The file naming pattern to use. For most people ao3downloader's default file names should work fine, but if you don't like them, you can change that here.
- **The purpose of entering your ao3 login information** is to download archive-locked works or anything else that is not visible when you are not logged in. If you don't care about that, there is no need to enter your login information.
- **Ao3 limits the number of requests** a single user can make to the site in a given time period. When this limit is reached, the script will pause for the amount of time (usually a few minutes) that Ao3 requests. When this happens, the start time, end time, and length of the pause in seconds will be printed to the console. If you try to access Ao3 from your browser during this period, you will see a "Retry later" message. Don't be alarmed by this - it's normal, and you aren't in trouble. Simply wait for the specified amount of time and then refresh the page. Other than during these required pauses, you can use Ao3 as normal while the script is running.
- **If you choose to '<!--CHECK-->get works from all encountered series links<!--AO3_PROMPT_SERIES-->'** then if the script encounters a work that is part of a series, it will also download the entire series that the work is a part of. This can _dramatically_ extend the amount of time the script takes to run. If you don't want this, choose 'n' when you get this prompt. (Series that you have bookmarked directly will always be fully downloaded, regardless of what you choose here.)
Expand All @@ -102,16 +103,17 @@ As of January 17, 2023 I have changed how file names are generated (again). All
## Known Issues
- With the exception of series links, if you enter a link to an ao3 page that contains links to works or series, but does not support multiple pages of results, the script will loop infinitely. Most notably, this applies to user dashboard pages. If this happens, you can close the window to get out of the loop.
- The script will enter an infinite loop if you give it a link to an ao3 page that contains links to works or series, but does not support multiple pages of results. The most common example of this is user dashboard pages. (To download an author's works, make sure to put in the link to their "works" page, and not their "dashboard" page.) If you get into an infinite loop, you can simply close the window to get out of it.
- When downloading missing fics from series, if you are logged in, and the downloader finds a link to a series that is inaccessible because you do not have permission to access the series page, the downloader will download all of the works linked on your user dashboard page, instead. Yes... really.
- Links containing more than 4095 characters may cause issues on Mac and Linux. To work around this (on Mac and Linux only!) enter `stty -icanon` into your terminal before running ao3downloader. When you are finished running ao3downloader, enter `stty icanon` to restore the default behavior. H/t github user verotheelf for this workaround.
- Links containing more than 8191 characters will cause problems on Windows. There is no workaround, other than using a different link. Thankfully, it is unlikely you will run into this problem, as 8191 characters is quite a lot.
## Troubleshooting
- Make sure your python version number is not lower than 3.9.0 and is not higher than the most recent version confirmed to work with this script (this number is listed in the [Announcements](#announcements) section). If your python version is too low or too high, uninstall python, then install the version linked in [Announcements](#announcements). To check which version of python you are using:
- Windows: open a command prompt and enter "python --version"
- Mac: open a terminal window and enter "python3 --version"
- **Make absolutely sure** that your active python version has a version number that **is not lower than** 3.9.0 and **IS NOT HIGHER THAN** the most recent version confirmed to work with this script (this number is listed in the [Announcements](#announcements) section). If your python version is too low **OR TOO HIGH** (did you hear me? make sure your python version number is not too high!), uninstall python, then install the version linked in [Announcements](#announcements). Then **check** that your active version is correct. To check which version of python is active:
- Windows: open a command prompt and enter `python --version`
- Mac or Linux: open a terminal window and enter `python3 --version`
- Ensure that you have unzipped the repository (see the note about unzipping in the [Instructions](#instructions)). Furthermore, ensure that you have not accidentally clicked in to the original, zipped version of the code. The original zip folder will allow you to open it with a double-click as if it was a regular folder, and will display the same list of files, but it's all a lie. You must run ao3downloader from an *unzipped* file folder. On most operating systems, the zipped version will have a zipper in the icon. Don't use that version. Unzip, and use the version with a regular, zipperless icon.
- If you are able to create <!--CHECK-->logvisualization.html<!--VISUALIZATION_FILE_NAME--> (menu option 'v'), take a look through the logs to see if there are any helpful error messages.
- If there are no logs or the logs are unhelpful, look for a folder called "venv" inside the repository. Delete "venv" and try re-running the script. (Re-running the script will re-create "venv" - that's fine. You only need to do this step once.)
- If deleting venv doesn't work, try deleting the entire repository and re-downloading from github (but remember to save your existing downloads and log files if you have any!)
Expand Down

0 comments on commit f2e4f2b

Please sign in to comment.