Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.41 KB

development.md

File metadata and controls

45 lines (30 loc) · 1.41 KB

贡献与开发指南

ArkLights(速通)是一个开源的,几乎没有任何限制的开源项目,我们欢迎任何人的代码贡献,这将使得这个项目变得更好!不过为了顺利的开发,请所有贡献者了解以下事项。

须知

  • 请尊重项目代码风格,即使你并不喜欢他,大面积的reformat对代码审阅是一种灾难!
  • 请尽量避免改动已经存在的代码,除非这个是一个经过测试且确信的该进,请在commit中进行标注。
  • 请不要重载已经存在的函数,本项目的底层含有大量耦合的代码,请不要重载他们。
  • 任何pr前请先确保本地测试通过。

Windows开发指南

推荐工具

  • Visual Studio Code
    • sumneko.lua
    • formulahendry.code-runner
    • Koihik.vscode-lua-format(可选)
    • 教主.lrzs(可选,可能无法在vsc插件商店中找到)
  • 懒人精灵

开发环境部署

  1. 下载并安装懒人精灵
  2. 创建项目名为main的空项目
  3. 从仓库拉取最新的代码到本地
  4. 根据仓库项目结构手动创建相同的空文件到懒人精灵的工程中
  5. 修改本地仓库中的0.py的路径配置,并运行 python3 0.py saverun (需要管理员权限)

Linux开发指南

TODO

常用注释

-- 禁用热更新 不禁用无法进行本地调试开发
disable_hotupdate = true

-- 开启全局日志输出
always_enable_log = true