{"id":16582218,"url":"https://github.com/dsrkafuu/skyline-overlay","last_synced_at":"2025-04-07T13:08:48.640Z","repository":{"id":40432071,"uuid":"304912621","full_name":"dsrkafuu/skyline-overlay","owner":"dsrkafuu","description":"A modern customizable horizon FFXIV miniparse overlay. | 现代定制化 FF14 水平悬浮窗模板。","archived":false,"fork":false,"pushed_at":"2024-12-15T17:29:59.000Z","size":18677,"stargazers_count":71,"open_issues_count":8,"forks_count":10,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-31T12:05:25.836Z","etag":null,"topics":["act","ffxiv","ffxiv-overlay-api","ffxiv-overlays","overlay","overlayplugin-skin","react","reactjs","typesctipt","vite"],"latest_commit_sha":null,"homepage":"https://skyline.dsrkafuu.net","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dsrkafuu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"ko_fi":"dsrkafuu"}},"created_at":"2020-10-17T15:48:37.000Z","updated_at":"2025-03-30T22:18:19.000Z","dependencies_parsed_at":"2024-11-05T07:26:36.955Z","dependency_job_id":"a157e240-64f1-420b-81d3-caa95c4935f5","html_url":"https://github.com/dsrkafuu/skyline-overlay","commit_stats":{"total_commits":486,"total_committers":8,"mean_commits":60.75,"dds":0.191358024691358,"last_synced_commit":"07e9f551b4b93d4aaa10ecaaf2a5156c96f54313"},"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsrkafuu%2Fskyline-overlay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsrkafuu%2Fskyline-overlay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsrkafuu%2Fskyline-overlay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsrkafuu%2Fskyline-overlay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dsrkafuu","download_url":"https://codeload.github.com/dsrkafuu/skyline-overlay/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247657281,"owners_count":20974345,"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":["act","ffxiv","ffxiv-overlay-api","ffxiv-overlays","overlay","overlayplugin-skin","react","reactjs","typesctipt","vite"],"created_at":"2024-10-11T22:32:00.009Z","updated_at":"2025-04-07T13:08:48.609Z","avatar_url":"https://github.com/dsrkafuu.png","language":"TypeScript","funding_links":["https://ko-fi.com/dsrkafuu"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/dsrkafuu/skyline-overlay/main/public/favicon.svg\" alt=\"Skyline Logo\" width=\"128\" /\u003e\u003cbr /\u003e\n  Skyline Overlay\n  \u003cbr /\u003e\n\u003c/h1\u003e\n\n\u003ch4 align=\"center\"\u003eA modern customizable horizon FFXIV miniparse overlay.\u003c/h4\u003e\n\u003cbr /\u003e\n\n![](https://img.shields.io/github/package-json/v/dsrkafuu/skyline-overlay)\n![](https://img.shields.io/badge/ffxiv-dawntrail-orange)\n[![](https://img.shields.io/github/license/dsrkafuu/skyline-overlay)](https://github.com/dsrkafuu/skyline-overlay/blob/main/LICENSE)\n[![](https://img.shields.io/lgtm/grade/javascript/github/dsrkafuu/skyline-overlay)](https://lgtm.com/projects/g/dsrkafuu/skyline-overlay/context:javascript)\n\nFeatures: Basic overlay, extended details, customizable display/data settings, battle history, custom colors, sw cache and more. The project is based on React 18, and the dedicated [ffxiv-overlay-api](https://github.com/dsrkafuu/ffxiv-overlay-api).\n\n\u003cimg align=\"center\" src=\"https://raw.githubusercontent.com/dsrkafuu/skyline-overlay/main/assets/preview-en-v37.jpg\" alt=\"Skyline Preview\" /\u003e\n\n\u003cimg align=\"center\" src=\"https://raw.githubusercontent.com/dsrkafuu/skyline-overlay/main/assets/preview-zh-v37.jpg\" alt=\"Skyline Preview CN\" /\u003e\n\n## Overlay Links\n\n- CloudFlare (Global): `https://skyline.dsrkafuu.net/`\n- Mirror (CN FFCafe): `https://overlays.ffcafe.cn/skyline/`\n- Mirror (CN DieMoe): `https://overlay.diemoe.net/skyline/`\n\n## Usage\n\nCheck [ngld/OverlayPlugin](https://github.com/ngld/OverlayPlugin). For WebSocket mode, note that `backdrop-filter` support needs to be enabled manually on Firefox, check [Can I use](https://caniuse.com/css-backdrop-filter) for more details.\n\n2K+ (WQHD+) screen with 1.2+x scale is recommended for better experience in FFXIV.\n\nClick the encounter can ends current battle and start a new one; zone name will be fully displayed when hover; click the DPS meter on encounter bar can switch to show HPS.\n\nBy default the overlay follows the pet-merging policy set in the FFXIV ACT Plugin. When playing on global servers with a custom language patch which causes the plugin's pet-merging not working, you can set your ID in an overlay config to manually merge your pets' data.\n\nYou can use [CSSNANO](https://cssnano.co/playground/) to minify your CSS into single line.\n\n## Browsers Support\n\nSupports major browser versions released at 2020 or `ES2020`.\n\n- Chrome: \u003e=87\n- Firefox: \u003e=78\n- Safari: \u003e=14\n\n## Cache Rules\n\nThe app uses Service Workers to cache all the assets, which makes it ready for offline usage after the first time.\n\nWhen releasing a new version, you can wait for the pop-up notification to confirm the cache update, or use Ctrl+F5 to force refresh the app.\n\n## Environment\n\n```\nVITE_BASE_URL=\"/\"     # dist base url (optional)\nVITE_GA_ID=\"\"         # google analytics id\n```\n\n## Local Build\n\n```bash\ngit clone https://github.com/dsrkafuu/skyline-overlay.git\ncd skyline-overlay\npnpm install\npnpm run build\n```\n\n## Online Debug\n\n![Debug URL Query](https://raw.githubusercontent.com/dsrkafuu/skyline-overlay/main/assets/debug-1.png)\n\n1. Add `debug=1` to the URL\n2. Open the debug tool of ACT plugin\n3. Reload the overlay in ACT plugin\n4. Do somethings which will trigger the issue\n5. Save the log and upload it like below\n\n![Debug Log Save](https://raw.githubusercontent.com/dsrkafuu/skyline-overlay/main/assets/debug-2.png)\n\n## Contribute\n\n```bash\ngit clone https://github.com/dsrkafuu/skyline-overlay.git\ncd skyline-overlay\npnpm install\npnpm run dev\n```\n\n### Add Translations\n\nPlease use [ISO 639-1:2002](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) defined 2-letter code as filename, use `ja` as an example:\n\n1. Create a new `ja.json` file in `@/src/lang`, use `en.json` as a template\n2. Import `ja.json` in `@/src/lang/index.js`\n3. Add a new lang in `@/src/lang/index.js` exported map, like `ja: { translation: ja },`\n\n### Add Custom Themes\n\n1. Add a new author in `@/src/themes/support/authors.ts`\n2. Create `@/src/themes/\u003cname\u003e.ts` and `@/src/themes/\u003cname\u003e.scss`\n3. Configure your theme in `@/src/themes/\u003cname\u003e.ts`\n4. Write theme styles in `@/src/themes/\u003cname\u003e.scss`\n\n#### Customizable Colors\n\nAll themes has pre-defined colors, check out `@/src/themes/default.ts` and `@/src/themes/horiz.scss` for examples.\n\nIf you'd like to add colors to your theme that users can customize, add a `theme` key to your colors object in `@/src/themes/\u003cname\u003e.ts`.\n\n```ts\nconst myColors: Colors = {\n  common: [0, 0, 0, 0.3],\n  self: [118, 118, 118, 1],\n  ...\n  theme: {\n    fg: [255, 255, 255],\n    bg: [0, 0, 0, 0.3],\n    bga: [85, 85, 85],\n  },\n};\n```\n\nThese variables will now be accessible within your `.scss` file as `var(--color-theme-\u003ckey\u003e)`, where `\u003ckey\u003e` is the color key name.\n\n### Contributors\n\n[@DieMoe233](https://github.com/DieMoe233)\n[@j0sh77](https://github.com/j0sh77)\n[@Slightlyxz](https://github.com/Slightlyxz)\n[@thewakingsands](https://github.com/thewakingsands)\n\n## Credits\n\n- ffxiv-overlay-api: \u003chttps://github.com/dsrkafuu/ffxiv-overlay-api\u003e\n- Job Icons: \u003chttps://github.com/xivapi/classjob-icons/tree/master/svg\u003e\n- jsDelivr: \u003chttps://www.jsdelivr.com\u003e\n- MiSans: \u003chttps://home.miui.com\u003e\n\n## LICENSE\n\nReleased under `Apache License 2.0`, for more information read the [LICENSE](https://github.com/dsrkafuu/skyline-overlay/blob/main/LICENSE).\n\n**Copyright © 2020-present DSRKafuU (\u003chttps://dsrkafuu.net\u003e)**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsrkafuu%2Fskyline-overlay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdsrkafuu%2Fskyline-overlay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsrkafuu%2Fskyline-overlay/lists"}