Skip to content

Commit

Permalink
docs: Add more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
CarmJos committed Mar 16, 2024
1 parent e8a8736 commit 8e32ce6
Show file tree
Hide file tree
Showing 14 changed files with 127 additions and 8 deletions.
Binary file added .doc/images/commit-message.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .doc/images/commit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .doc/images/fork.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .doc/images/web-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .doc/images/writerside-commit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
74 changes: 74 additions & 0 deletions CONTRIBUTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# 为此文档贡献内容

## 1. 注册账号

为了保留您无私贡献的记录,在开始之前,您需要拥有一个 Github 的账号,用于提交您的贡献到本仓库中。

您可以在 [Github - SignIn](https://github.com/signup) 遵循指示注册您的账号。

>(可选)在注册账号后,您可以简单设置您的个人信息,以便让开源社区的其他人了解您!
## 2. FORK此项目

在登录后,点击项目上方的“Fork”,以在您的账户下创建一个此项目的拷贝。

![fork](.doc/images/fork.png)

随后,进入您账户下的项目拷贝。

## 3. 开始编辑

此项目的源文件是基于 “[Markdown](https://markdown.com.cn/)” 格式的,这是一种轻量级标记语言,
使用起来非常的简单。您可以参考 [Markdown基本语法](https://markdown.com.cn/basic-syntax/)

与此同时,项目使用了 Jetbrains 开发的 Writerside 后端,在 Markdown 的基础上额外支持了一些功能,
具体可参考 [Writerside Documentation](https://www.jetbrains.com/help/writerside/semantic-markup-reference.html)
_(不过一般来说您用不到这些)_


现在您可以编辑项目内容了,您可以选择以下几种编辑方式。

### 3.1 在 Writerside 中编辑 (推荐)

此项目是基于 Jetbrains 开发的 Writerside 搭建的,于是使用 Writerside 软件来编辑是最好的方案。

您可以在 [Download writerside](https://www.jetbrains.com/writerside/download/#section=windows) 下载到
最新版的编辑器软件并安装,随后,您可以在设置中找到 “Plugins”选项,并搜索 “Chinese” 安装中文语言包,重启后您将拥有一个中文版的编辑器。

然后,您需要遵循 [如何在GitHub上克隆项目](https://blog.csdn.net/qq_48271007/article/details/126050656) 中描述的方法,
将您账户下的项目拷贝克隆下来,并使用Writerside打开。

随后您就可以在 Writerside中编辑此项目了。在软件的左侧,有一个“Writerside”的栏目,此栏目中可以看到对应的内容和演示,以便您进行编辑。

在完成编辑后,您只需要点击左侧“提交”栏目,输入您本次编辑的内容简介,随后点击“提交并推送”;在弹出的推送确认框中再次点击“推送”即可。

![img.png](.doc/images/writerside-commit.png)

### 3.2 在Github网页中编辑

点击网页中的目录 `Writerside/topics` ,在这个目录中存放着所有文档的源文件(包括其中子文件夹内存放的源文件)。

点开任意一个源文件,然后点击文件右上角的 “铅笔” 图标,如图所示:

![web-editor](.doc/images/web-edit.png)

随后,您可以增添内容;在修改完成后,点击右上角的 “Commit changes...”(提交更新),
并简单描述本次更新的内容,再点击 “Commit changes” 确认提交即可。

![img.png](.doc/images/commit.png)

![img.png](.doc/images/commit-message.png)

## 4. 提交合并请求

在您完成自己的贡献后,您可以点击 [Pull Request](https://github.com/PurpleMonkeyMC/Documentation/pulls) 界面中点击 “New pull request”
来新建一个合并请求。

在创建时,选择您自己修改后的项目代码,再点击 “Create pull request” ,填写更新的相关描述,即可提交。

我们将在审核后通过您的请求,您的贡献便会完整的展现在文档之中!


## 5. 致谢

万分感谢您对 PMC 和开源社区的贡献,愿您生活愉快,万事顺利!
File renamed without changes
Binary file added Writerside/images/main-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion Writerside/topics/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ___

## 2024-02-19

**支持修改工具物品顺序**
[**支持修改工具物品顺序**](lobby.md#toolkit)
: 现在可在大厅中修改工具物品的顺序,
: 其指令为 `/toolkit edit <物品包ID>`
: ![toolkit-editor.jpg](toolkit-editor.jpg){width="500"}
Expand Down
16 changes: 15 additions & 1 deletion Writerside/topics/features/creative.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# 创意工坊
![creative-list.png](creative-list.png)

游玩来自其他大神的跑酷地图作品,或利用创意工具制作您自己的跑酷地图供他人练习!

您可以在大厅中输入 `/creative` 打开创意界面。

![creative-gui.png](creative-gui.png)

## 地图列表 {id="creative-list"}

在创意界面中,上方区域为服务器内公开的创意地图列表。
其中,列表右下方的按钮可供您在“创意市场”、“我的收藏”与“官方推荐”三个类目中切换。

您还可以利用列表左下方的“搜索”、“筛选”与“排序”工具快速找到您想要游玩的地图。

## 创建地图

Expand All @@ -11,3 +23,5 @@

## 共同编辑

## 官方推荐

31 changes: 29 additions & 2 deletions Writerside/topics/features/game.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,37 @@

## 地图列表 {id="map_list"}

### 评级地图
![main-menu.png](main-menu.png){width="500"}

在大厅中,您可以输入 `/play` 打开主菜单,并选择“评级”、“练习”或“创意”查看可游玩的地图列表。

### 跑酷评级 {id="ratings"}

打开评级地图列表后,您将看到不同的评级等级与考核地图。

![rating_maps.png](rating_maps.png){width="500"}

### 练习地图
其中,评级等级自下而上分为:
1. 皮靴
2. 铁靴
3. 金靴
4. 钻石靴
5. 绿宝石靴
6. 下界合金靴
7. 神靴

共七个等级, 且每个等级间存在跨度,如 **皮靴III** 代表在皮靴内完成了三张地图。

**完成评级组内全部地图****所有地图达到“D”等次**即视为达到评级。
若日后不满足已完成的评级要求(_如地图变更或时间要求变更且不达标_),则退回对应评级。


### 跑酷练习 {id="course"}

打开练习地图列表后,您将看到所有可供您游玩的官方练习地图。


除官方练习地图之外,您还可以在[创意工坊](creative.md#creative-list)找到更多自定义内容,或利用创意工具制作您自己的跑酷地图!

## 地图信息 {id="map_info"}

Expand Down
6 changes: 4 additions & 2 deletions Writerside/topics/features/lobby.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@

在大厅出生点右侧,我们建立了一处挂机池。在挂机池中泡澡将获得金币与经验。

针对不同等级的会员,挂机收益会有所不同,详见 [会员权限/权限与功能](ranks.md)

> 挂机收益将在离开挂机池或离开服务器时一并结算到账户。{style=note}
## 召唤载具
## 召唤载具 {id="vehicle"}

## 钓鱼
## 钓鱼系统 {id="fishing"}
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
**主城** 中,找到“**炼金行老板****凯瑟琳**`-209,52,-36`,与她互动即可租赁魔法斗篷(订阅会员)。


## 周期价格
## 周期价格 {id="price"}

| 周期 | PLUS | PRO | ULTRA |
|:--:|:----:|:----:|:-----:|
Expand All @@ -18,7 +18,9 @@

> PRO -> ULTRA 兑换基础比例为 `0.25x` 。 {style=note}
## 权限与功能
## 权限与功能 {id="differences"}

此表格简单列出了不同等级会员的权限与功能差别。

| 类别 | 功能 | 普通玩家 | PLUS | PRO | ULTRA |
|:--:|:------------------------:|:----------:|:------------:|:---------:|:-----------:|
Expand Down
File renamed without changes.

0 comments on commit 8e32ce6

Please sign in to comment.