[Lingo 2] Added config file documentation

2 files changed, 44 insertions, 0 deletions

@@ -2,6 +2,12 @@
 //
 // Massive thanks to the game developer, Brenton, for working with me to
 // make this possible.
+//
+// Example config file:
+// https://code.fourisland.com/autosplitters/plain/example.lingo2_config
+//
+// You must restart either the splitter or the game after choosing a config
+// file in the autosplitter settings, and after modifying the config file.
 
 state("Lingo2") {}
 
@@ -0,0 +1,38 @@
+# This is an example config file for the Lingo 2 autosplitter.
+# Any line with a pound sign at the start is considered a comment and will be ignored.
+# Blank lines are also ignored.
+# You can remove section headers that aren't needed.
+
+# The autosplitter will split the first time any of these panels are solved.
+# These take the form of "{map name}/{node path}".
+panels:
+basic_room_1/Panels/entry_1
+
+# Same as above, but the autosplitter will split even if the panel has been solved before.
+multipanels:
+basic_room_1/Panels/entry_2
+
+# The autosplitter will split the first time any of these maps are entered.
+maps:
+the_great
+
+# Same as above, but the autosplitter will split even if the map has been entered before.
+multimaps:
+the_entry
+
+# The autosplitter will split when these keys are collected.
+# They take the form of the letter, and then either a 1 or a 2.
+# 1 indicates the default form of the key, and 2 indicates the form that can be used multiple times.
+keys:
+b1
+y1
+e1
+h2
+
+# The autosplitter will split when these collectibles are unlocked.
+# This includes endings, gallery paintings, gravestones, and masteries.
+collectibles:
+mint_ending
+theBetweenPainting
+butterfly_mastery
+grave_landscapes