# HG changeset patch
# User sam <sam@basx.dev>
# Date 1736579729 -25200
# Node ID d1696485879059ed7ae2c94416bf25f3019d4e8a
# Parent  676fc13685a947f87cb5f2db8270dc3c5d4eb8fc
add: documentation comment

diff -r 676fc13685a9 -r d16964858790 semicongine.nim
--- a/semicongine.nim	Sat Jan 11 14:04:39 2025 +0700
+++ b/semicongine.nim	Sat Jan 11 14:15:29 2025 +0700
@@ -9,9 +9,8 @@
 from ./semicongine/background_loaders import initBackgroundLoader
 import ./semicongine/loaders
 
-#### Main engine object
-
 proc initEngine*(appName: string) =
+  ## Required to be called before most features of the engine can be used
   engine_obj_internal = Engine()
   engine_obj_internal.vulkan = initVulkan(appName)
 
@@ -22,6 +21,7 @@
   engine_obj_internal.mixer[].lock.initLock()
   engine_obj_internal.audiothread.createThread(audioWorker, engine_obj_internal.mixer)
 
+  # start background resource loaders
   engine_obj_internal.rawLoader = initBackgroundLoader(loadBytes)
   engine_obj_internal.jsonLoader = initBackgroundLoader(loadJson)
   engine_obj_internal.configLoader = initBackgroundLoader(loadConfig)