|
1 | 1 | <div align="center"> |
2 | | -<img alt="logo" height="80" src="./public/Appicon.png" /> |
3 | | -<h1>PhiCommunity Revive</h1> |
| 2 | +<img alt="logo" height="80" src="./public/AppIcon.png" /> |
| 3 | +<h1>PhiCommunity R## 🤝 如何贡献 |
| 4 | + |
| 5 | +如您所见,游戏还没有完成,具体体现在"谱面少"和"性能差"。ve</h1> |
| 6 | + |
4 | 7 | <p>A fork version of Phicommunity</p> |
5 | 8 | </div> |
6 | 9 | <br /> |
7 | 10 |
|
8 | | -## 这是什么? |
| 11 | +## 📄 这是什么? |
9 | 12 |
|
10 | 13 | 这是一款名为`PhiCommunity`的节奏游戏分支可自部署的版本,它仿照`Phigros`制作,源仓库为[PhiCommunity](https://github.com/yuameshi/phicommunity) |
11 | 14 |
|
12 | | -## 开始部署 |
13 | | -### 部署谱面仓库(可能必要) |
| 15 | +## 🚀 开始部署 |
| 16 | + |
| 17 | +### 部署谱面仓库(可选) |
| 18 | + |
14 | 19 | 部署方法请转到 [PhiCommunity-Charts-Repo](https://github.com/PhiGameRevive/PhiCommunity-Charts-Repo) |
15 | 20 |
|
16 | | -### Github Pages部署 |
| 21 | +### 🌐 Github Pages 部署 |
| 22 | + |
17 | 23 | 1. 点击右上角`Fork`按钮创建当前仓库的副本 |
18 | | -> **可选:** 在`.env`文件中输入自己谱面仓库文件的域名 |
| 24 | + > **可选:** 在`.env`文件中输入自己谱面仓库文件的域名 |
19 | 25 | 2. 点击项目界面的`Actions`, 点击绿色按钮启用`Github Actions`(如果有) |
20 | | -3. 点开项目设置, 转到`Pages`选项卡, 应用以下设置 |
| 26 | +3. 点开项目设置, 转到`Pages`选项卡, 应用以下设置 |
| 27 | + |
| 28 | +| 设置项 | 设置内容 | |
| 29 | +| ------------- | ----------------------------------------------------------------------- | |
| 30 | +| Source | `Deploy from a branch` | |
| 31 | +| Branch | `gh-pages` `/`(root) | |
| 32 | +| Custom Domain | 输入你的域名, 在域名控制台添加`CNAME`记录, 内容为`你的用户名.github.io` | |
21 | 33 |
|
22 | | -| 设置项 | 设置内容 | |
23 | | -|---------------|-----------------------------------------------------------------------------| |
24 | | -| Source | `Deploy from a branch` | |
25 | | -| Branch | `gh-pages` `/`(root) | |
26 | | -| Custom Domain | 输入你的域名, 在域名控制台添加`CNAME`记录, 内容为`你的用户名.github.io` | |
27 | 34 | 5. 最后点击`Save`保存即可, `Github Actions`应该会自动运行, 如果没有, 在项目页面`Actions`选项卡中, 点击 `Build and Deploy to GitHub Pages` 后选择`Run Workflow`即可 |
28 | 35 |
|
29 | | -### Vercel部署 |
| 36 | +### ⚡ Vercel 部署 |
| 37 | + |
30 | 38 | 1. 重复`Github Pages部署`的步骤一的流程 |
31 | | -> **可选:** 在`.env`文件中输入自己谱面仓库文件的域名 |
32 | | -2. 打开[Vercel网站](https://vercel.com), 注册账号, **注册时一定要用国外邮箱, 不然要发工单注册** |
| 39 | + > **可选:** 在`.env`文件中输入自己谱面仓库文件的域名 |
| 40 | +2. 打开[Vercel 网站](https://vercel.com), 注册账号, **注册时一定要用国外邮箱, 不然要发工单注册** |
33 | 41 | 3. 注册完成后进入主页面点击`Add New`, 选择`Project` |
34 | 42 | 4. 在仓库选择页面选择你刚刚创建的副本, 随后点击`Deploy` |
35 | 43 | 5. 部署完成后添加域名, 这里不过多赘述 |
36 | | -> **注意: 你的域名一定要带`vercel`关键字, 否则仓库链接会使用Github Pages的配置** (其实也不用) |
| 44 | + > **注意: 你的域名一定要带`vercel`关键字, 否则仓库链接会使用 Github Pages 的配置** (其实也不用) |
| 45 | +
|
| 46 | +### ☁️ Cloudflare Pages 部署 |
37 | 47 |
|
38 | | -### Cloudflare Pages部署 |
39 | | -1. 重复`Github Pages部署`的步骤一的流程, 注册[Cloudflare账号](https://dash.cloudflare.com/sign-up) |
40 | | -> **可选:** 在`.env`文件中输入自己谱面仓库文件的域名 |
| 48 | +1. 重复`Github Pages部署`的步骤一的流程, 注册[Cloudflare 账号](https://dash.cloudflare.com/sign-up) |
| 49 | + > **可选:** 在`.env`文件中输入自己谱面仓库文件的域名 |
41 | 50 | 2. 打开[Cloudflare Dashboard](https://dash.cloudflare.com), 转到`计算(Workers)` ==> `Worker 和 Pages` |
42 | 51 | 3. 单击`创建`, 选项卡选择`Pages`, 选择`导入现有储存库` |
43 | 52 | 4. 登录`Github`账号后选择你刚刚创建的副本, 构建设置按照以下操作 |
44 | 53 |
|
45 | | -| 构建设置 | 设置内容 | |
46 | | -|---------|-------------| |
47 | | -| 构建命令 | `pnpm i && pnpm build` | |
48 | | -| 构建输出目录 | `dist` | |
| 54 | +| 构建设置 | 设置内容 | |
| 55 | +| ------------ | ---------------------- | |
| 56 | +| 构建命令 | `pnpm i && pnpm build` | |
| 57 | +| 构建输出目录 | `dist` | |
| 58 | + |
49 | 59 | 5. 点击`保存并部署`, 在部署期间可以退出页面设置域名 |
50 | 60 | 6. 进入项目页面点击`自定义域`添加自己的域名 |
51 | | -> **注意: 你的域名一定要带`cf`关键字, 否则仓库链接会使用Github Pages的配置** (其实也不用) |
52 | | -## 许可证 |
| 61 | + > **注意: 你的域名一定要带`cf`关键字, 否则仓库链接会使用 Github Pages 的配置** (其实也不用) |
| 62 | +
|
| 63 | +## 👨💻 原作者 |
| 64 | + |
| 65 | +该仓库原作者为[Yuameshi](https://github.com/yuameshi), 他创作了最初版本的[PhiCommunity](https://github.com/yuameshi/phicommunity) |
| 66 | + |
| 67 | +## 📜 许可证 |
53 | 68 |
|
54 | 69 | 源代码(不包括多媒体资源,除非另有说明)在[AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html)许可下分发 |
55 | 70 |
|
@@ -96,11 +111,11 @@ GNU Affero 通用公共许可证 v3.0 |
96 | 111 |
|
97 | 112 | 如您所见,游戏还没有完成,具体体现在“谱面少”和“性能差”。 |
98 | 113 |
|
99 | | -### 为`谱面`做贡献 |
| 114 | +### 🎵 为`谱面`做贡献 |
100 | 115 |
|
101 | 116 | 如需提交谱面文件,请前往[此仓库](https://github.com/phigamerevive/PhiCommunity-Charts-Repo)。 |
102 | 117 |
|
103 | | -### 贡献代码 |
| 118 | +### 💻 贡献代码 |
104 | 119 |
|
105 | 120 | 如果您想提高该项目的代码质量,请执行上述类似操作:`Fork->Clone->EditCode->Commit->Upload->Open Pull Requests`。不要忘记写下您修改的内容和改进的内容! |
106 | 121 |
|
|
0 commit comments