{"id":22376898,"url":"https://github.com/guansss/nep-live2d","last_synced_at":"2025-07-30T23:31:49.544Z","repository":{"id":39559031,"uuid":"163693343","full_name":"guansss/nep-live2d","owner":"guansss","description":"Live2D wallpaper for Neptune, running on Wallpaper Engine.","archived":false,"fork":false,"pushed_at":"2023-01-04T21:38:07.000Z","size":4768,"stargazers_count":51,"open_issues_count":20,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2023-03-04T10:45:36.499Z","etag":null,"topics":["live2d","nodejs","pixijs"],"latest_commit_sha":null,"homepage":"https://steamcommunity.com/sharedfiles/filedetails/?id=1078208425","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/guansss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-31T19:37:19.000Z","updated_at":"2023-02-23T01:55:12.000Z","dependencies_parsed_at":"2023-02-02T20:45:35.559Z","dependency_job_id":null,"html_url":"https://github.com/guansss/nep-live2d","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guansss%2Fnep-live2d","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guansss%2Fnep-live2d/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guansss%2Fnep-live2d/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guansss%2Fnep-live2d/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/guansss","download_url":"https://codeload.github.com/guansss/nep-live2d/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228198886,"owners_count":17883776,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["live2d","nodejs","pixijs"],"created_at":"2024-12-04T22:12:10.560Z","updated_at":"2024-12-04T22:12:11.847Z","avatar_url":"https://github.com/guansss.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nep-live2d\n![GitHub package.json version](https://img.shields.io/github/package-json/v/guansss/nep-live2d?style=flat-square)\n[![Codacy Badge](https://img.shields.io/codacy/grade/2a104c4ef281488bafe5404adb27ee28?style=flat-square\u0026logo=codacy)](https://www.codacy.com/manual/guansss/nep-live2d?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=guansss/nep-live2d\u0026amp;utm_campaign=Badge_Grade)\n[![Steam Subscriptions](https://img.shields.io/steam/subscriptions/1078208425?style=flat-square\u0026logo=steam\u0026color=blue)](https://steamcommunity.com/sharedfiles/filedetails/?id=1078208425)\n![Made with](https://img.shields.io/badge/made%20with-%E2%99%A5-ff69b4?style=flat-square)\n\nBeta versions can be found in the [Beta Test Channel](https://steamcommunity.com/workshop/filedetails/discussion/1078208425/1484358860953044356/)\n\nThe project is based on Live2D WebGL SDK 2.1, and thus models of newer or older version are not supported.\n\n## Setup\n\n#### Dependencies\n\nIt's recommended to use *Yarn* as package manager, *npm* is fine though.\n\n``` sh\nyarn install\n```\n\n#### Source files\n\nDue to copyright restrictions, the files of backgrounds, Live2D SDK and Live2D models are not provided, you need to supply them by yourself.\n\n1. (Optional) Download [Live2D WebGL SDK 2.1](http://sites.cybernoids.jp/cubism-sdk2/webgl2-1) and take `live2d.min.js` within.\n\n2. Create `wallpaper` directory at project root.\n\n3. Copy following files from the distribution of this wallpaper and paste into `wallpaper`. (In Wallpaper Engine, right click on the preview of this wallpaper and select *Open in Explorer*.)\n\n``` sh\n.\n└── /wallpaper\n    ├── /img\n    │    ├── bg_forest.jpg\n    │    ├── bg_halloween.jpg\n    │    └── bg_lowee.jpg\n    ├── /live2d (take entire folder)\n    └── live2d.min.js\n```\n\n## Serving\n\n### Sering for browsers\n\n``` sh\nyarn serve\n```\n\n### Serving for Wallpaper Engine\n\nBy redirecting the running wallpaper to the server, we are able to use the `liveReload` and Hot Module Replacement (HMR) features of Webpack dev server, which are extremely useful for development.\n\nTo achieve that, a script was made to generate a bridge HTML file, there are a few steps to prepare before using this script:\n\n1. Create a folder in `myproject` directory of Wallpaper Engine, for example:\n    ```\n    C:\\Program Files (x86)\\Steam\\steamapps\\common\\wallpaper_engine\\projects\\myprojects\\live2d\n    ```\n\n2. Go back to this project, create `.env.local` file at project root, add `WALLPAPER_PATH` variable which describes the destination of output files.\n\n    ``` sh\n    WALLPAPER_PATH=C:\\Program Files (x86)\\Steam\\steamapps\\common\\wallpaper_engine\\projects\\myprojects\\live2d\n    ```\n\n    For more information about the format of this file, see [dotenv](https://github.com/motdotla/dotenv).\n\n3. Run following command. You may be asked for confirmations to overwrite existing files.\n\n    ``` sh\n    yarn setup\n    ```\n\n4. Check the Wallpaper Engine browser, a new wallpaper should appear with `[DEV]` prefix.\n\nThis preparation should be done only once, but any time you think the generated files are supposed be updated, you need to run `yarn setup` again.\n\nNow, just like serving for browsers, run `yarn serve`, and then select the wallpaper, everything will work as it should be in browsers.\n\n## Building\n\n``` sh\nyarn build\n```\n\nIf you are updating an existing Workshop project instead of creating a new one, you need to specify a `WORKSHOP_ID` in `.env.local` before building the project.\n\n``` sh\nWORKSHOP_ID=123456\n```\n\nWhen publishing to Workshop, don't forget to copy files in `/wallpaper` and paste them into your project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguansss%2Fnep-live2d","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguansss%2Fnep-live2d","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguansss%2Fnep-live2d/lists"}