summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/plugins/timecode.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/plugins/timecode.rst')
-rw-r--r--docs/source/plugins/timecode.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/source/plugins/timecode.rst b/docs/source/plugins/timecode.rst
new file mode 100644
index 00000000000..c24847b3453
--- /dev/null
+++ b/docs/source/plugins/timecode.rst
@@ -0,0 +1,21 @@
+.. _plugins-timecode:
+
+Timecode Recorder Plugin
+========================
+
+The timecode recorder plugin logs time codes to a text file in conjunction with
+creating an input recording file to assist people creating gameplay videos. The
+time code log file is *only* created when making an input recording. The time
+code log file has the same name as the input recording file with the extension
+**.timecode** appended. Use the :ref:`record <mame-commandline-record>` and
+:ref:`input_directory <mame-commandline-inputdirectory>` options to create an
+input recording and specify the location for the output files.
+
+By default, the plugin records a time code when you press the **F12** key on the
+keyboard while not pressing either **Shift** or **Alt** key. You can change
+this setting in the options menu for the plugin (choose **Plugin Options** from
+the main menu during emulation, and then choose **Timecode Recorder**).
+
+Settings for the plugin are stored in JSON format in the file **plugin.cfg** in
+the **timecode** folder inside your plugin data folder (see the
+:ref:`homepath option <mame-commandline-homepath>`).