Git Product home page Git Product logo

skyline-overlay's Introduction

Skyline Logo
Skyline Overlay

A horizon FFXIV miniparse overlay built with React & Vite.


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.

Skyline Preview

Skyline Extended Preview

Overlay Link

  • CloudFlare: https://skyline.dsrkafuu.su

Need to be used with ngld/OverlayPlugin. For WebSocket mode, only these browsers below are officially supported:

  • Chrome (Chromium) >= 80
  • Safari >= 13 (macOS >= 10.15)
  • Edge >= 80 (new Edge with Chromium)
  • Firefox >= 80

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

To-do List

  • Combatent sort - v1.1.x
  • UI zoom - v1.2.x
  • Multi-lingual support - v1.3.x
  • Combatant number limit - v1.4.x
  • Switch show LB - v1.4.x
  • Short playername - v1.4.x
  • Custom font family - v1.5.x
  • Themes - v1.6.x
  • HPS display - v1.7.x
  • Highlight self - v1.7.x
  • Detailed data for each player - v1.8.x
  • Custom CSS - v1.8.x
  • Optional shorten numbers - v2.0.x
  • C/D/CD tickers - v2.0.x

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 },

Community translators:

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' }

Major Dependencies

LICENSE

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

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

skyline-overlay's People

Contributors

dsrkafuu avatar slightlyxz avatar

Stargazers

sunxyw avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.