Directory Structure

This document provides a detailed overview of the file and directory structure of the Ultimate Web Novel & Manga Scraper repository.

Root Directory

FilePurpose
ultimate-manga-scraper.phpCore Plugin File. Handles initialization, hooks, cron scheduling, scraping logic, settings pages, and database interactions. Effectively the "God Object" of the plugin.
index.phpSilence is golden. Prevents directory listing.
LICENSELegal terms (Unlicense + Disclaimer).
README.mdGeneral documentation.
sitemap.txtSitemap template or artifact.
sitemap_box.txtSitemap template or artifact.
sitemap_vip.txtSitemap template or artifact.
NOTICE.mdThird-party software attributions.
SECURITY_DISCLOSURE.mdSecurity policy.
CHANGELOG.mdVersion history.
ARCHITECTURE.mdSystem architecture documentation.
DATA_FLOW.mdData flow documentation.
SECURITY.mdSecurity analysis documentation.
CONFIGURATION.mdConfiguration reference.
DEPLOYMENT.mdDeployment guide.
TROUBLESHOOTING.mdTroubleshooting guide.
DOCUMENTATION_INDEX.mdIndex of all documentation.

includes/

Contains helper classes for specific integrations.
FilePurpose
class-madara-fetcher.phpMadara Theme Integration. Handles fetching manga lists and details specifically for Madara-based sites using AJAX endpoints.
class-madara-handler.phpAdmin Handler. Manages the "Madara Enhancements" admin page, AJAX actions for adding manga, and searching.

res/

Contains resources, libraries, and sub-modules.
File/DirectoryPurpose
simple_html_dom.phpLibrary. PHP Simple HTML DOM Parser for parsing scraped HTML.
ImageResize/Library. PHP class for resizing images.
mangafox-master/Library. Specialized scraper library for FanFox (MangaFox). Contains its own composer.json and structure.
phantomjs/Binary/Script. Contains phantom.js script used by the PhantomJS executable.
puppeteer/Binary/Script. Contains puppeteer.js node script used for headless scraping.
ums-main.phpAdmin UI. Settings page layout.
ums-rules-list.phpAdmin UI. Logic for displaying and managing scraping rules (Manga).
ums-novel-list.phpAdmin UI. Logic for displaying and managing scraping rules (Novels).
ums-logs.phpAdmin UI. Activity logging interface.
ums-translator.phpLogic. Google Translate API integration (Free/Scraping method).
ums-translator-microsoft.phpLogic. Microsoft Translator API integration.
UMSJavaScriptUnpacker.phpLogic. Decodes packed JavaScript often found on manga sites (eval/packer).
synonyms.datData. Data file for synonyms (possibly for text spinning).
other/Misc. Contains plugin-dash.php (dashboard widgets) and generic JS scripts.

images/

Plugin assets.
FilePurpose
icon.pngPlugin icon.
image-placeholder.jpgFallback image for missing manga covers.
running.gif, ok.gif, failed.gifStatus indicators for the admin UI.

scripts/

Frontend and Admin JavaScript.
FilePurpose
main.jsCore admin JS.
madara-enhancements.jsJS for the "Madara Enhancements" tab (AJAX loading/adding).
footer.jsJS loaded in the admin footer.

styles/

CSS Stylesheets.
FilePurpose
ums-rules.cssStyling for the rules list tables.
ums-browser.cssStyling for the embedded browser or scrapers.
coderevolution-style.cssGeneric plugin styles.

languages/

Translation files.
FilePurpose
ultimate-manga-scraper.potPOT template for internationalization.