Skip to content

Commit 57d253f

Browse files
authored
Merge pull request #148 from shannonbaker/patch-1
Update README.md
2 parents 3d22621 + d2a7f04 commit 57d253f

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# IMPORTANT
2+
As of msp-osd v0.12+, the required font format has now changed for the goggles and the OSD Overlay tool. Support for .bin font file format has been removed in favour of .png font file format.
3+
See the 'Fonts' section and the 'Overlaying OSD on DVR' sections further below for clarification.
4+
15
# MSP-OSD - Full OSD / Displayport OSD
26

37
This package gives you support for full flight controller driven OSD in line with those on analog + other HD systems.
@@ -235,6 +239,8 @@ To remove copied fonts repeat steps 1 to 6 and replace step 7 with `rm /blackbox
235239

236240

237241
## Overlaying OSD on DVR
242+
**Note the change in font file format requirements (png format) for the OSD Overlay tool. If no font file is provided by the user, a built in font (png format) will be used.**
243+
238244
The overlay process uses DVR, recorded osd data and a font file, to overlay/render the OSD data onto DVR footage on your computer.
239245
A default font will be used if no font file is supplied however. The font look and feel will be the bundled font you would see if using this during flight.
240246

@@ -250,7 +256,7 @@ package-config apply msp-osd
250256
```
251257

252258
##### *Notes*
253-
You only need to supply a font file for the canvas the DVR was recorded with. i.e. If your FC firmware configuration was HD or a HD variant you only need to supply the '_hd' font file.
259+
You only need to supply a font file for the canvas the DVR was recorded with. i.e. If your FC firmware configuration was HD or a HD variant you only need to supply the '_hd.png' font file.
254260
The 'Chroma Key' will replace the DVR with a solid colour for use within video editing software. Be aware however that fonts have an amount of transparency around elements that will include the 'Chroma Key' bleed that will be difficult to avoid in video editing software.
255261

256262
See the 'Using Walksnail Fonts Section' for specific requirements that may apply to font file formats.

0 commit comments

Comments
 (0)