Git Product home page Git Product logo

elite-journal-connector's Introduction

Elite Journal Connector

This Chrome Web extension reads the game Journal and allows websites to read it without other tools.

How to

As a website developer, you should look at the 'examples' folder to understand how communication works between the background, content and page scripts.

The extension will inject itself into the active tab once the user clicks the extension icon in the browser.

Retrieving journal events is as simple as the following:

window.addEventListener("message", (event) => {
    if (event.data.source === 'Elite Journal Connector') { // Always check this
        switch (event.data.command) {
            case 'loading': // This event is the first message, extension is injected into the page.
                break;
            case 'loaded': // The extension has finished loading initial Journal data.
                break
            case 'journal': // Any Journal event
                if (this.loaded || this.fullJournal && !this.loaded)
                    this.parseEvent(event.data.event)
                break;
        }
    }
})

Ideas

Better communication API

Web page listens for extension injection using window.addEventlistener

Extension injects (content script) and sends a message (content script) to the web page (page script) using window.postMessage

It also waits (content script) for commands from the web page, for example to fetch all journal data

Web page (script page) receives the message and asks for initial journal data using window.postMessage (sent to content)

Content then asks background to get the data and background sends it back as a whole.

ToDos

  • Configure elite folder location

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.