Skip to content

Commit

Permalink
Developer guide links prettier (#541)
Browse files Browse the repository at this point in the history 
* dev guide links prettier

* Reference tool section added
  • Loading branch information
@jdahlblom
jdahlblom authored Mar 2, 2024
1 parent 60a52d3 commit 2444768
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 7 deletions.
16 changes: 13 additions & 3 deletions Scripts/DCS-BIOS/doc/developerguide.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@
:toclevels: 2
:imagesdir: images

== DCS-BIOS Reference Tool [[reference_tool]]

There are 3 DCS-BIOS reference tool alternatives for getting the information needed:

* Install https://github.com/DCS-Skunkworks/Bort[`Bort`]
* Install https://github.com/DCS-Skunkworks/BIOSBuddy[`BIOSBuddy`]
* Go to your `saved Games folder/Scripts/DCS-BIOS/doc` and double-click on the file `control-reference.html`. Your web browser will automatically open and display all sorts of colorful headings and code. If you see a red warning instead, you need to enable JavaScript in your web browser and reload the page.

The DCS-BIOS reference tools lists every single supported `DCS module` and all `DCS-BIOS controls` belonging to the module, every single panel found in that aircraft, and every single corresponding switch, push button and rotary knob or whatever associated with that panel and the corresponding code that you will use to create your sketch.

== Connecting to DCS-BIOS

Controls in the cockpit can be manipulated by sending newline-terminated plain text commands to UDP port 7778.
Expand All @@ -20,7 +30,7 @@ It is part of the "Administratively Scoped IPv4 Multicast Space", which is to mu

If you cannot or do not want to deal with multicast UDP, you can also make DCS-BIOS send a copy of the export data stream to a unicast address by editing `BIOSConfig.lua`.

You can also use the `socat` or `DCSBIOSBridge` (https://github.com/DCS-Skunkworks/DCSBIOSBridge) utility to connect a serial port (and just about anything else that can be read or written) to the DCS-BIOS import and export streams.
You can also use the `socat` or https://github.com/DCS-Skunkworks/DCSBIOSBridge[`DCSBIOSBridge`] utility to connect a serial port (and just about anything else that can be read or written) to the DCS-BIOS import and export streams.
For an example, take a look at the batch files that come with DCS-BIOS.

Another way is to open a TCP connection to port 7778.
Expand Down Expand Up @@ -143,7 +153,7 @@ This section describes how to add support for another aircraft module.

=== Export Modules in DCS-BIOS

DCS-BIOS consists of several export modules (they are what you select in the "module" drop-down field in `Bort` (https://github.com/DCS-Skunkworks/Bort) or `BIOSBuddy` (https://github.com/DCS-Skunkworks/BIOSBuddy). Each export module is assigned to one or multiple aircraft and several export modules can be active at the same time.
DCS-BIOS consists of several export modules (they are what you select in the "module" drop-down field in https://github.com/DCS-Skunkworks/Bort[`Bort`] or https://github.com/DCS-Skunkworks/BIOSBuddy[`BIOSBuddy`]. Each export module is assigned to one or multiple aircraft and several export modules can be active at the same time.

The `MetadataStart` and `MetadataEnd` modules are special: they are always active, even if there is no active aircraft (e.g. in spectator mode in a multiplayer game). The `CommonData` module is always active when any of the aircraft in `AircraftList.lua` is active. It exports generic information like altitude, position and heading.

Expand All @@ -155,7 +165,7 @@ The `MetadataStart` and `MetadataEnd` modules are special: they are always activ
If this a new aircraft that doesn't exist in `dcs-bios` then find out the exact name of your aircraft in DCS: World.
To do this, open the `Bort` or `BIOSBuddy` while in your aircraft and look at the `_ACFT_NAME` value in the `MetadataStart` module.

Please visit the developer wiki (https://github.com/DCS-Skunkworks/dcs-bios/wiki/Developer-Guide) for further instructions.
Please visit the https://github.com/DCS-Skunkworks/dcs-bios/wiki/Developer-Guide[developer wiki] for further instructions.


== Tips
Expand Down
8 changes: 4 additions & 4 deletions Scripts/DCS-BIOS/doc/developerguide.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,7 @@ <h2 id="_connecting_to_dcs_bios">Connecting to DCS-BIOS</h2>
<p>If you cannot or do not want to deal with multicast UDP, you can also make DCS-BIOS send a copy of the export data stream to a unicast address by editing <code>BIOSConfig.lua</code>.</p>
</div>
<div class="paragraph">
<p>You can also use the <code>socat</code> or <code>DCSBIOSBridge</code> (<a href="https://github.com/DCS-Skunkworks/DCSBIOSBridge" class="bare">github.com/DCS-Skunkworks/DCSBIOSBridge</a>) utility to connect a serial port (and just about anything else that can be read or written) to the DCS-BIOS import and export streams.
<p>You can also use the <code>socat</code> or <a href="https://github.com/DCS-Skunkworks/DCSBIOSBridge"><code>DCSBIOSBridge</code></a> utility to connect a serial port (and just about anything else that can be read or written) to the DCS-BIOS import and export streams.
For an example, take a look at the batch files that come with DCS-BIOS.</p>
</div>
<div class="paragraph">
Expand Down Expand Up @@ -712,7 +712,7 @@ <h2 id="_adding_a_new_aircraft_module">Adding a New Aircraft Module</h2>
<div class="sect2">
<h3 id="_export_modules_in_dcs_bios">Export Modules in DCS-BIOS</h3>
<div class="paragraph">
<p>DCS-BIOS consists of several export modules (they are what you select in the "module" drop-down field in <code>Bort</code> (<a href="https://github.com/DCS-Skunkworks/Bort" class="bare">github.com/DCS-Skunkworks/Bort</a>) or <code>BIOSBuddy</code> (<a href="https://github.com/DCS-Skunkworks/BIOSBuddy" class="bare">github.com/DCS-Skunkworks/BIOSBuddy</a>). Each export module is assigned to one or multiple aircraft and several export modules can be active at the same time.</p>
<p>DCS-BIOS consists of several export modules (they are what you select in the "module" drop-down field in <a href="https://github.com/DCS-Skunkworks/Bort"><code>Bort</code></a> or <a href="https://github.com/DCS-Skunkworks/BIOSBuddy"><code>BIOSBuddy</code></a>. Each export module is assigned to one or multiple aircraft and several export modules can be active at the same time.</p>
</div>
<div class="paragraph">
<p>The <code>MetadataStart</code> and <code>MetadataEnd</code> modules are special: they are always active, even if there is no active aircraft (e.g. in spectator mode in a multiplayer game). The <code>CommonData</code> module is always active when any of the aircraft in <code>AircraftList.lua</code> is active. It exports generic information like altitude, position and heading.</p>
Expand All @@ -735,7 +735,7 @@ <h3 id="_adding_an_export_module_for_your_aircraft">Adding an Export Module for
To do this, open the <code>Bort</code> or <code>BIOSBuddy</code> while in your aircraft and look at the <code>_ACFT_NAME</code> value in the <code>MetadataStart</code> module.</p>
</div>
<div class="paragraph">
<p>Please visit the developer wiki (<a href="https://github.com/DCS-Skunkworks/dcs-bios/wiki/Developer-Guide" class="bare">github.com/DCS-Skunkworks/dcs-bios/wiki/Developer-Guide</a>) for further instructions.</p>
<p>Please visit the <a href="https://github.com/DCS-Skunkworks/dcs-bios/wiki/Developer-Guide">developer wiki</a> for further instructions.</p>
</div>
</div>
</div>
Expand Down Expand Up @@ -767,7 +767,7 @@ <h2 id="_tips">Tips</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-03-02 17:07:31 +0200
Last updated 2024-03-02 18:18:33 +0200
</div>
</div>
</body>
Expand Down

0 comments on commit 2444768

Please sign in to comment.