Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dontpanic92/OpenPAL3

仙三开源版 - The efforts to create an open-source implementation of Chinese Paladin 3
https://github.com/dontpanic92/OpenPAL3

game game-engine open-source pal pal3 rust vulkan

Last synced: about 1 month ago
JSON representation

仙三开源版 - The efforts to create an open-source implementation of Chinese Paladin 3

Host: GitHub
URL: https://github.com/dontpanic92/OpenPAL3
Owner: dontpanic92
License: gpl-3.0
Created: 2020-02-15T23:07:27.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-04-13T20:17:02.000Z (8 months ago)
Last Synced: 2024-04-14T10:51:47.922Z (8 months ago)
Topics: game, game-engine, open-source, pal, pal3, rust, vulkan
Language: Rust
Homepage: https://3.openpal.io/
Size: 3.15 MB
Stars: 543
Watchers: 24
Forks: 59
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-github-star - OpenPAL3 - The efforts to create an open-source implementation of Chinese Paladin 3 | dontpanic92 | 533 | (Rust)

README

# 仙三开源版

![Windows](https://img.shields.io/github/actions/workflow/status/dontpanic92/OpenPAL3/ci-windows.yml?branch=master&style=flat-square&label=Windows&logo=windows)
![Linux](https://img.shields.io/github/actions/workflow/status/dontpanic92/OpenPAL3/ci-linux.yml?branch=master&style=flat-square&label=Linux&logo=linux)
![macOS](https://img.shields.io/github/actions/workflow/status/dontpanic92/OpenPAL3/ci-macos.yml?branch=master&style=flat-square&label=macOS&logo=apple)
![Android](https://img.shields.io/github/actions/workflow/status/dontpanic92/OpenPAL3/ci-android.yml?branch=master&style=flat-square&label=Android&logo=android)
![PSVita](https://img.shields.io/github/actions/workflow/status/dontpanic92/OpenPAL3/ci-psvita.yml?branch=master&style=flat-square&label=PlayStation%20Vita&logo=playstation)

> 云对雨，雪对风，仙剑对妖弓。

《仙剑奇侠传三》开源实现。仙三开源版仍处于早期开发阶段，存在很多未实现的功能及 Bug，暂无完善的游戏体验。

## 📢 声明

- 仙三开源版不附带任何《仙剑奇侠传三》的游戏数据，因此您必须拥有《仙剑奇侠传三》的正版拷贝才可以正常运行仙三开源版。
- 仙三开源版并非软星公司或大宇集团的官方作品。

## 🏡 社区

欢迎加入 QQ 群 636662894

## 📌 下载

v0.3 版本请前往 Releases 页面下载，[Azure Pipelines](https://dontpanic92.visualstudio.com/OpenPAL3/_build?definitionId=5&_a=summary&repositoryFilter=5&branchFilter=9) 上可以获得最新开发版本。

### 运行

**首次运行前请手动修改 `openpal3.toml`，将《仙剑奇侠传三》游戏目录填入：**
**（请注意反斜杠需要重复两次）**

```
# PAL3.exe 所在的目录
# The folder where PAL3.exe is
asset_path = "E:\\CubeLibrary\\apps\\1000039"
```

之后运行 `openpal3.exe` 即可。如果运行时提示 OpenAL 出错，[请下载并安装 OpenAL](http://www.openal.org/downloads/oalinst.zip)。

### 操作

- 空格键：对话框下一句
- A/D键：调整视角
- Esc键：跳过过场动画
- F键：互动
- 方向键：跑
- 1/2/3/4：存档至第1、2、3、4号存档位

## 🛠 本地构建

目前 OpenPAL3 支持 Windows、Linux、 macOS 和 Android 作为目标平台。

### 工具链与依赖库

在构建 OpenPAL3 前，请确认已安装以下工具链与依赖库：

- [Rust](https://www.rust-lang.org/) nightly toolchain
- 理论上 MSVC ABI 工具链与 GNU ABI 工具链均可编译
- [OpenAL](https://www.openal.org)
- [最新的 Vulkan SDK](https://www.lunarg.com/vulkan-sdk/)

### 构建步骤

```
cd openpal3
cargo build --release
```

构建 Android 平台安装包需要先安装`cargo-apk`，并设置好 NDK 开发环境
```
cd openpal3 && cargo apk build --release --lib
```

### 常见问题

macOS 平台下由于 nightly 工具链的一个[bug](https://github.com/rust-lang/rust/issues/91372) 构建时可用下面命令规避链接错误的问题：

```
MACOSX_DEPLOYMENT_TARGET=11.0 cargo build --release
```

## 🙋‍♂️ 贡献

非常感谢一同参与 OpenPAL3 的开发！请参看 [CONTRIBUTING](CONTRIBUTING.md) 来了解参与项目的要求与步骤。

## 📔 相关资料

- [@zhangboyang/PAL3patch](https://github.com/zhangboyang/PAL3patch) 提供了简单有效的脱壳工具
- [仙剑三高难度吧](https://tieba.baidu.com/f?kw=%E4%BB%99%E5%89%913%E9%AB%98%E9%9A%BE%E5%BA%A6) 有一些关于仙剑三数据文件的目录结构与内容的讨论
- [这个转帖](https://tieba.baidu.com/p/5381666939?red_tag=0041464978) 分析了 `pol` 文件的部分结构
- [看雪论坛的这篇帖子](https://bbs.pediy.com/thread-157228.htm) 分析了 `cpk` 与 `sce` 的文件格式