草庐IT

【远程文件浏览器】Unity+Lua开发调试利器

IWINIWIN 2023-03-28 原文

Remote File Explorer是一个跨平台的远程文件浏览器,用户通过Unity Editor就能操作运行在手机上的游戏或是应用的的目录文件。比如当项目打包运行到设备上时,可通过Remote File Explorer直接浏览设备上的目录文件,并进行下载,上传,删除等操作。尤其是Unity+Lua开发环境下的调试利器,当然,这里的调试不是指代码的逐行调试,而是泛指定位排查问题

用武之地

在很多场景下利用Remote File Explorer都可以极大的提高开发调试效率。例如:

  • 应用真机上运行时出现异常情况,推测可能是关键资源丢失导致。此时可以通过本工具直接浏览手机上的相关文件,查看关键资源是否存在
  • 通过本工具直接拉取手机上的日志文件或内存分析文件等各类文件,从此告别数据线
  • 如果项目采用了XLua或SLua开发,在真机开发调试时,可通过本工具直接上传修改后的Lua代码,重启应用即可生效。从而避免每修改一次代码就重新构建一次应用的繁琐过程,大大提高调试效率

接下来,将以一些具体的案例,来演示Remote File Explorer工具的使用。下面用例的代码都可以在Remote File Explorer Demo找到

用例1-无需重新打包修改代码逻辑

  1. 客户端打包,启动后,初始界面如下图所示。其中"Hello, Wlrod"的文本故意拼写错误,用来演示如何不重新打包,通过Remote File Explorer来修复此错误

  1. 在UnityEditor中,通过"Window > Remote File Explorer"打开Remote File Explorer工具窗口,通过Stats面板可以查看服务端IP

  1. 在客户端输入正确的服务端IP,然后点击Connect。连接成功后Stats面板的State将显示为"Established"

  1. 拼写错误是在这个文件changetextcontent.lua内写错的,如下所示修改文件内容(主要是将"Hello, Wlrod"拼写修正为"Hello, World")
local obj = CS.UnityEngine.Object.FindObjectOfType(typeof(CS.Game.ChangeTextColor))
local textComponent = obj:GetComponent(typeof(CS.UnityEngine.UI.Text));
textComponent.text = "Hello, World"
  1. 通过Remote File Explorer工具窗口,GoTo到Application.persistentDataPath目录。这个目录下的Lua文件将会被优先加载(这是工程内的Lua加载机制决定的,详情可参考XLuaManager.cs

  1. 拖拽changetextcontent.lua文件上传到该目录。之后重启客户端,"Hello, Wlrod"的拼写错误将会被修复。完整的操作流程如下所示

  1. 另外,利用xLua的hotfix特性,还可以修改C#代码的逻辑。例如,"Hello, World"文本的颜色是由C#代码设置的红色,可以通过修改changetextcontent.lua文件将文本设置为绿色,内容如下所示
local obj = CS.UnityEngine.Object.FindObjectOfType(typeof(CS.Game.ChangeTextColor))
local textComponent = obj:GetComponent(typeof(CS.UnityEngine.UI.Text));
textComponent.text = "Hello, World"

xlua.hotfix(CS.Game.ChangeTextColor, "Start", function(self)
    self:GetComponent(typeof(CS.UnityEngine.UI.Text)).color = CS.UnityEngine.Color.green
    xlua.hotfix(CS.Game.ChangeTextColor, "Start", nil)
end)
  1. 之后同样的操作,将文件上传到Application.persistentDataPath目录,重启客户端后,文本颜色将改变。完整的操作流程如下所示

用例2-直接拉取手机上的日志文件

  1. 如果某个固定文件会被频繁拉取,比如日志文件或是性能分析文件。可以通过配置CustomMenuAttribute为该文件添加一个自定义拉取操作。以拉取日志文件game.log为例,新增一个CustomMenuAttribute修饰的方法
using UnityEngine;
using RemoteFileExplorer.Editor;

public class TestAttribute
{
    [CustomMenu("pull game log")]
    public static void PullLog(ManipulatorWrapper manipulator)
    {
        string remoteLogPath = manipulator.GetRemotePath("Application.persistentDataPath") + "/Logs/game.log";
        manipulator.Download(remoteLogPath, Application.dataPath.Replace("/Assets", "") + "/Logs/game.log");  // 将log文件下载到本地
    }
}
  1. 代码添加后,重新打开Remote File Explorer工具窗口将出现"Custom"菜单,点击该菜单后会执行PullLog方法

  1. 连接建立成功后,通过"pull game log"操作可以一键拉取game.log文件。完整的操作流程如下所示

安装

本工具是采用Unity的形式,可以通过Unity Package Manager直接安装

这里介绍两种常用方式

  • 打开"Window > Package Manager"窗口后,单击状态栏左侧的"+"按钮,选择"Add package from git URL",然后在文本框中输入本工具的git地址https://github.com/iwiniwin/unity-remote-file-explorer.git,单击"Add"按钮后完成安装
  • 或直接克隆本工具到项目的"Packages"目录下

详细安装方式可以查看使用文档,更多将本工具作为包进行安装的方式可查看Unity官方文档

使用

安装本工具后,可通过"Window > Analysis > Remote File Explorer"打开本工具窗口,将自动启动服务器

给项目的任意游戏对象添加FileExplorerClient组件

如果是固定连接到某台机器上,可直接通过Inspector面板在"Host"域输入这台机器的IP地址,然后勾选"Connect Automatically",则会在应用启动时自动连接

如果希望应用启动后能主动选择连接到哪台机器,则可在Debug模式下封装一套简单的UI,使开发人员能够输入想要连接到的IP地址。例如在自己的菜单中添加一个条目或按钮,点击后弹出输入窗口。在成功获取到的IP地址后,将其赋值给FileExplorerClient组件的"Host"属性,然后调用FileExplorerClient组件的"StartConnect"方法开启连接

也可以使用本工具自带的一个简易UI,给项目的任意游戏对象添加FileExplorerWindow组件(此时不用再额外添加FileExplorerClient组件)

游戏启动后将自动打开连接窗口

功能列表

详细的图文功能介绍请查看使用文档

  • 通过状态栏的"GOTO"可直接跳转到Unity预定义的一些路径
  • 通过单击路径栏可打开输入框,以直接输入路径跳转或复制当前路径
  • 右键所选中的文件夹或文件支持下载
  • 右键所选中的文件夹或文件支持删除
  • 右键空白区域支持上传文件夹或文件
  • 右键空白区域支持刷新当前路径的内容
  • 支持直接从Unity Project窗口拖拽文件夹或文件到本工具上传
  • 支持直接从系统文件浏览器拖拽文件夹或文件到本工具上传
  • 通过本工具"status"面板可查看连接状态以及已连接设备的信息,可用于辨别连接的是哪台设备
  • 通过配置BeforeUploadAttribute自定义上传时的额外操作,例如上传lua代码时自动加密
  • 通过配置CustomMenuAttribute自定义操作菜单

链接

有关【远程文件浏览器】Unity+Lua开发调试利器的更多相关文章

  1. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序,它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重,我想提高压缩级别,因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗?是否有另一个允许指定压缩级别的Ruby库? 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  2. ruby - 其他文件中的 Rake 任务 - 2

    我试图在一个项目中使用rake,如果我把所有东西都放到Rakefile中,它会很大并且很难读取/找到东西,所以我试着将每个命名空间放在lib/rake中它自己的文件中,我添加了这个到我的rake文件的顶部:Dir['#{File.dirname(__FILE__)}/lib/rake/*.rake'].map{|f|requiref}它加载文件没问题,但没有任务。我现在只有一个.rake文件作为测试,名为“servers.rake”,它看起来像这样:namespace:serverdotask:testdoputs"test"endend所以当我运行rakeserver:testid时

  3. ruby-on-rails - 在 Rails 中将文件大小字符串转换为等效千字节 - 2

    我的目标是转换表单输入,例如“100兆字节”或“1GB”,并将其转换为我可以存储在数据库中的文件大小(以千字节为单位)。目前,我有这个:defquota_convert@regex=/([0-9]+)(.*)s/@sizes=%w{kilobytemegabytegigabyte}m=self.quota.match(@regex)if@sizes.include?m[2]eval("self.quota=#{m[1]}.#{m[2]}")endend这有效,但前提是输入是倍数(“gigabytes”,而不是“gigabyte”)并且由于使用了eval看起来疯狂不安全。所以,功能正常,

  4. ruby-on-rails - Rails 3 中的多个路由文件 - 2

    Rails2.3可以选择随时使用RouteSet#add_configuration_file添加更多路由。是否可以在Rails3项目中做同样的事情? 最佳答案 在config/application.rb中:config.paths.config.routes在Rails3.2(也可能是Rails3.1)中,使用:config.paths["config/routes"] 关于ruby-on-rails-Rails3中的多个路由文件,我们在StackOverflow上找到一个类似的问题

  5. ruby - 将差异补丁应用于字符串/文件 - 2

    对于具有离线功能的智能手机应用程序,我正在为Xml文件创建单向文本同步。我希望我的服务器将增量/差异(例如GNU差异补丁)发送到目标设备。这是计划:Time=0Server:hasversion_1ofXmlfile(~800kiB)Client:hasversion_1ofXmlfile(~800kiB)Time=1Server:hasversion_1andversion_2ofXmlfile(each~800kiB)computesdeltaoftheseversions(=patch)(~10kiB)sendspatchtoClient(~10kiBtransferred)Cl

  6. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

    我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

  7. ruby - 难道Lua没有和Ruby的method_missing相媲美的东西吗? - 2

    我好像记得Lua有类似Ruby的method_missing的东西。还是我记错了? 最佳答案 表的metatable的__index和__newindex可以用于与Ruby的method_missing相同的效果。 关于ruby-难道Lua没有和Ruby的method_missing相媲美的东西吗?,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.com/questions/7732154/

  8. ruby - 使用 Vim Rails,您可以创建一个新的迁移文件并一次性打开它吗? - 2

    使用带有Rails插件的vim,您可以创建一个迁移文件,然后一次性打开该文件吗?textmate也可以这样吗? 最佳答案 你可以使用rails.vim然后做类似的事情::Rgeneratemigratonadd_foo_to_bar插件将打开迁移生成的文件,这正是您想要的。我不能代表textmate。 关于ruby-使用VimRails,您可以创建一个新的迁移文件并一次性打开它吗?,我们在StackOverflow上找到一个类似的问题: https://sta

  9. ruby - 使用 C 扩展开发 ruby​​gem 时,如何使用 Rspec 在本地进行测试? - 2

    我正在编写一个包含C扩展的gem。通常当我写一个gem时,我会遵循TDD的过程,我会写一个失败的规范,然后处理代码直到它通过,等等......在“ext/mygem/mygem.c”中我的C扩展和在gemspec的“扩展”中配置的有效extconf.rb,如何运行我的规范并仍然加载我的C扩展?当我更改C代码时,我需要采取哪些步骤来重新编译代码?这可能是个愚蠢的问题,但是从我的gem的开发源代码树中输入“bundleinstall”不会构建任何native扩展。当我手动运行rubyext/mygem/extconf.rb时,我确实得到了一个Makefile(在整个项目的根目录中),然后当

  10. Ruby 写入和读取对象到文件 - 2

    好的,所以我的目标是轻松地将一些数据保存到磁盘以备后用。您如何简单地写入然后读取一个对象?所以如果我有一个简单的类classCattr_accessor:a,:bdefinitialize(a,b)@a,@b=a,bendend所以如果我从中非常快地制作一个objobj=C.new("foo","bar")#justgaveitsomerandomvalues然后我可以把它变成一个kindaidstring=obj.to_s#whichreturns""我终于可以将此字符串打印到文件或其他内容中。我的问题是,我该如何再次将这个id变回一个对象?我知道我可以自己挑选信息并制作一个接受该信

随机推荐