/LeeClient

LeeClient 客户端

LeeClient 是一个整合仙境传说官方所有图档资源, 方便 GM 切换不同版本客户端进行 调试和研究的仙境传说完整客户端, 最终可基于 LeeClient 制作出自己的完整客户端.

运行或使用条件

  • 使用Git for Windows + TortoiseGit 或其他类似 Git 客户端来克隆仓库
  • 进行克隆之前, 需要确保你的 Git 客户端能够支持 LFS (划重点)
  • 请安装大于等于 Python3.7.x 的官方版本 (Windows 避免使用 ActivePython)
  • 使用速度更快的固态硬盘或 M.2 接口的硬盘来存储 LeeClient (小文件有 10 万多个)
  • 至少需要 12 GB 的本地硬盘空间 (仙境传说客户端的体积 + Git 仓库信息)
  • 你应该知道 cmd 或 终端 的含义, 虽然我们需要用的命令并不多
  • 拥有比常人更加好的耐心, 这很重要

为什么要使用 LFS ?

本工程拥有大量的二进制文件(图片、图档、MP3、WAV等), 这些文件如果正常存储在 Git 仓库中会导致 Git 仓库需要维护大量的文件信息, 降低了 Git 的运行效率.

LFS 是 Large File Storage (大文件存储) 的简称, 是 Git 用来解决拥有大量二进制 文件的工程降低 Git 运行效率的问题一套方案. 说白了就是以前存储在 Git 仓库的二进制 文件会被存放到另外一个地方(大文件仓库)去, 然后 Git 仓库只保留这个二进制文件在大文 件仓库的指针(可以简单理解为二进制文件的网址). 必要的时候 Git 再去下载这些大文件.

如何安装或使用 LFS ?

本工程大量的二进制文件都已经存放到了 LFS 中, 克隆本项目之前, 请先确保您的 git 环境支持 LFS, 否则克隆到本地的内容可能会不完整 (只有指针, 没有具体的文件). 若你 克隆完成后发现 LeeClient 才 200 MB左右, 那肯定是 LFS 没有正常工作. 若正常工作 的话整个 LeeClient 包括仓库信息, 至少在 10 GB 以上.

如何安装 git-lfs 插件请参考相关说明: https://coding.net/git/lfs 后续我们会 录制一些视频, 介绍不同环境下如何确保自己 Git 的 LFS 是可用的, 并正确克隆本项目.

国内加速镜像

由于 Github 在**大陆地区的访问速度很慢, 且本工程的体积和文件数量巨大, 为了方便 大家能以更快速度将本工程克隆下来, 我们将 LeeClient 镜像到 "腾讯云开发者平台".

当您试图克隆本项目的时候, 可以换用以下指令从"腾讯云"来进行克隆:

git clone https://git.dev.tencent.com/cairolee/LeeClient.git

首次克隆完毕的注意事项

在您第一次克隆完成此 LeeClient 仓库时, 如果发现刚克隆完成, git 就显示大量红色 的“已修改”状态, 那么您需要修改您本地该仓库的 git 配置.

  1. 请打开可调用 git 指令的命令行控制台
  2. cd 切换到本仓库在您电脑上的路径 (例如：C:\LeeClient)
  3. 执行 git config core.filemode false 关闭当前仓库的 filemode 检测

使用 LeeClientAgent

关于 LeeClientAgent 的环境准备等, 我们在 Utility 目录下单独准备了一份说明文档, 您可以前往查阅: 如何使用 LeeClientAgent

此项目的待办事项

  • 实现汉化覆盖率的统计信息
  • 预置能适配最新 rAthenaCN 的服务端资源, 并提供说明文档
  • 生成按钮汉化数据时, 能够结合各版本客户端补丁 data 目录中的内容
  • 录制 - 简单的使用教程 (环境配置、切换版本、进入游戏)
  • 录制 - 简单的汉化教程 (按钮汉化、物品汉化、技能汉化)
  • 录制 - 如何提交 Pull Request 的教程
  • 支持自动从可更新的客户端上解压并合并部分通用资源文件
  • 设计一种更周全的 msgstringtable 汉化机制
  • 进行大量数据或者文件操作时, 能显示一个进度条
  • 解决老版本客户端没有具备新的 NPC 外观, 在服务端使用新外观会导致客户端崩溃的问题

维护成员招募

此项目长期招募维护人员, 报名者请加入 QQ群: 186495034 并联系群主. 以下为要求:

  1. 熟悉 git 和 github 的使用 (提交、推送、会提 Issues、会提 Pull Request)
  2. 对仙境传说客户端的结构比较清晰, 哪个目录大概做啥用的知道些
  3. 掌握 Lua 5.x 系列的基本语法（汉化非必须, 会最好）
  4. 能掌握 Python3.7.x 最好 (汉化非必须, 但修改 LeeClientAgent 时必须)
  5. 能清楚的描述问题，用科学的方法做事情

目前我们所有维护人员都没有任何报酬, 基本都靠兴趣驱动, 若有捐赠会优先用于项目发展.

版权归属声明

此项目中的官方图档和 Ragexe 系列主程序的版权归韩国重力社 (GRAVITY CO., Ltd.) 所有, 维护团队仅根据网上收集的信息进行整理和归纳.

用于维护此项目的管理程序名为: LeeClientAgent 是一套基于 Python 3.7.x 编写的脚 本程序, 该程序基于 GNU GPLv3. 开源许可协议 (位于 Utility 目录).