Browse Source

Try calling out conf.lua more;

bjorn 2 months ago
parent
commit
98ee5cd2b9
2 changed files with 7 additions and 3 deletions
  1. 1 1
      api/init.lua
  2. 6 2
      api/lovr/callbacks/conf.lua

+ 1 - 1
api/init.lua

@@ -4,7 +4,7 @@ return {
       name = "conf",
       tag = "callbacks",
       summary = "Called to read configuration settings at startup.",
-      description = "The `lovr.conf` callback lets you configure default settings for LÖVR.  It is called once right before the game starts.  Make sure you put `lovr.conf` in a file called `conf.lua`, a special file that's loaded before the rest of the framework initializes.",
+      description = "The `lovr.conf` callback lets you configure default settings for LÖVR.  It is called once right before the game starts.\n\n:::note Make sure you put `lovr.conf` in a file called `conf.lua`, a special file that's loaded before the rest of the framework initializes. :::",
       key = "lovr.conf",
       module = "lovr",
       examples = {

+ 6 - 2
api/lovr/callbacks/conf.lua

@@ -3,8 +3,12 @@ return {
   summary = 'Called to read configuration settings at startup.',
   description = [[
     The `lovr.conf` callback lets you configure default settings for LÖVR.  It is called once right
-    before the game starts.  Make sure you put `lovr.conf` in a file called `conf.lua`, a special
-    file that's loaded before the rest of the framework initializes.
+    before the game starts.
+
+    :::note
+    Make sure you put `lovr.conf` in a file called `conf.lua`, a special file that's loaded before
+    the rest of the framework initializes.
+    :::
   ]],
   arguments = {
     t = {