Git Product home page Git Product logo

seerh5-assistant's Introduction

SEA Project

赛尔号 H5 端登陆器 && api 封装接口

license core version launcher version last commit

目前处于alpha阶段,整体架构和api随时可能有大型更改和重构

置顶声明

IMPORTANT:项目全部开源,仅供学习使用,禁止用于任何商业和非法行为。项目内全部功能不涉及付费相关和 pvp 相关,项目内全部通信仅涉及淘米官方服务器,不涉及任何第三方。

WARNING: 目前该项目的安全性考虑是欠缺的,请注意:模组是不可信且不受控的外部代码,将在前端执行,这可能导致严重的安全问题!请勿安装任何未经事先人工验证的模组!

近期公告

请在SEA Project网站上查看: SEA Project

最近更新的内容

请在SEA Project网站上查看: SEA Project

简介

SeerH5-Assistant 是一款使用typescript编写的赛尔号H5端登陆器。项目目前包含四个部分:core、launcher、server、sdk,其中

  • core: 核心库,负责环境注入和接口封装
  • launcher: 目前的登录器应用程序原型,同时负责e2e测试
  • server: 登陆器后端,负责登陆器服务,游戏资源反代以及用户配置的存储(参见现在还不存在的文档了解为什么使用后端服务而不是直接使用Electron来实现这些)
  • sdk: 适用于本登录器的模组开发框架

项目简称: SEA,登录器简称:SEAL

快速入门

前排提示:本项目目前处于开发阶段,没有可用的成品,如果你对相关的技术栈不熟悉,可以等待该项目成熟后再来。

首先clone整个仓库,然后安装依赖:

pnpm i

依赖安装完成后,项目目前结构如下:

  • core: 核心库,
  • launcher: 登录器前端本体
  • server:登录器后端
  • sdk: sdk环境,内含一些预制的模组包

然后你需要分别为前端和sdk安装sea-core,由于各种因素的考虑,sea-core没有发布在npm上,因此你有两种选择:

  1. 通过本地tarball包安装
  2. 通过远程tarball包安装

不过现阶段使用clone整个项目的方式来尝鲜的话,可以直接遵循下面步骤:

  1. 对sea-core执行手动构建,得到dist输出。

packages/core下执行:

pnpm build

因为launcher是使用工作区链接来安装sea-core的,因此现在登录器就能使用了。

  1. 在开发模式下,分别运行登录器的前端和后端。

server包下启动后端服务:

pnpm start

然后在package/launcher下创建.env.local文件,详情见vite的环境变量配置文档:

VITE_BACKEND_PORT={你的后端端口号,默认是2147}

然后在launcher包下启动开发服务:

pnpm dev
  1. 如果要进一步使用sdk中的预设模组,你可以直接运行:
pnpm release
pnpm build

第一条命令会启用一个脚本来构建sea-core,并自动安装到sdk下, 第二条命令会自动构建模组并复制到server的mods目录下。

最后进入游戏!请注意浏览器版本, 如果不支持import-map, 原生esm加载等功能, 需要手动添加相应的polyfill。

  1. 如果要进行服务的打包构建,即生产环境的构建,则第二步中不需要分别运行前后端,而是在主目录下运行构建脚本:
pnpm build

该命令会启用一个构建脚本,构建登录器前端和后端,并使用pkg打包为Windows下可以独立运行的服务器程序。

注意该项目的后端的主要功能是作为本地数据存储跨域反代部署在本地,对于每一个用户存的都是独一份的数据。暂时还不考虑一人游玩多个号的场景。

关于编写模组的例子,请看下面的例程。

SDK的环境构成

  1. typescript+vite脚手架的基本配置
  2. sea-core库的接口定义, 以及将其视为外部模块所需的相关配置
  3. launcher扩展的sea-core定义,提供了更多高级常用功能
  4. launcher提供的模组定义文件,用以支持模组的开发
  5. sea-core库内嵌的egret白鹭引擎定义,以及seerh5游戏模块的反混淆定义

功能点

core:

  • 自动战斗
    • 设置战斗模型
    • 完备的回合信息
  • 统一的游戏静态数据查询接口
  • 常用操作封装
  • 精灵养成操作封装
    • 包含一个内部精灵信息缓存
  • 收发包支持
  • 多个事件订阅器
    • 模块加载
    • 收发包
    • 各种事件的监听
    • 注入了额外的常用事件的hook
  • 游戏内实体封装
  • 支持扩展

launcher:

  • 扩展核心
    • 实现一些常用功能集
      • 压血
      • 战队派遣
      • 切换背包
    • 游戏内部优化
      • 本地换肤
      • 静态模式对战加速
      • 查看对方血量
      • 战队加成一键加满
      • h5端自动治疗开关
      • 离屏挂机
      • 更多功能编写中...
  • 控制面板,你可以在这里轻松:
    • 切换称号
    • 切换套装
    • 分开治疗指定精灵
    • 压血
    • 借火
    • 保存并切换背包
  • 一键签到
  • 一键日任,稳定不掉线
  • 因子扫荡
  • 收发包调试
  • 手动设置常用战斗
  • 快捷控制面板
  • 充分的功能扩展支持(未实现)

其他:

  • 入口注入
  • 多重缓存加速游戏加载
  • 登陆器和实际游戏客户端之间的ui与数据同步
  • 反代资源
  • ui操控

完整参考

请等待还没完工的文档

原理与高级用例

同上,包括注入原理,修改原理,如何拿到官方原始源码进行调试,收发包细节,官方游戏引擎细节等

运行测试

目前登录器本体的功能就直接当作手动e2e测试啦!

对于core核心库的测试,同样需要先运行后端。

路线图 (Road Map)

Core:

--> Release: 1.0.0 解耦登录器特定逻辑以及非核心功能, 要求可以方便对接到launcher

App:

  • --> 0.6.x 重构React组织和实现,将使项目具有一定可用性,支持docker部署,拥有SDK
  • 0.7.x 版本将重构迁移至electron

开源协议

MPL-2.0

并确保您遵守了 eula 中的开发者条款

seerh5-assistant's People

Contributors

davidfan168 avatar median-dxz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

seerh5-assistant's Issues

[错误报告] 运行程序时出现 "Error: connect ECONNREFUSED ::1:80" 错误

错误描述
在尝试使用该程序时,我遇到了以下错误信息:

03:57:58 [vite] http proxy error at /seerh5.61.com/app.js?t=1686556678680:
Error: connect ECONNREFUSED ::1:80
    at TCPConnectWrap.afterConnect [as oncomplete] (node:net:1494:16)

问题背景
我尝试在我的环境中使用程序时遇到了这个错误。这个程序使用了 Vite 构建工具,并尝试在本地运行一个 HTTP 代理。

错误详细信息
错误信息中指出了错误的原因和位置。根据错误提示,这是一个连接被拒绝的错误 (ECONNREFUSED),发生在本地主机 (::1) 的 80 端口上。

问题重现步骤
在我的环境中,安装了所需的依赖并克隆了程序的代码。
在终端中进入程序的根目录,并执行启动命令。
在启动过程中,出现了上述错误信息。
期望行为
我期望程序能够成功启动,并且 HTTP 代理能够正常工作,没有连接被拒绝的错误。

环境信息
操作系统:Windows 11
Node.js 版本:v18.16.0
NPM:9v.7.1
其他相关软件或依赖的版本信息
为了解决这个问题,我已经尝试了以下方法:
检查本地主机和端口是否正确,并确保没有其他程序占用了该端口。
确认是否存在防火墙或网络代理的配置问题,导致连接被拒绝。

迁移后端至ts

全面启用typescript,之后进一步将使用tRPC和websocket来支持前后端之间的交互

因子兑换界面修改

在core中支持的部分:

  • 根据id判断精灵是否存在
  • 如果存在则获取ct
  • pet支持判断
    • 是否开启魂印(通过Pet对象的hasEffectgetter判断是否有魂印,然后通过player-info模块下的isPetEffectActivated函数判断是否激活)
    • 是否拥有第五(通过Pet对象的hideSkillActivated属性,存在说明有第五,true/false代表是否开启)

在sdk中实现的功能:

  • 更改筛选因子的行为
    • 未兑换本体但有因子
    • 已兑换精灵但是没兑换第五和魂印
    • 可兑换时列表显示叹号
  • 兑换魂印第五的时候自动首发精灵再启动兑换, 如果背包没空间或精灵不存在则维持默认行为(提示需要手动设置首发)
  • 右侧面板直接显示是否拥有
  • 右侧面板在已拥有时disable按钮

因为现在常常需要查一下这个精灵换过没,如果换过是缺第五还是缺魂印,很麻烦,所以想写一个修改功能。因为这个字是贴图,所以加筛选按钮不是那么方便,就直接改功能了。
具体来说,修改两个筛选选项:

  • 未拥有:这个精灵因子还没有兑换过本体
  • 可合成:所有已经有本体,但是缺第五 or 魂印的

上述操作只支持唯一性精灵!

SEA Project v0.6.x 版本迭代计划

主项目

  • 项目更名为SEA(Seerh5 Assistant Project), 启动器部分名称更改为SEAL(Seerh5 Assistant Launcher)
    • core包更名为sea-core
    • server包现在是@sea/server
    • app包现在是@sea/launcher

其实名称没变,变的是缩写

工具链部分

  • 项目全面启用pnpm
  • 添加nodemon支持
  • 添加concurrently支持

后端 & 技术栈

  • 后端迁移至TS+fastify+tRPC (#9)
  • 样式引擎切换至emotion

SEA Core v0.5.0

  • logger部分重写,迁移log逻辑到app层,core不再负责log信息的显示
  • 重构对战策略模块概念, 精简核心的职能, resolveStrategyManager导出, 主要逻辑的处理移交登录器层

SEA Core v0.6.0

  • 重构GameConfig查询模块, 采用注册接口架构, 配合TypeMap, 添加可扩展性
    • 通过模块声明合并以及全新的GameConfigRegistry注册可查询的GameConfig
    • 通过GameConfigRegistry获得GameConfigQuery对象用以查询数据
  • 事件模块全部重构, 采用RxJS, 以响应式结构作为事件相关逻辑的组织方式 (#10)
    • 使用Subscription来批量管理订阅
    • DataSource现在是使用观察者模式而不是发布订阅模式
    • 使用DataSource上的静态方法from*来获取事件流, 而后进行订阅
    • 移除SendWithReceivedPromise接口, 根据发包客户端的源码分析,这个接口是没有必要的
  • wrapperapi重构, 采用链式不可变结构对函数添加beforeafter装饰器

SEA Core v0.7.0

  • 使用类型来提示SDK使用者和Launcher开发者当前Core的版本
    • CoreLoader上来获取实例版本, 从type中获取api定义的版本
  • CoreLoader现在不需要传入监听事件名了
  • 属性攻击/特攻/物攻的枚举
  • 额外允许一些模块打印关键日志, 通过common包下的log模块启用
    • Log.setLogger()允许使用自定义logger, 默认启用console.log, 输出格式为[sea-core][module name]:
    • 外部api为Log.enable()Log.disable(), 通过传入模块名称来开启这一部分的输出
    • 目前暂定支持的模块只有Battle, 开启后将输出Operator模块的入参
  • LevelRunner api更改
  • 更改事件签名方式->type:event
  • 修复缺失的fromEventPattern导出
  • 更换playerSuit的检测方式, 添加更多定义
  • GameConfigQuery api更新
    • 添加查询id的getIdByName 方法
    • 现在要求传入以id为键的Map, 查询id时现在基于Map, 以此加快对大表进行id查找时的速度
    • 添加对Equipment(装备)的查询
    • Query的查询方法现在具有正确的可空返回type

Launcher部分

#11

  • 重新组织UI实现, 添加基于Tabs的路由
  • 添加独立Service层, 实现最基本的模组管理
  • 重新组织入口点部分的代码
  • 迁移所有旧版关卡
  • 更换sdk和模组定义, 现在是基于函数组合的实现而不是原来基于类的实现
    • 迁移所有模组到现在的sdk接口
  • 命令栏功能重新启用

预设模组集

sdk

  • sign类模组:对check进行优化,批量查询multiValue,减少发包次数 sign类模组接口即将改变,之后会重写对应部分

theme传sx,不用手动导入!

  • createLocalStorageProxy api已删除
  • extractObjectId api已删除

issues:

  • #4
  • 战队派遣模块的bug(重复刷新)
  • 更新背包精灵发包后无响应的bug(cache await update一直不resolve)(hmr?)
    • 在两个缓存逻辑修复之后暂未发生过
  • #5
  • 不能正确领取精灵王每周奖励
  • 套装更换面板不能正确识别目镜栏位
    • 预定修改方案是更换套装功能不变,单独检测当前套装效果,同时加上目镜栏的更换功能

签到部分修正

  • 添加战队道具自动兑换
    • 正确判断道具设施是否开启
  • 判断今日派遣次数
  • 修复vip领取错误
    确的判断今日点数是否领取预设总点数到二十再领取(懒得改了)
    • 正确的判断是否可以领取点数奖励
    • 正确的领取设置的点数奖励
    • 领取日/周/月礼包

sa-core package.json

seerh5-assistant/packages/core/package.json 的export 里不知道为什么路径都是relative to dist 文件夹的,但是core里面并没有这个文件夹,是不是之前有然后没改package.json啊。

给`launcher`的测试脚本加上`--host`

如题,本人电脑是经常开着代理的,如果测试脚本不加--host进行暴露,就会出现无法访问的情况

"dev": "vite --open"

改成

"dev": "vite --host --open"

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.