Jessidhia / skyline-overlay

A modern customizable horizon FFXIV miniparse overlay. | 现代定制化 FF14 水平悬浮窗模板。

Skyline Overlay

A modern customizable horizon FFXIV miniparse overlay.

An extended version from horizoverlay with some of ikegami's features. The project is based on React with MobX & Vite, and the dedicated ffxiv-overlay-api.

Overlay Link

• CloudFlare (Global): https://skyline.dsrkafuu.net
• Mirror (CN DieMoe): https://act.diemoe.net/overlays/skyline/

Usage

Need to be used with ngld/OverlayPlugin. For WebSocket mode, checkout Vite Docs' Browser Support Section for compatible browsers.

Note that backdrop-filter support needs to be enabled manually on Firefox, check Can I use for more details.

By 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.

Local:

git clone https://github.com/dsrkafuu/skyline-overlay.git
cd skyline-overlay
npm install
npm start

Env

VITE_BASE_URL="./" # dist base url
VITE_GA_ID="" # analytics id

Contribute

Clone this repo, install packages and run the development server:

git clone https://github.com/dsrkafuu/skyline-overlay.git
cd skyline-overlay
npm install
npm run dev

Add Translations

Please use ISO 639-1:2002 defined 2-letter code as filename, use ja as an example:

1. Create a new ja.json file in @/src/lang, use en.json as a template
2. Import ja.json in @/src/lang/index.js
3. Add a new lang in @/src/lang/index.js exported map, like ja: { translation: ja },

Add Custom Themes

1. Create a new your-theme-filename.scss file in @/src/themes, use default.scss and ikegami.scss as examples
2. Import your-theme-filename.scss in @/src/themes/index.js
3. Add a new theme in @/src/themes/index.js exported map, like 'your-theme-filename': { text: 'The New Theme' }

Contributors

@DieMoe233 @Slightlyxz

Major Dependencies

• React: https://reactjs.org/
• MobX: https://mobx.js.org
• Vite: https://vitejs.dev
• ffxiv-overlay-api: https://github.com/dsrkafuu/ffxiv-overlay-api
• Job Icons: https://github.com/xivapi/classjob-icons/tree/master/svg

LICENSE

Released under Apache License 2.0, for more information read the LICENSE.

Copyright © 2020-present DSRKafuU (https://dsrkafuu.net)