Skip to content

Commit d1def56

Browse files
committed
Update README
1 parent 292da4c commit d1def56

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,20 @@ A module that adds MPEG-1 video support to Godot.
77
This was originally part of a proposal to replace Godot's built-in Theora decoder due to bugs. However, fixes were found, so I released as a separate module instead.
88

99
## Usage
10-
`.mpg` files in your project should appear in the FileSystem dock. Drag them into a VideoStreamPlayer and it should work. All decoding is done on CPU.
10+
`.mpg` files in your project should appear in the FileSystem dock. Drag them into a VideoStreamPlayer and it should work.
1111

12-
Note that video and audio streams should be MPEG-1 Video and MPEG-1 Audio Layer II, respectively. This shouldn't be a problem since `.mpg` usually defaults to those.
12+
Video and audio streams should be MPEG-1 Video and MPEG-1 Audio Layer II (MP2), respectively. This shouldn't be a problem since `.mpg` usually defaults to those.
13+
14+
Like Theora (`.ogv` files), video decoding is done on CPU.
1315

1416
## Building
1517
Clone the repository into `modules/` under the name "mpg". Then proceed to build the engine as per the usual instructions.
1618

17-
In my own tests, this module seems to have a weight of 72 KB in a production template release binary. At least this is still better than Theora's 104 KB penalty.
19+
In my own tests, this module seems to have a weight of 72 KB in a production template release binary. For comparison, Theora's weight is 104 KB.
1820

1921
## Third-party
2022
This module uses the [PL_MPEG](https://github.com/phoboslab/pl_mpeg) library by Dominic Szablewski with a few patches.
2123

2224
## Known issues
23-
- A blank frame can be seen when looping.
24-
- Performance issues. Theora is still faster despite its bugs. Proposed optimizations in PL_MPEG might fix this.
25+
- A blank frame can be seen when looping and sometimes at the start.
26+
- Theora is still a little faster despite its bugs. Proposed optimizations in PL_MPEG might fix this in the future.

0 commit comments

Comments
 (0)