BlueGit

timfa hfy-novels

Files

hfy-novels / README.md

README.md

README.md 8.1 KiB Download Raw

HFY Novels

Een LNReader-pluginbron voor verhalen van r/HFY. Deze repository is zelf de plugin-repository: LNReader laadt een plugins.min.json en een gebouwde plugin-JS via de raw-URL van BlueGit.

Vanaf versie 0.3.0 zoekt en ontdekt de plugin live op je telefoon, met de Reddit-sessie uit de LNReader-WebView. Ieder account (jij of iemand anders die de plugin gebruikt) gebruikt zijn eigen cookies. De repo bevat daarnaast een statische metadata-index (titel, auteur, hoofdstukvolgorde, Reddit-IDs — geen verhaaltekst) als laatste fallback, en voor gebruik zonder login.

Hoofdstuktekst wordt pas opgehaald als je een hoofdstuk opent: eerst via Reddit-JSON (met diezelfde WebView-sessie), en bij een fout, 403 of loginpagina via Arctic Shift.

In LNReader zetten

1. Open LNReader → Plugins (of Instellingen → Repos). 2. Voeg deze repository-URL toe, precies zo (inclusief plugins.min.json en ?rev=master):

https://git.timfalken.com/timfa/hfy-novels/-/raw/.dist/plugins.min.json?rev=master

LNReader accepteert alleen een URL die plugins.min.json bevat. Daarna bronnen verversen en de plugin HFY Novels installeren of bijwerken.

BlueGit slaat de repository op als timfa/hfy-novels (kleine letters). Die spelling moet in de URL staan; HFY-Novels geeft een 404.

BlueGit serveert raw-bestanden als text/plain. Dat is voor LNReader geen probleem: de app evalueert de JS zelf en parst de JSON zelf. Een losse .apk-plugin bestaat niet; LNReader-plugins zijn JavaScript uit een repository-manifest.

Wat de plugin kan

  • Bladeren door de live wiki-serie-index van r/HFY (gecached in de plugin-opslag, standaard zes uur).
  • Het tabblad Latest of het filter Nieuw: recente OC-posts, gegroepeerd tot reeksen.
  • Live zoeken op r/HFY (search.json met restrict_sr=1): wiki-series en losse Part 1-posts worden tot één novel gegroepeerd.
  • Een reeks openen: de hoofdstuklijst komt live uit de wiki-inhoudsopgave, of anders via next-links en titelgelijkenis.
  • Een hoofdstuk lezen (eerst Reddit-JSON, anders Arctic Shift; onderaan het hoofdstuk staat welke bron is gebruikt).
  • Filters: Wiki-series / Nieuw, reeksen / oneshots, NSFW verbergen of tonen.

Bij een fout, 403 of loginpagina valt zoeken, bladeren en de hoofdstuklijst terug op Arctic Shift, en daarna op de statische index in deze repo.

Elk verhaal krijgt een deterministische cover uit een hash van de titel: een kleurverloop of patroon, met de titel leesbaar erop. Dezelfde titel geeft altijd dezelfde cover; lange titels worden netjes afgebroken.

  • In de statische index schrijft de indexer een PNG (240×360) in public/covers/ (zonder Pillow een SVG). LNReader laadt covers met expo-image; PNG is daar betrouwbaar, SVG niet altijd.
  • Live gevonden verhalen hebben die vooraf gemaakte PNG niet. Vanaf 0.3.1 maakt de plugin op het toestel dezelfde stijl cover als data:image/png;base64 (pure JS, dezelfde titelhash). LNReader toont die URI in de lijst en in de bibliotheek. Opslaan naar de galerij kan mislukken, omdat die export alleen HTTP-URLs downloadt.

BlueGit kan geen dynamische afbeeldingen serveren, en een SVG-data-URI is in expo-image onbetrouwbaar; vandaar een PNG in de plugin zelf.

Inloggen via de WebView (aanbevolen)

Anonieme Reddit-JSON is sinds 2026 vaak geblokkeerd. Als je in LNReader op reddit.com inlogt, stuurt de plugin die cookies automatisch mee (dezelfde cookie-jar als de WebView; fetchApi gebruikt dezelfde User-Agent).

1. Werk de plugin bij als LNReader een update naar 0.3.1 toont (bronnen verversen, daarna bijwerken). 2. Open de plugin HFY Novels → Website (of in een reeks/hoofdstuk Open in WebView). Je komt op r/HFY. 3. Log in op Reddit met jouw account en sluit de WebView daarna af. Iemand anders (bijvoorbeeld op een andere telefoon) logt met een eigen account in; de sessies blijven gescheiden. 4. Ga terug naar de plugin: Popular toont de wiki-series, Latest (of filter Nieuw) recente OC-posts. Zoek op een titel. Open een reeks en controleer of de hoofdstuklijst klopt, en open daarna een hoofdstuk. Live gevonden reeksen (die niet in de statische index zitten) moeten een gegenereerde cover hebben: kleurverloop of patroon plus de titel, dezelfde stijl als de indexcovers. Zoek twee keer dezelfde titel: de cover moet identiek zijn. Voeg zo'n reeks toe aan je bibliotheek en kijk of de cover blijft staan. 5. Onderaan de hoofdstuktekst staat Bron: Reddit als het via je sessie lukte, of Bron: Arctic Shift (fallback) als Reddit een 403 of loginpagina teruggaf. Zonder login blijven bladeren en lezen werken via Arctic Shift en de statische index.

In de plugin-instellingen kun je de bron vastzetten op Automatisch, Alleen Reddit of Alleen Arctic Shift, en zo nodig de index-URL of Arctic Shift-basis-URL aanpassen.

Hoe de index wordt gemaakt

Het programma indexer/build_index.py gebruikt de officiële wiki-serie-index van r/HFY als catalogus. Per serie komen daar titel, auteur (als die vermeld is) en de link naar de wiki-subpagina (eerste deel of inhoudsopgave) vandaan. Van die subpagina’s haalt de indexer de hoofdstuklinks, en volgt daarna de “next”-links in de posts zelf — met titelgelijkenis, in de geest van hfydl, maar zonder die code te kopiëren.

Omdat anonieme Reddit-JSON (/wiki/series.json en url/.json) sinds 2026 geblokkeerd is, gebeurt het ophalen via Arctic Shift: de wiki-API voor de index en subpagina’s, en /api/posts/ids voor post-metadata (geen /.json). Arctic Shift heeft niet elke wiki-subpagina in het archief; series zonder subpagina én zonder bekende auteur kunnen daardoor ontbreken. Titelzoeken op heel r/HFY wordt door die API geweigerd (te actieve subreddit); met auteur + titel lukt het wel.

De uitvoer staat in public/: een gesplitste catalogus, een zoekindex en per reeks een JSON-bestand met de hoofdstuklijst (geen verhaaltekst). Onderbroken runs hervatten via public/.cache/ (alleen metadata en links).

De plugin heeft geen dagelijkse pipeline nodig: nieuwe verhalen worden op de telefoon ontdekt. De statische index blijft als fallback bestaan en mag handmatig worden ververst. Op master staat daarvoor de job update-index (handmatig, of via een web-pipeline). Om het resultaat terug in de repo te zetten is het optionele geheim INDEX_PUSH_TOKEN nodig (een token met schrijfrechten, niet het job-token). Zonder dat geheim blijft de index een artifact.

Lokaal:

python3 -m unittest discover -s indexer/tests -v
node scripts/build-manifest.js
node scripts/test-plugin.js
python3 indexer/build_index.py --dest public --incremental --max-pages 200

Zet HFY_LIVE=1 bij de plugintest om parseChapter ook tegen de echte Arctic Shift-API te draaien.

Beperkingen

  • Live zoeken en de wiki-index werken het best na inloggen in de WebView. Zonder sessie (of bij een 403) valt de plugin terug op Arctic Shift en daarna op de statische index, die niet elke nieuwe post bevat.
  • De wiki-cache in de plugin-opslag is zes uur geldig; in die periode zie je geen verse wiki-wijzigingen tot de cache verloopt (of je de app-gegevens wist).
  • Next-links en titelgelijkenis kunnen een keten te vroeg stoppen of (zelden) een verkeerde link volgen.
  • Arctic Shift is een onofficieel archief zonder uptime-garantie. Titelzoeken op heel r/HFY wordt door die API soms geweigerd (te actieve subreddit).
  • Auteurs houden het auteursrecht op hun verhalen. Deze repo host die teksten bewust niet. Gebruik is bedoeld voor persoonlijk lezen; een openbare herpublicatie van de teksten is iets anders.
  • --max-pages is een budget voor API-verzoeken bij een handmatige index-run.

Zie docs/ASSUMPTIONS.md voor de aannames en juridische kaders.

Licentie

De code in deze repository is MIT. Dat geldt niet voor de verhalen van r/HFY; die blijven van hun auteurs. hfydl zelf is GPL-3; deze indexer is opnieuw geschreven en bevat geen code daaruit.

Source
1# HFY Novels
2
3Een [LNReader](https://www.lnreader.app/)-pluginbron voor verhalen van [r/HFY](https://www.reddit.com/r/HFY/). Deze repository is zelf de plugin-repository: LNReader laadt een `plugins.min.json` en een gebouwde plugin-JS via de raw-URL van BlueGit.
4
5Vanaf versie **0.3.0** zoekt en ontdekt de plugin **live op je telefoon**, met de Reddit-sessie uit de LNReader-WebView. Ieder account (jij of iemand anders die de plugin gebruikt) gebruikt zijn eigen cookies. De repo bevat daarnaast een statische metadata-index (titel, auteur, hoofdstukvolgorde, Reddit-IDs — geen verhaaltekst) als laatste fallback, en voor gebruik zonder login.
6
7Hoofdstuktekst wordt pas opgehaald als je een hoofdstuk opent: eerst via Reddit-JSON (met diezelfde WebView-sessie), en bij een fout, 403 of loginpagina via [Arctic Shift](https://arctic-shift.photon-reddit.com/).
8
9## In LNReader zetten
10
111. Open LNReader → **Plugins** (of Instellingen → Repos).
122. Voeg deze repository-URL toe, precies zo (inclusief `plugins.min.json` en `?rev=master`):
13
14```
15https://git.timfalken.com/timfa/hfy-novels/-/raw/.dist/plugins.min.json?rev=master
16```
17
18LNReader accepteert alleen een URL die `plugins.min.json` bevat. Daarna bronnen verversen en de plugin **HFY Novels** installeren of bijwerken.
19
20BlueGit slaat de repository op als `timfa/hfy-novels` (kleine letters). Die spelling moet in de URL staan; `HFY-Novels` geeft een 404.
21
22BlueGit serveert raw-bestanden als `text/plain`. Dat is voor LNReader geen probleem: de app evalueert de JS zelf en parst de JSON zelf. Een losse `.apk`-plugin bestaat niet; LNReader-plugins zijn JavaScript uit een repository-manifest.
23
24## Wat de plugin kan
25
26- Bladeren door de live [wiki-serie-index van r/HFY](https://www.reddit.com/r/HFY/wiki/series/) (gecached in de plugin-opslag, standaard zes uur).
27- Het tabblad **Latest** of het filter **Nieuw**: recente OC-posts, gegroepeerd tot reeksen.
28- Live zoeken op r/HFY (`search.json` met `restrict_sr=1`): wiki-series en losse *Part 1*-posts worden tot één novel gegroepeerd.
29- Een reeks openen: de hoofdstuklijst komt live uit de wiki-inhoudsopgave, of anders via next-links en titelgelijkenis.
30- Een hoofdstuk lezen (eerst Reddit-JSON, anders Arctic Shift; onderaan het hoofdstuk staat welke bron is gebruikt).
31- Filters: Wiki-series / Nieuw, reeksen / oneshots, NSFW verbergen of tonen.
32
33Bij een fout, 403 of loginpagina valt zoeken, bladeren en de hoofdstuklijst terug op Arctic Shift, en daarna op de statische index in deze repo.
34
35Elk verhaal krijgt een **deterministische cover** uit een hash van de titel: een kleurverloop of patroon, met de titel leesbaar erop. Dezelfde titel geeft altijd dezelfde cover; lange titels worden netjes afgebroken.
36
37- In de statische index schrijft de indexer een PNG (240×360) in `public/covers/` (zonder Pillow een SVG). LNReader laadt covers met expo-image; PNG is daar betrouwbaar, SVG niet altijd.
38- Live gevonden verhalen hebben die vooraf gemaakte PNG niet. Vanaf **0.3.1** maakt de plugin op het toestel dezelfde stijl cover als `data:image/png;base64` (pure JS, dezelfde titelhash). LNReader toont die URI in de lijst en in de bibliotheek. Opslaan naar de galerij kan mislukken, omdat die export alleen HTTP-URLs downloadt.
39
40BlueGit kan geen dynamische afbeeldingen serveren, en een SVG-data-URI is in expo-image onbetrouwbaar; vandaar een PNG in de plugin zelf.
41
42
43### Inloggen via de WebView (aanbevolen)
44
45Anonieme Reddit-JSON is sinds 2026 vaak geblokkeerd. Als je in LNReader op reddit.com inlogt, stuurt de plugin die cookies automatisch mee (dezelfde cookie-jar als de WebView; `fetchApi` gebruikt dezelfde User-Agent).
46
471. Werk de plugin bij als LNReader een update naar **0.3.1** toont (bronnen verversen, daarna bijwerken).
482. Open de plugin **HFY Novels** → **Website** (of in een reeks/hoofdstuk **Open in WebView**). Je komt op r/HFY.
493. Log in op Reddit met *jouw* account en sluit de WebView daarna af. Iemand anders (bijvoorbeeld op een andere telefoon) logt met een eigen account in; de sessies blijven gescheiden.
504. Ga terug naar de plugin: **Popular** toont de wiki-series, **Latest** (of filter **Nieuw**) recente OC-posts. Zoek op een titel. Open een reeks en controleer of de hoofdstuklijst klopt, en open daarna een hoofdstuk. Live gevonden reeksen (die niet in de statische index zitten) moeten een gegenereerde cover hebben: kleurverloop of patroon plus de titel, dezelfde stijl als de indexcovers. Zoek twee keer dezelfde titel: de cover moet identiek zijn. Voeg zo'n reeks toe aan je bibliotheek en kijk of de cover blijft staan.
515. Onderaan de hoofdstuktekst staat **Bron: Reddit** als het via je sessie lukte, of **Bron: Arctic Shift (fallback)** als Reddit een 403 of loginpagina teruggaf. Zonder login blijven bladeren en lezen werken via Arctic Shift en de statische index.
52
53In de plugin-instellingen kun je de bron vastzetten op *Automatisch*, *Alleen Reddit* of *Alleen Arctic Shift*, en zo nodig de index-URL of Arctic Shift-basis-URL aanpassen.
54
55## Hoe de index wordt gemaakt
56
57Het programma `indexer/build_index.py` gebruikt de officiële [wiki-serie-index van r/HFY](https://www.reddit.com/r/HFY/wiki/series/) als catalogus. Per serie komen daar titel, auteur (als die vermeld is) en de link naar de wiki-subpagina (eerste deel of inhoudsopgave) vandaan. Van die subpagina’s haalt de indexer de hoofdstuklinks, en volgt daarna de “next”-links in de posts zelf — met titelgelijkenis, in de geest van [hfydl](https://github.com/lizard-demon/hfydl), maar zonder die code te kopiëren.
58
59Omdat anonieme Reddit-JSON (`/wiki/series.json` en `url/.json`) sinds 2026 geblokkeerd is, gebeurt het ophalen via [Arctic Shift](https://arctic-shift.photon-reddit.com/): de wiki-API voor de index en subpagina’s, en `/api/posts/ids` voor post-metadata (geen `/.json`). Arctic Shift heeft niet elke wiki-subpagina in het archief; series zonder subpagina én zonder bekende auteur kunnen daardoor ontbreken. Titelzoeken op heel r/HFY wordt door die API geweigerd (te actieve subreddit); met auteur + titel lukt het wel.
60
61De uitvoer staat in `public/`: een gesplitste catalogus, een zoekindex en per reeks een JSON-bestand met de hoofdstuklijst (geen verhaaltekst). Onderbroken runs hervatten via `public/.cache/` (alleen metadata en links).
62
63De plugin heeft geen dagelijkse pipeline nodig: nieuwe verhalen worden op de telefoon ontdekt. De statische index blijft als fallback bestaan en mag handmatig worden ververst. Op `master` staat daarvoor de job `update-index` (handmatig, of via een web-pipeline). Om het resultaat terug in de repo te zetten is het optionele geheim `INDEX_PUSH_TOKEN` nodig (een token met schrijfrechten, niet het job-token). Zonder dat geheim blijft de index een artifact.
64
65Lokaal:
66
67```bash
68python3 -m unittest discover -s indexer/tests -v
69node scripts/build-manifest.js
70node scripts/test-plugin.js
71python3 indexer/build_index.py --dest public --incremental --max-pages 200
72```
73
74Zet `HFY_LIVE=1` bij de plugintest om `parseChapter` ook tegen de echte Arctic Shift-API te draaien.
75
76## Beperkingen
77
78- Live zoeken en de wiki-index werken het best na inloggen in de WebView. Zonder sessie (of bij een 403) valt de plugin terug op Arctic Shift en daarna op de statische index, die niet elke nieuwe post bevat.
79- De wiki-cache in de plugin-opslag is zes uur geldig; in die periode zie je geen verse wiki-wijzigingen tot de cache verloopt (of je de app-gegevens wist).
80- Next-links en titelgelijkenis kunnen een keten te vroeg stoppen of (zelden) een verkeerde link volgen.
81- Arctic Shift is een onofficieel archief zonder uptime-garantie. Titelzoeken op heel r/HFY wordt door die API soms geweigerd (te actieve subreddit).
82- Auteurs houden het auteursrecht op hun verhalen. Deze repo host die teksten bewust niet. Gebruik is bedoeld voor persoonlijk lezen; een openbare herpublicatie van de teksten is iets anders.
83- `--max-pages` is een budget voor API-verzoeken bij een handmatige index-run.
84
85Zie [docs/ASSUMPTIONS.md](docs/ASSUMPTIONS.md) voor de aannames en juridische kaders.
86
87## Licentie
88
89De code in deze repository is [MIT](LICENSE). Dat geldt niet voor de verhalen van r/HFY; die blijven van hun auteurs. hfydl zelf is GPL-3; deze indexer is opnieuw geschreven en bevat geen code daaruit.