Skip to content

Latest commit

 

History

History
125 lines (82 loc) · 8.64 KB

README.md

File metadata and controls

125 lines (82 loc) · 8.64 KB
ICARUS Terminal

GitHub Version GitHub License GitHub Downloads

ICARUS Terminal is currently in early access.

About ICARUS Terminal

ICARUS Terminal is a free, immersive, context-sensitive companion app and second screen interface for Elite Dangerous.

You can run ICARUS Terminal in a native window, on multiple windows/displays, as an overlayed window in top of the game if playing with a VR headset or on an ultra-wide display or connect remotely in a browser from another computer/tablet/phone/other devices (e.g. Chromebook, Android Phone/Tablet, Amazon Fire Tablet); the UI is specifically designed with touch screen devices in mind and to adapt the layout of panels to both landscape and portrait displays, both large and small.

 

Download

Screenshots

System Map

System List Ship Status Blueprint Navigation Route

Requirements

The self-contained installer is around 20 MB and has no dependancies. If you are running an older but supported release of Windows, any missing dependancies will be automatically installed.

  • Windows 10 or newer required.
  • No dependancies are required to install the application.
  • No manual configuration or setup is required, it will automatically find your game data.
  • No additional diskspace is required to store game data. Recent game data is loaded in to memory when launched and streamed in real time when the game is active, it is not persisted or cached to disk.

Notes

  • This software is in early access. All releases are pre-releases and contain known defects.
  • The launcher will indicate when a new release is available. Updating is optional.
  • All releases are code signed and verified. If you have a conflict with your anti-virus or firewall software, please contact the vendor responsible for that software.
  • The application will run against the latest version of Elite Dangerous (Odyssey) and older releases (e.g. Horizons), but it is currently explicitly designed for use with the latest versions. Changes to the game API may impact functionality when using ICARUS Terminal with older versions of the game.
  • The application includes a web interface to allow access from remote devices. The web interface is enabled by default while the application is running.

The web interface relies on advanced browser functionality for rendering and works best on native Google Chrome browsers (e.g. Google Chrome for Windows, Mac, ChromeOS, Android). Other browsers (e.g. Safari, Firefox, Chromium) may use fallback rendering and/or lack required features for full compatbility / optimal user experience.

Developer Documentation

Code contributions, pull requests and bug reports are not currently being accepted for this repository. See CONTRIB.md for more information. For developer documentation see BUILD.md.

Developer Quickstart

If you are running on Linux and/or looking for quick instructions on how to run from source, if you have Node.js this is what you need to do to download and install ICARUS Terminal:

git clone [email protected]:iaincollins/icarus.git
cd icarus
npm install

Next, run cp .env-example .env to create an .env file and edit it to change the LOG_DIR option to point to the location of your Elite Dangerous log files:

# LOG_DIR can be used to tell the Service where to look for game logs
# This option can be used in development and at runtime
LOG_DIR=path/to/logs

With that done, anytime you want to start ICARUS Terminal, all you need to do is run:

npm start

This will run in debug mode which is not quite the same as a production build (it's not as optimised) but should work just fine.

Legal

ICARUS Terminal is free, open-source software released under the ISC License.

ICARUS Terminal does not record Personally Identifiable Information (PII). ICARUS Terminal includes integrations with services like EDSM, EDDB and INARA. Data such as your current in-game location, cargo, etc. may be sent to them order to render information in the interface. ICARUS Terminal does not expose or send information about you or your in game character (e.g. your name, user name, commander name or ship name) but any requests made to a third party will include your IP address.

Elite Dangerous is copyright Frontier Developments plc. This software is not endorsed by nor reflects the views or opinions of Frontier Developments and no employee of Frontier Developments was involved in the making of it.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Credits

ICARUS Terminal would not be possible without work from dozens of enthusiasts and hundreds of open source contributors.

  • The name ICARUS was suggested by SpaceNinjaBear on Reddit.
  • Loading animation by James Panter.
  • Includes origional icons, icons inspired by those found in Elite Dangerous and icons based on those from edassets.org.
  • Uses stellar cartography data from the wonderful EDSM API.
  • Includes game data collated and provided by EDCD.
  • The Jura font is included under the Open Font License.
  • Thank you to Serge Zaitsev for his work on the WebView library.

ICARUS Terminal uses imagery from/inspired by Elite Dangerous, which is copyright Frontier Developments plc. This software is not endorsed by nor reflects the views or opinions of Frontier Developments and no employee of Frontier Developments was involved in the making of it.

Thank you to all those who have created and supported libraries on which this software depends and to Frontier Developments plc for supporting third party tools.

Support

People have asked if I take donations for the project - I don't donations, but I do appreciate the offer.

If you want to support development of ICARUS Terminal, the best way is to visit the Ardent Pioneer (V9G-G7Z).

Selling Tritium to the carrier directly supports development as it means I can spend more time adding features to ICARUS Terminal and travelling the galaxy to test them out!

You can use Inara to find out which system the Ardent Pioneer is currently in and see if it's anywhere near you.

Before you visit you might want to check out what commodities are currently being traded. You might also want to chat to the bartender to see what they are looking for!