plugin-ao3

Download novels from ao3 or publish novels to ao3.

input

Can be combined with other plugins to convert to other formats, such as epub.

tasks:
  - name: fetch
    input:
      name: '@mark-magic/plugin-ao3'
      config:
        url: https://forums.sufficientvelocity.com/threads/puella-magi-adfligo-systema.2538/
        site: sufficientvelocity
        cached: true
    output:
      name: '@mark-magic/plugin-epub'
      config:
        path: ./dist/epub/puella-magi-adfligo-systema.epub
        id: pmas
        title: Puella Magi Adfligo Systema
        creator: Firnagzen

Fortunately, an epubhub plugin has been implemented based on this plugin, which can download epubs from fan fiction websites without using the lower-level mark-magic command-line tool.

url

The URL for downloading the novel. The book ID will be automatically identified. For example, the following links will be correctly identified:

• https://archiveofourown.org/works/777002/chapters/1461984
• https://archiveofourown.org/works/777002/

This plugin also supports the following websites as inputs.

• https://forums.sufficientvelocity.com
• https://forums.spacebattles.com/
• https://www.bilibili.com/read/home

cookie (input)

Optional cookie configuration. If you want to download novels that require login to read, you need to fill in this configuration. Please refer to the explanation of output > cookie below for details.

output

Publish markdown novels to other places or synchronize novels from sv/sb forums to ao3.

For example, the configuration for publishing the Chinese translation of pmas to ao3 is as follows, see: https://github.com/liuli-moe/pmas/blob/main/mark-magic.config.yaml#L54-L66

tasks:
  - name: publishToAo3
    input:
      name: '@mark-magic/plugin-local'
      config:
        path: ./books/zh-CN
        ignore:
          - '999.md'
          - '12*.md'
    output:
      name: '@mark-magic/plugin-ao3'
      config:
        id: '53445904'
        cookie: ${AO3_COOKIE}

id

The book ID to be synchronized. For example, the book ID of https://archiveofourown.org/works/777002/ is 777002.

cookie

Authentication information after logging in to ao3. You can copy the cookie from the browser's developer tools.

⚠️ Note: Please do not send cookies to others or publish them on the internet, as having them is equivalent to having account passwords! If you want to synchronize configuration files, you should use environment variables to reference confidential information.

Specific steps

1. Log in to the ao3 website.

2. Open the developer console from the menu More Tool > Developer Tools, or use Command+Option+I(Mac)/Ctrl+Shift+I(Windows).

3. Switch to the Network tab.

4. Refresh the webpage.

5. Find the first request and right-click to select Copy > Copy as cURL.

6. Find the cookie from the cURL command. The cookie in the simplified curl command below is view_adult=true; user_credentials=1; ********67f.

   curl 'https://archiveofourown.org/works/777002/chapters/1461984' \
    -H 'cookie: view_adult=true; user_credentials=1; ********67f'
    --compressed