annabunches/inara_updater
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Overhaul our readmes.

Browse Source
This commit is contained in:
Anna Rose 2016-01-21 14:09:20 -05:00
parent 631d608385
commit 95e70f5097
2 changed files with 39 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
FreePIE/Readme.md Normal file
View File

@ -0,0 +1,8 @@
# FreePIE Scripts for Elite: Dangerous.
Requires [FreePIE](http://andersmalmgren.github.io/FreePIE/) to use, obviously.
### x52pro_mfd_freedom.py
Turns the Saitek X52-Pro MFD buttons into usable buttons within Elite. This clobbers several keys on the numpad,
(1-6, 7, and 9) so if you're already using those for something, this script may conflict with your setup.

43
Readme.md
View File

@ -1,20 +1,39 @@
# Command-line tools for Elite: Dangerous # Tools and scripts
Currently, this package provides two simple python scripts for Elite: Dangerous. This package provides a collection of scripts I have found useful for Elite: Dangerous.
### elite_info.py
elite_info fetches the user's credit balance and current location from the E:D Companion API,
and prints this information. In the future it will be able to display additional data.
### update_inara.py ### update_inara.py
update_inara will fetch your location and credit balance from E:D, update_inara will fetch your location and credit balance from E:D,
and update your inara.cz profile automatically. and update your inara.cz profile automatically. There is also a Windows binary available. (soon)
## Usage ### elite_info.py
Run one of the tools to create a blank config file, or copy the provided one into ~/.ed_tools/. elite_info fetches the user's credit balance and current location from the E:D Companion API,
Provide your username and password in the config, then run either script again. It will prompt and prints this information. With --dump, it will print *everything* returned by the Companion API.
you for a verification code. Check your inbox for this code. (you should only have to do this once)
### FreePIE
This directory contains scripts used with the FreePIE software. See FreePIE/Readme.md for details.
## Using the Python Scripts
### In Linux
First, make sure you have the git submodules and the required python tools:
git submodule init
git submodule update
pip install -r requirements.txt
pip install -r inara/requirements.txt
Now, just run the script:
./update_inara.py
### In Windows
Download and run update_inara.exe. (coming soon)