rsshub/lib/routes/steam/workshop-search.ts

Make RSS Great Again!

import { Route } from '@/types';

import ofetch from '@/utils/ofetch';
import { load } from 'cheerio';
import { art } from '@/utils/render';
import path from 'node:path';

export const route: Route = {
    path: '/workshopsearch/:appid?/:routeParams?',
    categories: ['game'],
    example: '/steam/workshopsearch/730',
    parameters: {
        appid: 'Steam appid, can be found on the community hub page or store page URL, 730 by default.',
        routeParams: 'Route parameters, can be found on the search result page URL. Route parameters located after the appid.',
    },
    radar: [
        {
            title: 'Workshop Search Results',
            source: ['steamcommunity.com/app/:appid/workshop/'],
            target: '/workshopsearch/:appid',
        },
    ],
    description: `Steam Community Workshop Search Results.
The parameter 'l=language' changes the language of search results(if possible).
For example, route \`/workshopsearch/730/l=schinese\` will display the simplified Chinese descriptions of the entry.

Language Parameter:

| English | 简体中文 | 繁體中文 | 日本語   | 한국어  | ภาษาไทย | български | čeština | dansk  | Deutsch | español | latam | ελληνικά | français | italiano | Bahasa Indonesia | magyar    | Nederlands | norsk     | polski | português  | brasileiro | română   | русский | suomi   | svenska | Türkçe  | Tiếng Việt | українська |
| ------- | -------- | -------- | -------- | ------- | ------- | --------- | ------- | ------ | ------- | ------- | ----- | -------- | -------- | -------- | ---------------- | --------- | ---------- | --------- | ------ | ---------- | ---------- | -------- | ------- | ------- | ------- | ------- | ---------- | ---------- |
| english | schinese | tchinese | japanese | koreana | thai    | bulgarian | czech   | danish | german  | spanish | latam | greek    | french   | italian  | indonesian       | hungarian | dutch      | norwegian | polish | portuguese | brazilian  | romanian | russian | finnish | swedish | turkish | vietnamese | ukrainian  |

`,
    name: 'Community Workshop Search',
    maintainers: ['NyaaaDoge'],

    handler: async (ctx) => {
        const { appid = 730, routeParams } = ctx.req.param();

        const url = `https://steamcommunity.com/workshop/browse/?appid=${appid}${routeParams ? `&${routeParams}` : ''}`;
        const response = await ofetch(url);
        const $ = load(response);

        const appName = $('div.apphub_AppName').first().text();
        const workshopDescription = $('div.customBrowseText').first().text();
        const appIcon = $('div.apphub_AppIcon').children('img').attr('src');

        const items = $('div.workshopBrowseItems .workshopItem')
            .toArray()
            .map((item) => {
                item = $(item);
                const publishedFileId = item.find('a').first().attr('data-publishedfileid');
                const entryTitle = item.find('.workshopItemTitle').first().text();
                const authorNickName = item.find('.workshop_author_link').first().text();
                const previewImage = item.find('.workshopItemPreviewImage').first().attr('src');
                const ratingImage = item.find('.fileRating').first().attr('src');
                // Some items are flaged as 'accepted for game' and 'incompatible item'
                const checkMarkImages: string[] = [];
                $(item)
                    .find('.workshop_checkmark')
                    .each((index, element) => {
                        const checkMarkElement = $(element);
                        const style = checkMarkElement.attr('style');
                        // Only add checkmark image if it is not set to 'display: none'
                        if (!style || !style.includes('display: none;')) {
                            checkMarkImages.push(checkMarkElement.attr('src') || '');
                        }
                    });
                // const script_tag = item.next('script');
                // console.log(`script_tag:${script_tag.text()}`);
                const hoverContent = item.next('script').text();
                const regex = /SharedFileBindMouseHover\(\s*"sharedfile_\d+",\s*(?:true|false),\s*({.*?})\s*\);/;
                const match = hoverContent.match(regex);

                let entryDescription = '';

                if (match) {
                    const jsonString = match[1];
                    // console.log(jsonString);
                    const data = JSON.parse(jsonString);
                    if (data.id === publishedFileId) {
                        entryDescription = data.description;
                    }
                }

                return {
                    title: entryTitle,
                    link: `https://steamcommunity.com/sharedfiles/filedetails/?id=${publishedFileId}`,
                    description: art(path.join(__dirname, 'templates/workshop-search-description.art'), {
                        image: previewImage,
                        rating: ratingImage,
                        checkmark: checkMarkImages,
                        description: entryDescription,
                    }),
                    author: authorNickName,
                };
            });

        return {
            title: `${appName} Steam Workshop Content`,
            link: `https://steamcommunity.com/workshop/browse/?appid=${appid}${routeParams ? `&${routeParams}` : ''}`,
            item: items,
            icon: appIcon,
            description: workshopDescription,
        };
    },
};