VnPower
4.8 KiB
A unified documentation for PixivFE
Proposals
This section contains some potential features or redesigns that can be implemented into PixivFE.
Pixivision
Summary: Pixivision is a service owned by Pixiv that publishes articles about various types of artwork themes...
Notes: Pixivision is an independent service. Most of the data comes from Pixivision's website. Pixivision does not provide an API for data access. Pages on Pixivision seems to be static, so the HTML could be easily parsed.
Thoughts:
- Write a separate module for Pixivision and integrate it into PixivFE.
- We do web scraping and HTML parsing for this one.
Sketch
Summary: Sketch is a service owned by Pixiv that allow users to livestream, mostly for their drawing process.
Notes: Sketch is an independent service. Most of the data comes from Pixivision's website. Sketch has a dedicated API for data access. Sketch uses the same type of authentication that Pixiv has. Detailed notes TBA.
Thoughts:
- Thanks to the public API, pages could be build easily.
- For the streaming part, we may have to include a JavaScript library for HLS streaming.
Ugoira support
Summary: Ugoiras are Pixiv's "animated image" format.
Notes: Ugoiras are basically a bunch of sorted images combined with a fixed delay for each of them. Pixiv provides one JSON endpoint for delays and filenames and one endpoint for the (ZIP) images archive. One has to write their own player based on things Pixiv provide. You can checkout Pixiv's implementation on their own ugoira player here.
Thoughts:
- GIF/APNG/WEBP renderer.
- Some people want to convert ugoiras to video formats? (no idea)
Landing page
Summary: PixivFE's homepage.
Notes: Pixiv's homepage contains a lot of interesting contents. PixivFE's backend for the landing page already implemented almost all of the data from Pixiv. The only thing left is to write the frontend for them. Detailed notes TBA.
Thoughts:
- Spend some time to write some HTML/SCSS.
- Currently, you have to authenticate (login) in order to access the full landing page. Can we show the full page to unauthenticated users as well?
Popular artworks
Summary: Pixiv has a "Sort by views" and "Sort by bookmarks" feature that is only available for premium users.
Notes: There are some search "hacks" that could yield relatively accurate results for popular artworks.
Ideas:
- Look into repos that attempts to retrieve popular artworks
- If search "hacking" is possible, could there be more "hacks" around?
"User discovery" page
Summary: Like artwork discovery, but it is for users.
Notes: Currently, we do not know if we could implement the "user follow" function into PixivFE. The development for this page has been put on hold because of it, since "following", after all, is what you want to do if you discover an user you like.
Ideas:
- It is easy to implement thanks to the API.
Search suggestions
Summary: Pixiv provides an API endpoint for search suggestions.
Notes: The search suggestions appear when you focus on the search bar.
Ideas:
- We can prefetch the search suggestions for every requests on PixivFE. But this means we will have to add one request (to Pixiv's API) for each PixivFE page request. (Caching?)
- We can implement JavaScript to fetch the suggestions every time the user focuses on the search bar.
- We can create a separate page just for this.
App API support
Summary: Apart of the public AJAX API, Pixiv also provides a private API, used specifically for mobile applications.
Notes: Because you already could do almost everything through the AJAX API, there is really no point to integrate the App API. I added this section because there are some limitations to the public API (following,...).
Ideas:
- Write more stuff when desperate.
Novel page
Image grid layout
Series
Server's PixivFE Git version/commit
Artwork filters
Quick download button
Download all buttons for all containers
Filters
Page profile
Option to open in new tabs
Download button in artwork page
Option to select default image quality in artwork page
Flaws
This section documents some bad/buggy designs in PixivFE's design, both frontend and backend.
Cookies management / validation
All cookie values could be set directly without validation. Should we be concerned?
"Switchers"
Switchers should know what the current value is.
"kmutex"
Sometimes panics.
References
This section contains multiple external links to materials/resources that could help.