summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/plugins/timer.rst
diff options
context:
space:
mode:
author Vas Crabb <vas@vastheman.com>2021-10-24 05:48:05 +1100
committer Vas Crabb <vas@vastheman.com>2021-10-24 05:48:05 +1100
commit669b1f6adecfd940d5ae8b97150dc73db04894c5 (patch)
tree3b32a4f2d55f558be04294ebe818c8f35135ef8b /docs/source/plugins/timer.rst
parent3a11f9168703f33f2f066c3e9d0f6905f2c95453 (diff)
-docs: Started documenting plugins.
* Also added a couple of missing command-line options, and added a local table of contents to the (rather long) command line options page. -Added a separate CI target for localisation updates that produces an artefact, and removed the message catalogs from the trigger paths for the Linux CI build.
Diffstat (limited to 'docs/source/plugins/timer.rst')
-rw-r--r--docs/source/plugins/timer.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/source/plugins/timer.rst b/docs/source/plugins/timer.rst
new file mode 100644
index 00000000000..84d803d38aa
--- /dev/null
+++ b/docs/source/plugins/timer.rst
@@ -0,0 +1,20 @@
+Timer Plugin
+============
+
+The timer plugin records the total time spent emulating each combination of a
+system and a software list item, as well as the number of times each combination
+has been launched. To see the statistics, bring up the main menu (press **Tab**
+during emulation by default), choose **Plugin Options**, and then choose
+**Timer**.
+
+Note that this plugin records wall clock time, not emulated time. That is, it
+records the real time duration elapsed while the emulation is running, according
+to the host OS. This may be shorter than the elapsed emulated time if you turn
+off throttling or use MAME’s “fast forward” feature, or it may be longer than
+the elapsed emulated time if you pause the emulation of if the emulation is too
+demanding to run at full speed.
+
+The statistics are stored in the file **timer.db** in the **timer** folder
+inside your plugin data folder (see the
+:ref:`homepath option <mame-commandline-homepath>`). The file is a SQLite3
+database.