Git Product home page Git Product logo

edrefcard's Introduction

Build status

  • live Build Status Coverage Status
  • beta Build Status Coverage Status
  • dev Build Status Coverage Status

Purpose

Elite: Dangerous has a great many command bindings to learn. To help with that, EDFRefCard generates a printable reference card from your Elite: Dangerous bindings file.

Currently hosted at https://edrefcard.info/.

Dependencies

  • Python 3.6 or later

    • Python3 module lxml
    • Python3 module wand
    • Python3 module pytest
    • Python3 module pytest-cov
    • Python3 module coveralls
  • ImageMagick v6 (at the time of writing python wand doesn't support ImageMagick v7)

    • you may need to configure the MAGICK_HOME env var to get wand to see the ImageMagick libraries.

Installation in a web server

  • Base the server on the www subdirectory of this repo.
  • Check that your server is supplying the env vars CONTEXT_DOCUMENT_ROOT and SCRIPT_URI so that Config.dirRoot and Config.webRoot in www/scripts/bindings.py get set correctly. Apache 2 does this by default. Python's cgi.test() is useful here.
  • Enable Apache's rewrite and cgi or cgid mods.
  • Add redirects as follows (in Apache 2 notation):
RewriteEngine On
RewriteRule ^/list$ /scripts/bindings.py?list=all
RewriteRule ^/binds/(.+)$ /scripts/bindings.py?replay=$1
RewriteRule ^/configs/([a-z][a-z])([^/]+)$ /configs/$1/$1$2
RewriteRule ^/devices$ /scripts/bindings.py?devicelist=all
RewriteRule ^/device/(.+)$ /scripts/bindings.py?blocks=$1
  • Certain web servers, including Apache 2 on Debian 9, are prone to set brain-dead IO encodings, such as ANSI_X3.4-1968. To fix this, add the following at the end of /etc/apache2/apache2.conf:
SetEnv PYTHONIOENCODING utf-8

Docker

Build a docker container:

docker build -t edrefcard .

Run the docker container in the background, exposed on port 8080 on the host:

docker run -d --rm --name edrefcard -p 8080:80 edrefcard

EDRefCard can then be accessed at http://localhost:8080

Credits

EDRefCard is derived with permission from code originally developed by CMDR jgm.

edrefcard's People

Contributors

ajhewett avatar esabouraud avatar mwerle avatar richardbuckle avatar slion 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.