diff --git a/doc/client_lua_api.txt b/doc/client_lua_api.txt index 3af633468..2c670645f 100644 --- a/doc/client_lua_api.txt +++ b/doc/client_lua_api.txt @@ -30,6 +30,16 @@ Startup Mods are loaded during client startup from the mod load paths by running the `init.lua` scripts in a shared environment. +In order to load client-side mods in a world, the following conditions need to be satisfied: + +1) `$path_user/minetest.conf` contains the setting `enable_client_modding = true` + +2) The client-side mod located in `$path_user/clientmods/` is added to + `$path_user/clientmods/mods.conf` as `load_mod_ = true`. + +Note: Depending on the remote server's settings, client-side mods might not +be loaded or have limited functionality. See setting `csm_restriction_flags` for reference. + Paths ----- * `RUN_IN_PLACE=1` (Windows release, local build)