diff --git a/New-user-guide.md b/New-user-guide.md new file mode 100644 index 0000000..2db8b13 --- /dev/null +++ b/New-user-guide.md @@ -0,0 +1,82 @@ +# New User Guide +Eventually this document aims to guide New Users through any caveats and +common issues with getting the application set up the first time. + +For now it's mostly going to document the various caveats and issues you +might encounter. See also [Troubelshooting](Troubleshooting.md). + +## You need to have logged into the game at least once +Until you have fully logged into the game, including having chosen a +name for your Commander, you will not be able to access all of the +settings for this application. This notably includes: + + * EDSM Command and API Key. + * Inara API key. + +NB: Moving/Deleting all your Journal files will make this application +think you've never logged in. It uses the *latest* Journal file to +determine the Commander name to use. + +## First time Commander +If it is your very first time playing Elite Dangerous then need to +have completed the initial tutorial to the point where you dock +your ship in a different star system and get awarded your pilots +license. This will trigger you having to choose your Commander name, as +well as a few other things. + +At this stage this application knows enough to ask your to authorize it +to utilise the Frontier CAPI service (which it uses to automatically +retrieve station commodity information, and for access to the +information about all the ships you own, not just the one you're +currently using). + +*There is a known bug where the browser tab/window for this might open +twice. Just ignore the first tab/window and use the second.* +See [Issue #583](https://github.com/EDCD/EDMarketConnector/issues/583). + +Once you've entered your Frontier Account credentials and approved this +application's request for access with the 'Approve' button the browser +tab will not change, just close it once you've confirmed it worked as +below. + +You should see this application's window update to show: + +1. Your Commander name. +1. The name of your Ship. +1. The name of the (star) System you're currently in. +1. The name of the Station you're currently docked at. + +### Setting up EDSM +If you wish to make use of [Elite Dangerous Star +Map](https://www.edsm.net/) then first create an account there, then you +can *now* (once Commander name is known) access the relevant settings on +the 'EDSM' tab of this application's Settings. + +Note that you can click on the "Elite Dangerous Star Map credentials" +text to open a browser tab/window on the EDSM page that tells you your +API key. + +### Setting up Inara +If you wish to make use of [Inara.cz](https://inara.cz/) then first +create an account there, then you can *now* (once Commander name is +known) access the relevant settings on the 'Inara' tab of this +application's Settings. + +*NB: There might still be a small bug where if you close this +application's Settings without an Inara API key set, but with "Send +flight log and Cmdr status to Inara" active (which is the default), +you'll see an error about a bad API key from Inara.* Either set up the +Inara API key, or uncheck the option to prevent this. +See [Issue #580](https://github.com/EDCD/EDMarketConnector/issues/580). + +Note that you can click on the "Inara credentials" +text to open a browser tab/window on the Inara page that tells you your +API key. Hit "Generate New Key" there if it's still blank. + +You might see an error in this applications status bar: + + Error: Inara setCommanderReputationMajorFaction, No reputation value provided. + +this is harmless and can be ignore. It should go away once you start +gaining reputation with the Empire and Federation in-game. +See [Issue #581](https://github.com/EDCD/EDMarketConnector/issues/581).