如何优化cocos2d lua社区版本quick 4.0 lua 在windows平台下的工作流_quick4.0

为什么要优化?

主要问题

• 在ide里修改代码后，启动调试，跑不到最新代码，而是跑的exe目录下的代码，带来非常差的开发体验

问题溯源

• 为了方便双击启动游戏exe，在更早期quick-lua版本或某些修改版框架中，在simulator写死了代码来读取上级目录下的资源
• 为了方便双击启动游戏exe，后来的版本中cmake编译系统会将工程根目录下的res和src文件夹拷贝到.exe所在路径，同时引擎中写死了优先加载exe所在目录下的Resources下资源

优化之前，先看一下各操作系统遵循的定律

1. 工作目录下的资源一定能够被程序文件io以相对路径读取
2. exe目录下的依赖dll，一定能被exe加载，但如果工作目录不等于exe目录，则程序文件io是无法以(相对于exe的相对路径)读取的
3. 进一步总结就是： workingDirectory=RESOURCE_SEARCH_PATH, exeDir=LIBRARY_SEARCH_PATH，其他系统应该也类似

参考 axmol 引擎的优化修改引擎，仅需3步

1. 复制 axmol 引擎的thridparty/ntcvt文件夹到 external 目录下，点击下载ntcvt.zip

   

2. 将 axmol 针对win32优化的关键代码拷贝到 CCFileUtils-win32.cpp，注意包含 ntcvt/ntcvt.hpp，点击下载修改后的CCFileUtils-win32.zip

   static void _checkWorkingPath()
   {
       if (s_workingPath.empty())
       {
           WCHAR utf16Path[CC_MAX_PATH] = {0};
           int nNum                     = GetCurrentDirectoryW(CC_MAX_PATH - 2, utf16Path);
   
           char utf8WorkingDir[CC_MAX_PATH] = {0};
           nNum =
               WideCharToMultiByte(CP_UTF8, 0, utf16Path, nNum, utf8WorkingDir, sizeof(utf8WorkingDir), nullptr, nullptr);
           if (nNum < (CC_MAX_PATH - 2))
           {
               utf8WorkingDir[nNum]     = '\\';
               utf8WorkingDir[nNum + 1] = '\0';
               s_workingPath            = convertPathFormatToUnixStyle(utf8WorkingDir);
           }
       }
   }
   
   static void _checkExePath()
   {
       if (s_exePath.empty())
       {
           WCHAR utf16Path[CC_MAX_PATH] = {0};
           GetModuleFileNameW(NULL, utf16Path, CC_MAX_PATH - 1);
           WCHAR* pUtf16ExePath = &(utf16Path[0]);
   
           // We need only directory part without exe
           WCHAR* pUtf16DirEnd = wcsrchr(pUtf16ExePath, L'\\');
   
           auto utf8ExeDir = ntcvt::wcbs2a<std::string>(pUtf16ExePath, pUtf16DirEnd - pUtf16ExePath + 1);
   
           s_exePath = convertPathFormatToUnixStyle(utf8ExeDir);
       }
   }
   
   bool FileUtilsWin32::init()
   {
       DECLARE_GUARD;
   
       _checkWorkingPath();
       _defaultResRootPath = s_workingPath;
   
       bool bRet = FileUtils::init();
   
       _checkExePath();
   
       if (s_workingPath != s_exePath)
           addSearchPath(s_exePath);
   
       return bRet;
   }
   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52

3. 修改模板的CMakeLists.txt，去除WINDOWS平台拷贝资源到exe目录下的逻辑，点击下载修改后的CMakeLists.txt

    # copy resource on linux or WINDOWS
     if(LINUX OR WINDOWS)
         cocos_get_resource_path(APP_RES_DIR ${APP_NAME})
         cocos_sync_folder(${APP_NAME} ${res_res_folders} ${APP_RES_DIR}/res)
         cocos_sync_folder(${APP_NAME} ${res_src_folders} ${APP_RES_DIR}/src)
     endif()
   1
   2
   3
   4
   5
   6

   修改为

    # copy resource on linux or WINDOWS
     if(LINUX)
         cocos_get_resource_path(APP_RES_DIR ${APP_NAME})
         cocos_sync_folder(${APP_NAME} ${res_res_folders} ${APP_RES_DIR}/res)
         cocos_sync_folder(${APP_NAME} ${res_src_folders} ${APP_RES_DIR}/src)
     endif()
   1
   2
   3
   4
   5
   6

   如图所示：
   

通过上述优化，再结合强大的x-studio ide就可以非常愉快进行lua开发调试了

优化后，如果想双击启动游戏，在项目根目录下随便创建一个bat，写一行代码即可

例如：

@start build\bin\q4\Debug\q4.exe
1

将以上代码(注意要修改成你实际exe相对于项目的路径)保存为 run_d.bat，放到项目根目录下就可以双击它快速启动游戏了。

2022/2/11更新: 可参考axmol对windows开发工作流的增强，axmol新建的工程，执行cmake后，会根据模板文件run.bat.in生成对应的run.bat方便双击运行游戏