Wuxia, Start! (Officially completed)

注：由于版号相关政策限制，不在中国大陆地区提供iOS渠道(AppStore)下载，有需要的可以切换区域进行下载。

Note: Due to publishing-license policy restrictions, the iOS channel (App Store) is not available in mainland China. If needed, please switch your region to download it.

开发者手册 (Developer Handbook) | 包体下载 (Game Downloads) | 联系我们 (Contact Us) | 捐助项目 (Support the Project) | 授权列表 (Asset Authorization List) | 耻辱榜 (Hall of Shame)

《群侠传，启动！》 是一个开放源代码的武侠RPG游戏框架，旨在致敬经典游戏《金庸群侠传》，并为此类游戏爱好者提供一个二次创作与交流的平台。

Wuxia, Start! is an open-source wuxia RPG game framework created as a tribute to the classic Heroes of Jin Yong, while also providing a platform for fan creations and community exchange.

你可以体验样例工程《渡城残魂传》，扮演灵魂穿越附身于小乞丐的莫桥山庄掌门人“莫穿林”，解开自己死亡之谜。

You can try the sample project The Wandering Soul of Ducheng, in which you play “Mo Chuanlin,” the master of Moqiao Manor whose soul has crossed over into the body of a little beggar, and uncover the mystery behind your own death.

你亦可使用本框架制作游戏MOD，并上传到创意工坊。

You can also use this framework to create game mods and upload them to the Workshop.

一切均免费，纯粹用爱发电。非常欢迎感兴趣的朋友加入。

Everything here is free, driven purely by passion. Friends who are interested are more than welcome to join us.

但未经允许，不允许在本项目及其MOD以外任何场景使用本项目任何素材、资源（包括商用/非商用）！否则将上本项目的耻辱榜。具体可以关注本项目相关开源协议。

However, without permission, none of this project’s materials or assets may be used in any context outside this project and its mods, whether for commercial or non-commercial purposes. Violators will be listed on the project’s Hall of Shame. Please refer to the relevant open-source agreements for details.

Project Goals

• 使用Unity引擎重制并致敬经典游戏《金庸群侠传》DOS版；
  Recreate and pay tribute to the classic DOS game Heroes of Jin Yong using the Unity engine;

• 提供统一的平台，支持重制《金群》的一系列MOD或二次开发；
  Provide a unified platform to support a series of Heroes of Jin Yong mods, remakes, and secondary development;

• 提供开放的能力给社区，有兴趣贡献力量的朋友可以让这个作品更加完善；
  Offer open capabilities to the community, so that contributors can help make this project even better;

• 提供一个完备的单机游戏结构供有兴趣学习开发游戏的朋友进行参考；
  Provide a complete single-player game structure for those interested in learning game development.

我们承诺：本项目除了爱好者的自愿捐款以外，不会在任何渠道取得收入。最终的代码、资源、包体都仅供学习使用，请勿用于任何商业目的。一切再度商用均不被本项目允许和授权，如果有任何侵犯您的权益，欢迎与我们取得联系。

We promise that, aside from voluntary donations from enthusiasts, this project will not generate revenue through any channel. The final code, assets, and builds are for learning purposes only and must not be used for any commercial purpose. Any further commercial use is neither permitted nor authorized by this project. If anything here infringes upon your rights, please feel free to contact us.

Sample Mod: The Wandering Soul of Ducheng

项目地址 (Project Link)

• 约3-4个小时的主线游戏剧情体验，可最终通关并解开自己死亡之谜，以及掩盖在该谜底下的阴谋
  Around 3 to 4 hours of main-story gameplay, with a complete ending that reveals the mystery of your death and the conspiracy hidden beneath it

• 多游戏结局
  Multiple endings

• 多名风格各异的可入队队友
  Multiple recruitable companions with distinct styles

• 十余种可学习武学
  More than ten martial arts techniques to learn

• 上百种不同道具
  Over a hundred different items

Gameplay Screenshots

Sample Mod: Infinite Roguelike Wuxia

项目地址 (Project Link)

一个roguelike武侠的DEMO，供MOD开发者参考。

A roguelike wuxia demo provided as a reference for mod developers.

玩家亦可简单体验游玩，纯粹享受BUILD和战斗的乐趣。

Players can also try it directly and simply enjoy the fun of building teams and fighting.

• 在本玩法里战斗纯自动，不可手操
  Battles in this mode are fully automatic and cannot be manually controlled

• 玩家每通关一次可以选择想要的奖励
  Each time players clear a stage, they can choose the reward they want

• BUILD好队伍，迎接下一关的挑战
  Build a strong team and take on the next challenge

• 战斗将越来越难，奖励将越来越好
  Battles become harder and rewards become better over time

• 不允许S/L，此玩法直面人生（自动保存）
  Save-scumming is not allowed in this mode; face your fate directly (with auto-save)

• 运气和实力兼具的挑战
  A challenge that requires both luck and skill

Sample Mod: Heroes of Jin Yong 3D Remake

项目地址 (Project Link)

金庸群侠传3D重制版是一个回合制战棋战斗开放世界RPG游戏。它是一个非盈利游戏项目，项目目标为重制经典游戏《金庸群侠传》（Heroes of Jin Yong），并支持后续一系列MOD和二次开发。你也可以通过在线玩DOS原版（Play the original DOS version online）体验原作。你可以在PC、MAC或移动手机平台(或其他支持平台)游玩。

Heroes of Jin Yong 3D Remake is an open-world RPG with turn-based tactical combat. It is a non-profit game project aimed at remaking the classic Heroes of Jin Yong while also supporting a series of future mods and secondary development. You can play it on PC, Mac, mobile, or other supported platforms.

Gameplay Screenshots

Development Plan

已全部完结

All tasks have been completed.

• 素材资产实现
  Asset production completed

  • 按照新的风格绘制原版所有的角色立绘
    Redrew all original character portraits in the new visual style

  • remix原版所有的音乐
    Remixed all of the original music

  • 制作所有角色的模型
    Created models for all characters

  • 制作所有武功动作
    Produced all martial arts animations

  • 所有场景制作，包括RPG部分和战斗部分
    Built all scenes, including both RPG and battle sections

  • 依据重制版的风格绘制新的道具图标（放弃）
    Draw new item icons in the remake’s style (abandoned)

  • 原版开场动画重新实现（放弃）
    Recreate the original opening animation (abandoned)

  • 结局原画绘制
    Created ending illustrations

  • 武功特效调制
    Produced martial arts visual effects

• 风格化的画面渲染效果实现
  Implemented stylized rendering effects

• 基础系统实现，包括地图、道具、角色、战斗等
  Implemented core systems including maps, items, characters, combat, and more

• 支持剧情脚本指令系统，支持可视化的剧情脚本编辑系统
  Added a story scripting command system and a visual story script editor

• 完整复刻实现金庸群侠传游戏流程，可正常通关
  Fully recreated the gameplay flow of Heroes of Jin Yong, with a complete playable path to the ending

• 支持多端输出，一键打包
  Supports multi-platform builds with one-click packaging

• 所有代码和资源全部开源，不依赖闭源库（标准第三方库除外）
  All code and resources are open source and do not rely on closed-source libraries, except standard third-party libraries

• 优化游戏运行性能和代码质量
  Optimized runtime performance and code quality

• 提供MOD启动器，提供金群MOD开发环境和样例
  Provided a mod launcher as well as a mod development environment and samples for Heroes of Jin Yong

• 提供联机战斗对战、ONLINE网络游戏模式的样例和DEMO（放弃）
  Provide sample demos for online battle and online game modes (abandoned)

Technical Overview

• 核心流程使用脚本驱动，目前支持lua和可视化图编辑两种模式，很方便编程扩展指令
  The core workflow is script-driven and currently supports both Lua and visual graph editing, making it easy to extend commands programmatically

• 逻辑配置数据使用ScriptableObject存储，并提供基于ODIN的可视化编辑环境，配置数据在Editor运行时可以所见即所得编辑，不需要重启游戏
  Logic configuration data is stored with ScriptableObject, and an Odin-based visual editing environment is provided, allowing WYSIWYG editing during Editor runtime without restarting the game

• 为战棋模式，本框架提供一套简单的基于贪心算法的AI，易于扩展
  For tactical combat mode, the framework provides a simple AI based on greedy algorithms that is easy to extend

• 每个地图为一个场景，地图间可以串接
  Each map is an individual scene, and scenes can be connected together

• 游戏存档使用EasySave3插件
  Game saves use the EasySave3 plugin

• UI方案使用Unity原生的UGUI
  The UI solution uses Unity’s native UGUI

• 使用默认渲染管线，卡通渲染风格
  Uses the built-in render pipeline with a toon-rendered visual style

• 动作管理部分大量使用Animancer插件，亦使用unity原生AnimatorController方案
  Animation management relies heavily on the Animancer plugin, while also using Unity’s native AnimatorController approach

• 资源打包和加载使用AssetBundle
  Asset packaging and loading are handled through AssetBundle

• 游戏中大量使用基于UniTask的异步编程方案来进行逻辑串接，以及防止大量回调嵌套
  The project makes extensive use of UniTask-based asynchronous programming to connect gameplay logic and avoid deeply nested callbacks

• 技能特效使用了不少assetstore上的第三方库，如想使用，还请自行购买
  Many skill effects rely on third-party Asset Store packages; if you want to use them, please purchase them yourself

• 关于MOD框架实现的技术细节请移步MOD开发者手册（Mod Developer Handbook）
  For technical details about the mod framework implementation, please refer to the Mod Developer Handbook.

Project Documentation Navigation

• 你可以查阅开发者手册（Developer Handbook）来学习本项目的开发细节，其中包括详细的如何配置启动游戏、脚本修改、系统编程等一系列项目细节。
  You can read the Developer Handbook to learn the project’s development details, including how to configure and launch the game, modify scripts, and work with system programming

• 可通过查看金庸群侠传3d重制版视频操作教程（Heroes of Jin Yong 3D Remake video tutorial）来学习如何搭建游戏场景、添加和配置技能动作等。
  You can also learn how to build scenes, add skill animations, and configure gameplay content through the Heroes of Jin Yong 3D Remake video tutorial

• 本项目非常欢迎社区进行贡献，请阅读社区贡献指南（Contribution Guide）查看具体规则和流程。
  Community contributions are highly welcome. Please read the Contribution Guide for detailed rules and workflow

• 本项目美术原始文件位于jynew/jynew_art（art source repository），你可以下载3DMAX等原始文件查看。但请注意：此项目内容同样遵守社区协议。
  The original art source files for this project are available in the art source repository, where you can download original files such as 3ds Max assets. Please note that the contents of that repository are also governed by the community agreement

License Statement

• 本项目素材一部分为社区自制，一部分为互联网上取得
  Some assets in this project were created by the community, while others were sourced from the internet

• 本项目遵循MIT协议，但金庸群侠传3D重制版社区素材协议（Heroes of Jin Yong 3D Remake Community Asset License）描述了若干种在本项目中覆盖MIT协议情况，请仔细阅读
  This project follows the MIT License, but the Heroes of Jin Yong 3D Remake Community Asset License describes several cases in which it overrides the MIT terms within this project, so please read it carefully

• 项目中所包含外部插件源代码、资源和链接库等，如希望在其他场景使用，请务必确认符合其本身授权规范
  If you wish to use any external plugin source code, assets, or linked libraries included in this project in other contexts, please make sure such use complies with their own license terms

• 不遵守授权协议的产品和企业、个人都将被耻辱榜（Hall of Shame）记录在案
  Products, companies, or individuals that do not comply with the license terms will be recorded on the Hall of Shame

Project Structure Diagram

Related Projects

群侠传启动-Steam创意工坊上传工具 (Wuxia, Start - Steam Workshop Upload Tool)

发码机器人 (Key Distribution Bot)

Referenced Projects

xlua, xNode, UniTask, EasySave3

Reference Project

kyscpp

Additional Notes

以下插件仅供学习使用，若希望使用它还请自行购买重新导入：

The following plugins are for learning purposes only. If you would like to use them, please purchase and import them yourself:

Odin Inspector , GPU Instancer , Rewired

Community

• 玩家Q群
  
  0群 346751656（已满）
  1群 480072818（已满）
  2群 704370277（已满）
  3群 704697875（已满）
  4群 389536186（已满）
  

• 玩家讨论论坛（Player Discussion Forum）：https://tiexuedanxin.net/forum-38290-1.html