Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: hacking guide & flowchart #1188

Merged
merged 8 commits into from
Aug 6, 2023
Merged

docs: hacking guide & flowchart #1188

merged 8 commits into from
Aug 6, 2023

Conversation

Derisis13
Copy link
Collaborator

Pull Request Template

Type of change

  • Bug fix
  • Feature
  • Documentation update

Description

Medium-sized writeup about how to modify ani-cli for sites with similar structure.
No code was modified.

Checklist

  • any anime playing
  • bumped version

  • next, prev and replay work
  • -c history and continue work
  • -d downloads work
  • -s syncplay works
  • -q quality works
  • -v vlc works
  • -e select episode works
  • -S select index works
  • -r range selection works
  • --dub and regular (sub) mode both work
  • all providers return links (not necessarily on a single anime, use debug mode to confirm)

  • -h help info is up to date
  • Readme is up to date
  • Man page is up to date

Additional Testcases

  • The safe bet: One Piece
  • Episode 0: Saenai Heroine no Sodatekata ♭
  • Unicode: Saenai Heroine no Sodatekata ♭
  • Non-whole episodes: Tensei shitara slime datta ken (ep. 24.5, ep. 24.9)

@Derisis13
Copy link
Collaborator Author

lol svg is text format after all, so it works really well with git... I didn't write a 771 line documentation (but maybe I should bump it 6 lines?)

Copy link
Collaborator

@port19x port19x left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use a rendered, non-transparent png or jpg image to embed into hacking.md

As is, the flowchart is barely visible in githubs dark mode

## Prequisites
Here's the of skills you'll need and the guide will take for granted:
- basic shell scripting
- understanding of http(s) requests and proficiency with curl
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- understanding of http(s) requests and proficiency with curl
- understanding of http(s) requests

hacking.md Outdated
The extension webapi-blocker can help you with bringing up the debugger that we'll use during this guide or to conceal the presence of a debugger.
These reverse-engineering protections are always evolving though so there's no silver bullet - you'll have to do your own research on how to get around them.

As a nuclear option you can resort to [Burp Suite](https://portswigger.net/burp/communitydownload).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not beginner friendly, and unnecessarily complicated imo

@justchokingaround
Copy link
Collaborator

i've been thinking of writing a shellscript webscraping guide as a separate repo. what would be better, incorporating a lot of new information into this ani-cli guide, or having a more detailed guide in a separate repo, and have this guide only mention which things should be changed in the ani-cli script specifically?
i'll probably also add an example for a new provider implementation

@justchokingaround
Copy link
Collaborator

we should also mention the existence of debug mode in sh, since that would make the troubleshooting process much easier, rather than seeing error messages such as Episode not found

@port19x
Copy link
Collaborator

port19x commented Aug 4, 2023

we should also mention the existence of debug mode in sh, since that would make the troubleshooting process much easier, rather than seeing error messages such as Episode not found

Yeah, sh -x is big

@CoolnsX
Copy link
Collaborator

CoolnsX commented Aug 4, 2023

we should also mention the existence of debug mode in sh, since that would make the troubleshooting process much easier, rather than seeing error messages such as Episode not found

My french brother is alive

@port19x
Copy link
Collaborator

port19x commented Aug 6, 2023

i've been thinking of writing a shellscript webscraping guide as a separate repo. what would be better, incorporating a lot of new information into this ani-cli guide, or having a more detailed guide in a separate repo, and have this guide only mention which things should be changed in the ani-cli script specifically? i'll probably also add an example for a new provider implementation

There is something like really good in your stars list iirc. I wouldn't bother

@justchokingaround
Copy link
Collaborator

blatzar/scraping-tutorial ?

@port19x port19x merged commit bb71279 into master Aug 6, 2023
@port19x port19x deleted the docs branch August 6, 2023 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants