-
-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
68 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,73 @@ | ||
| <img src="https://i.imgur.com/exTgJDS.png" align="right" | ||
| title="EliteAI by Somfic" width="280" height="280"> | ||
| <img src="https://i.imgur.com/keDXwjY.png" align="right" | ||
| title="EliteAPI by Somfic" width="280" height="280"> | ||
|
|
||
| # EliteAPI | ||
| [Jarvis](http://marvel-movies.wikia.com/wiki/J.A.R.V.I.S.) + [Elite: Dangerous](https://www.elitedangerous.com/) = EliteAI. Created by [Somfic](https://github.com/Somfic). | ||
| A powerful event based API for [Elite: Dangerous](https://www.elitedangerous.com/) that hooks into the [Player Journal](http://edcodex.info/?m=doc). Created by [Somfic](https://github.com/Somfic). | ||
|
|
||
| [](https://app.codacy.com/app/EliteAPI/EliteAI?utm_source=github.com&utm_medium=referral&utm_content=EliteAPI/EliteAI&utm_campaign=Badge_Grade_Dashboard) [](https://discord.gg/jwpFUPZ) | ||
| [](https://app.codacy.com/app/EliteAPI/EliteAPI?utm_source=github.com&utm_medium=referral&utm_content=Somfic/EliteAPI&utm_campaign=Badge_Grade_Dashboard) [](https://discord.gg/jwpFUPZ) | ||
|
|
||
| [](https://github.com/EliteAPI/EliteAI/issues) [](https://github.com/EliteAPI/EliteAI/network) [](https://github.com/EliteAPI/EliteAI/stargazers) [](https://github.com/EliteAPI/EliteAI/blob/master/LICENSE) | ||
| [](https://github.com/EliteAPI/EliteAPI/issues) [](https://github.com/EliteAPI/EliteAPI/network) [](https://github.com/EliteAPI/EliteAPI/stargazers) [](https://github.com/EliteAPI/EliteAPI/blob/master/LICENSE) | ||
|
|
||
| [](https://github.com/EliteAPI/EliteAI/releases) [](https://github.com/EliteAPI/EliteAI/commits/master) [](https://github.com/EliteAPI/EliteAI/releases) | ||
| [](https://www.nuget.org/packages/EliteAPI/) [](https://github.com/EliteAPI/EliteAPI/releases) [](https://github.com/EliteAPI/EliteAPI/commits/master) [](https://github.com/EliteAPI/EliteAPI/releases) [](https://www.nuget.org/packages/EliteAPI/) | ||
|
|
||
|
|
||
| # Usage | ||
| Let's get this party rolling. | ||
|
|
||
| ## Installation | ||
| First we will have to install EliteAPI. We can do this a number of ways. | ||
|
|
||
| ##### Nuget | ||
| Use the nuget package manager console. | ||
|
|
||
| ```Install-Package EliteAPI``` | ||
|
|
||
| After that it will be ready to go. | ||
|
|
||
| ##### Nuget package manager | ||
| It is also available in the nuget package manager via Visual Studio. Simply search for ***EliteAPI***. After that it will be ready to go. | ||
|
|
||
| ##### Github | ||
| You can find the latest release [here](https://github.com/EliteAPI/EliteAPI/releases). Download the .dll file and reference it to your Visual Studio project. | ||
|
|
||
| ## Code example | ||
| First, add the namespace to your class. | ||
| ```csharp | ||
| using EliteAPI; | ||
| ``` | ||
| Then create a new `EliteDangerousAPI` object. | ||
| ```csharp | ||
| EliteDangerousAPI EliteAPI = new EliteDangerousAPI(); | ||
| ``` | ||
| Since `EliteDangerousAPI` needs a reference to the directory that contains the PlayerJournals, we have to pass it a `DirectoryInfo` object. | ||
| ```csharp | ||
| DirectoryInfo playerJournalFolder = new DirectoryInfo( | ||
| $@"C:\Users\{Environment.UserName}\Saved Games\Frontier Developments\Elite Dangerous"); | ||
|
|
||
| EliteDangerousAPI EliteAPI = new EliteDangerousAPI( playerJournalFolder ); | ||
| ``` | ||
| Now that we are hooked to the API, we can setup the events that we want to get information about. Let's say we want to know when the player docks at a station. Simply hook into its event and create a method for it. After that start the API. | ||
| ```csharp | ||
| DirectoryInfo playerJournalFolder = new DirectoryInfo( | ||
| $@"C:\Users\{Environment.UserName}\Saved Games\Frontier Developments\Elite Dangerous"); | ||
|
|
||
| EliteDangerousAPI EliteAPI = new EliteDangerousAPI( playerJournalFolder ); | ||
|
|
||
| EliteAPI.DockedEvent += EliteAPI_DockedEvent; | ||
|
|
||
| EliteAPI.Start(); | ||
| ``` | ||
| ```csharp | ||
| private static void EliteAPI_DockedEvent(object sender, DockedInfo e) | ||
| { | ||
| //This method will be ran every time the player docks. | ||
| } | ||
| ``` | ||
| Now if you want to display the station's name for example, you can use the `DockedInfo` object. | ||
| ```csharp | ||
| private static void EliteAPI_DockedEvent(object sender, DockedInfo e) | ||
| { | ||
| //This method will be ran every time the player docks. | ||
| Console.WriteLine($"Docked at {e.StationName}."); | ||
| } | ||
| ``` |