Update docs for v0.1.2

Author: ifBars

docs/.vitepress/config.js

@@ -54,6 +54,14 @@ module.exports = {
             { text: 'Limitations', link: '/guide/limitations' }
           ]
         },
+        {
+          text: 'Mod System',
+          collapsed: false,
+          items: [
+            { text: 'Mod System Overview', link: '/guide/mod-system' },
+            { text: 'Mod Imports and Exports', link: '/guide/mod-functions' }
+          ]
+        },
         {
           text: 'Contributing',
           collapsed: false,
@@ -74,6 +82,7 @@ module.exports = {
             { text: 'Timing', link: '/api/core/timing' },
             { text: 'GameObjects', link: '/api/core/gameobjects' },
             { text: 'Globals', link: '/api/core/globals' },
+            { text: 'Mod System', link: '/api/mod/' },
           ]
         },
         {
@@ -153,6 +162,7 @@ module.exports = {
             { text: 'Registry Example', link: '/examples/registry' },
             { text: 'Economy Example', link: '/examples/economy' },
             { text: 'Curfew Example', link: '/examples/curfew' },
+            { text: 'Mod System Example', link: '/examples/mod-system' },
           ]
         },
         {

docs/api/mod/index.md

@@ -0,0 +1,190 @@
+# Mod System API
+
+The Mod System API allows you to work with mods in ScheduleLua, including managing dependencies, and exporting/importing functionality between mods.
+
+## Mod Management Functions
+
+### GetMod
+
+**Signature:** `table GetMod(string modName)`
+
+**Description:** Gets information about a loaded mod by its folder name.
+
+#### Parameters
+
+- `modName` (string): The folder name of the mod to get information about
+
+#### Returns
+
+A table containing information about the mod, or nil if the mod is not loaded. The table has the following structure:
+
+```lua
+{
+  name = "My Mod",          -- Display name from manifest
+  folder = "my_mod",        -- Folder name
+  version = "1.0.0",        -- Version from manifest
+  description = "...",      -- Description from manifest
+  author = "Your Name",     -- Author from manifest
+  dependencies = {...},     -- Table of dependency folder names
+  api_version = "0.1.2"     -- API version from manifest
+}
+```
+
+#### Example
+
+```lua
+local mod = GetMod("economy_mod")
+if mod then
+    Log("Mod name: " .. mod.name)
+    Log("Mod version: " .. mod.version)
+    Log("Mod author: " .. mod.author)
+end
+```
+
+### GetAllMods
+
+**Signature:** `table GetAllMods()`
+
+**Description:** Gets information about all loaded mods.
+
+#### Returns
+
+An array of mod information tables, each with the same structure as returned by `GetMod()`.
+
+#### Example
+
+```lua
+local mods = GetAllMods()
+Log("Loaded mods: " .. #mods)
+for _, mod in ipairs(mods) do
+    Log("- " .. mod.name .. " v" .. mod.version .. " by " .. mod.author)
+end
+```
+
+### IsModLoaded
+
+**Signature:** `boolean IsModLoaded(string modName)`
+
+**Description:** Checks if a mod is loaded by its folder name.
+
+#### Parameters
+
+- `modName` (string): The folder name of the mod to check
+
+#### Returns
+
+`true` if the mod is loaded, `false` otherwise.
+
+#### Example
+
+```lua
+if IsModLoaded("required_mod") then
+    Log("Required mod is loaded!")
+else
+    LogError("Required mod is not loaded!")
+end
+```
+
+## Function Import/Export
+
+### ExportFunction
+
+**Signature:** `void ExportFunction(string name, function func)`
+
+**Description:** Exports a function from the current mod, making it available for other mods to import.
+
+#### Parameters
+
+- `name` (string): The name to export the function as
+- `func` (function): The function to export
+
+#### Example
+
+```lua
+ExportFunction("CalculateTax", function(amount, rate)
+    rate = rate or 0.15
+    return amount * rate
+end)
+```
+
+### ImportFunction
+
+**Signature:** `function ImportFunction(string modName, string functionName)`
+
+**Description:** Imports a function exported by another mod.
+
+#### Parameters
+
+- `modName` (string): The folder name of the mod that exports the function
+- `functionName` (string): The name of the exported function to import
+
+#### Returns
+
+The exported function, or nil if the mod is not loaded or the function is not exported.
+
+#### Example
+
+```lua
+local CalculateTax = ImportFunction("economy_mod", "CalculateTax")
+if CalculateTax then
+    local tax = CalculateTax(1000)
+    Log("Tax amount: " .. tax)
+end
+```
+
+### GetModExport
+
+**Signature:** `any GetModExport(string modName, string exportName)`
+
+**Description:** Gets an exported value (function or other value) from a mod.
+
+#### Parameters
+
+- `modName` (string): The folder name of the mod that exports the value
+- `exportName` (string): The name of the exported value to get
+
+#### Returns
+
+The exported value, or nil if the mod is not loaded or the value is not exported.
+
+#### Example
+
+```lua
+local TAX_RATE = GetModExport("economy_mod", "TAX_RATE")
+if TAX_RATE then
+    Log("Current tax rate: " .. TAX_RATE)
+end
+```
+
+## Best Practices
+
+1. Always check if required mods are loaded before trying to use them:
+
+```lua
+if not IsModLoaded("required_mod") then
+    LogError("This mod requires 'required_mod' to be installed")
+    return
+end
+```
+
+2. Check if imported functions exist before using them:
+
+```lua
+local func = ImportFunction("mod", "func")
+if func then
+    func()
+else
+    LogError("Failed to import function 'func' from 'mod'")
+end
+```
+
+3. Use namespaces for your mod's global data to avoid conflicts:
+
+```lua
+MY_MOD = {
+    version = "1.0.0",
+    settings = {}
+}
+```
+
+4. Document your exported functions for other mod authors: 

docs/api/npc/finding.md

@@ -4,7 +4,7 @@ This section covers the functions used to find and get information about NPCs in
 
 ## GetNPC
 
-**Signature:** `NPC GetNPC(string npcId)`
+**Signature:** `NPCProxy GetNPC(string npcId)`
 
 **Description:** Gets an NPC object by ID. This function is the primary way to locate a specific NPC in the game world.
 
@@ -14,7 +14,7 @@ This section covers the functions used to find and get information about NPCs in
 
 ### Returns
 
-An NPC object if found, or `nil` if no NPC with the given ID exists.
+An NPCProxy object if found, or `nil` if no NPC with the given ID exists.
 
 ### Example
 
@@ -24,6 +24,8 @@ function SayHelloToNPC(npcId)
 
     if npc then
         Log("Found NPC with ID: " .. npcId)
+        Log("NPC full name: " .. npc.FullName)
+        
         -- You can now use this NPC object with other functions
         local position = GetNPCPosition(npc)
         Log("NPC is at position: " .. position.x .. ", " .. position.y .. ", " .. position.z)
@@ -38,9 +40,10 @@ SayHelloToNPC("doris_lubbin")
 
 ### Notes
 
-- The NPC object returned can be used with other NPC functions like `GetNPCPosition`
+- The NPCProxy object returned can be used with other NPC functions like `GetNPCPosition`
 - NPC IDs are case-sensitive
 - Performance tip: Cache the NPC object if you need to use it repeatedly
+- The returned object is an NPCProxy, which provides controlled access to NPC properties
 
 ## GetNPCState
 
@@ -111,18 +114,19 @@ DisplayNPCInfo("bob_001")
 
 - This function is useful for getting detailed information without needing to use multiple separate function calls
 - The table structure may be expanded in future updates with additional NPC properties
+- As an alternative, you can access these properties directly from the NPCProxy returned by GetNPC, for example: `npc.FullName` or `npc.IsConscious`
 
 ## GetNPCPosition
 
 **Status:** 🔄 Partial
 
-**Signature:** `Vector3Proxy GetNPCPosition(NPC npc)`
+**Signature:** `Vector3Proxy GetNPCPosition(NPCProxy npc)`
 
 **Description:** Gets the position of an NPC in the game world.
 
 ### Parameters
 
-- `npc` (NPC): An NPC object reference (from `GetNPC`)
+- `npc` (NPCProxy): An NPCProxy object reference (from `GetNPC`)
 
 ### Returns
 
@@ -204,6 +208,7 @@ CheckNPCLocation("bob_001")
 
 - Regions are designated areas in the game world with specific names
 - This is more efficient than getting the NPC's position and then checking what region that position is in
+- Alternatively, you can access the region directly from an NPCProxy: `local region = npc.Region`
 
 ## GetNPCsInRegion
 

docs/api/npc/index.md

@@ -23,6 +23,17 @@ The NPC API provides functions for finding, managing, and interacting with non-p
 - [`GetNPCsInRegion(region)`](./managing.md#getnpcsinregion) - Gets all NPCs in a specific region
 - [`GetAllNPCRegions()`](./managing.md#getallnpcregions) - Gets a list of all regions that contain NPCs
 
+## NPCProxy Type
+
+To improve compatibility with the Lua scripting system, NPCs are now wrapped in an `NPCProxy` type that exposes only the necessary properties and functions while hiding complex internal implementation details. This provides better stability, especially on IL2CPP/AOT platforms once ScheduleLua supports it.
+
+The `NPCProxy` type provides these properties:
+- `ID` - The unique identifier of the NPC
+- `FullName` - The NPC's full name
+- `IsConscious` - Whether the NPC is currently conscious
+- `Region` - The region the NPC is currently in
+- `IsMoving` - Whether the NPC is currently moving
+
 ## Example Usage
 
 ### Basic NPC Lookup and Information
@@ -100,7 +111,7 @@ function MoveNPCToPlayer(npcId)
     local npc = GetNPC(npcId)
     if not npc then
         LogError("NPC not found: " .. npcId)
-        return
+        return false
     end
 
     local playerPos = GetPlayerPosition()
@@ -113,17 +124,30 @@ function MoveNPCToPlayer(npcId)
 
     Log("Attempted to move NPC with ID " .. npcId .. " to player's location")
     Log("Note: NPC position setting is still in development and may not work correctly")
+    return true
 end
 
--- Usage example
-RegisterCommand("summon", "Attempts to summon an NPC to your location", "summon [npcId]", function(args)
-    if not args[2] then
-        LogError("Please specify an NPC ID")
-        return
-    end
+-- Properly register command after console is ready
+function OnConsoleReady()
+    RegisterCommand(
+        "npc_summon",
+        "Attempts to summon an NPC to your location",
+        "npc_summon <npcId>",
+        function(args)
+            if not args[2] then
+                LogError("Please specify an NPC ID")
+                return
+            end
+            
+            local success = MoveNPCToPlayer(args[2])
+            if not success then
+                LogError("Failed to summon NPC")
+            end
+        end
+    )
 
-    MoveNPCToPlayer(args[2])
-end)
+    Log("NPC summon command registered successfully")
+end
 ```
 
 ### Tracking NPC Movements
@@ -176,6 +200,18 @@ In future updates, we plan to expand the API to include:
 
 Note that some commonly requested features, such as making NPCs follow players or complex NPC behavior control, are not currently planned for implementation.
 
+## Command Registration Best Practices
+
+When creating commands that utilize the NPC API, follow these best practices:
+
+1. **Always register commands in `OnConsoleReady()`** to ensure the console system is fully initialized
+2. **Use prefixes like `npc_`** for your commands to avoid conflicts with built-in game commands
+3. **Provide clear descriptions and usage examples** to make your commands user-friendly
+4. **Include proper error handling** for cases when NPCs don't exist or parameters are invalid
+5. **Return success/failure status** to provide feedback to the user
+
+See the [Command API documentation](../registry/commands.md) for more details on registering and managing console commands.
+
 Stay tuned for updates to the API as development progresses.
 
 Explore the sections in the sidebar for detailed documentation of each function.