update docs for new release
This commit is contained in:
parent
fe9ade5058
commit
25362183c9
@ -185,7 +185,6 @@
|
|||||||
<None Include="App.config" />
|
<None Include="App.config" />
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<Content Include="docs\main-objectives.png" />
|
|
||||||
<Resource Include="main-page.png">
|
<Resource Include="main-page.png">
|
||||||
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
|
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
|
||||||
</Resource>
|
</Resource>
|
||||||
@ -207,10 +206,9 @@
|
|||||||
</None>
|
</None>
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<Content Include="docs\main-entries.png" />
|
<Resource Include="docs\main-page.png">
|
||||||
</ItemGroup>
|
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
|
||||||
<ItemGroup>
|
</Resource>
|
||||||
<Content Include="docs\main-report.png" />
|
|
||||||
</ItemGroup>
|
</ItemGroup>
|
||||||
<ItemGroup>
|
<ItemGroup>
|
||||||
<Content Include="LICENCE.txt">
|
<Content Include="LICENCE.txt">
|
||||||
|
@ -11,17 +11,8 @@ Binary downloads can be found here: [https://bgs.n0la.org/](https://bgs.n0la.org
|
|||||||
|
|
||||||
## How To
|
## How To
|
||||||
|
|
||||||
![Main Window Objectives](main-objectives.png)
|
Press "Parse Journal", which will check your Elite Dangerous player journal for completed
|
||||||
|
missions. Currently the tool recognises the following completed tasks:
|
||||||
Use the main tab to add objectives to the program. To do this, insert the system name,
|
|
||||||
faction, and, optionally, a station. Then press "Add Objective". Objectives can be deleted
|
|
||||||
by selecting them and pressing the "DEL" key. Manually added objectives like this are
|
|
||||||
enabled by default. You can always enable, and disable an objective by checking the box
|
|
||||||
next to its name. Disabled objectives are not included in the BGS discord log generation.
|
|
||||||
|
|
||||||
Once you have your objectives have been configured, you can press "Parse Journal", which
|
|
||||||
will check your Elite Dangerous player journal for completed missions. Currently the tool
|
|
||||||
recognises the following completed tasks:
|
|
||||||
|
|
||||||
* Buying of cargo from stations (new in Update 10)
|
* Buying of cargo from stations (new in Update 10)
|
||||||
* Completed missions
|
* Completed missions
|
||||||
@ -72,7 +63,7 @@ you the bounty. And not the faction of the victim. The tool will look for an eve
|
|||||||
scanned your victim, and gleem the victim's faction from that. If you did not scan your victim, then
|
scanned your victim, and gleem the victim's faction from that. If you did not scan your victim, then
|
||||||
sadly the tool cannot connect the victim's faction to the victim.
|
sadly the tool cannot connect the victim's faction to the victim.
|
||||||
|
|
||||||
![Main Window with entries](main-entries.png)
|
![Main Window with entries](main-page.png)
|
||||||
|
|
||||||
The window will then list all the journal entries it has found, and group them by objectives. You
|
The window will then list all the journal entries it has found, and group them by objectives. You
|
||||||
can select which objectives you wish to report, by using the checkmarks.
|
can select which objectives you wish to report, by using the checkmarks.
|
||||||
@ -82,13 +73,12 @@ This way said entry will not appear in the final log. You can also remove indivi
|
|||||||
(if you think the tool detected something you thought was wrong), by selecting the entry,
|
(if you think the tool detected something you thought was wrong), by selecting the entry,
|
||||||
and pressing the "DEL" key.
|
and pressing the "DEL" key.
|
||||||
|
|
||||||
Once you are satisfied with the result, move to "Discord Report" tab, select a template, and click
|
Once you are satisfied with the result, you can copy and paste the final report to the discord
|
||||||
"Generate Report".
|
server of your choice. Before you copy/paste it into the discord of your squadron, you should
|
||||||
|
check the log. You can of course also edit it, either if something is wrong because the tool
|
||||||
|
missed something, or you just wish to add a note the report itself.
|
||||||
|
|
||||||
![Generated Report](main-report.png)
|
If you wish to regenerate the discord log, simply click "Generate Log".
|
||||||
|
|
||||||
Before you copy/paste it into the discord of your squadron, you should check the log. You can of
|
|
||||||
course edit it, if something is wrong or the tool itself missed something.
|
|
||||||
|
|
||||||
## Known Issues and Bugs
|
## Known Issues and Bugs
|
||||||
|
|
||||||
|
@ -53,9 +53,9 @@ It requires a separate library, called EDJournal, which is also open source:
|
|||||||
|
|
||||||
## Downloads
|
## Downloads
|
||||||
|
|
||||||
The latest version of EliteBGS **0.1.6** is available for download here:
|
The latest version of EliteBGS **0.1.7** is available for download here:
|
||||||
|
|
||||||
* [https://bgs.n0la.org/elitebgs-0.1.6.zip](https://bgs.n0la.org/elitebgs-0.1.6.zip)
|
* [https://bgs.n0la.org/elitebgs-0.1.7.zip](https://bgs.n0la.org/elitebgs-0.1.7.zip)
|
||||||
|
|
||||||
Older versions are available in the archive:
|
Older versions are available in the archive:
|
||||||
|
|
||||||
|
Binary file not shown.
Before Width: | Height: | Size: 81 KiB |
Binary file not shown.
Before Width: | Height: | Size: 27 KiB |
BIN
docs/main-page.png
Normal file
BIN
docs/main-page.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 55 KiB |
Binary file not shown.
Before Width: | Height: | Size: 21 KiB |
Loading…
Reference in New Issue
Block a user