Update readme.

更新readme。
This commit is contained in:
Cold-Mint 2024-05-19 09:44:02 +08:00
parent f07b073dc6
commit ed91d5a03b
Signed by: Cold-Mint
GPG Key ID: C5A9BF8A98E0CE99
4 changed files with 114 additions and 33 deletions

View File

@ -1,68 +1,49 @@
## Intro 简介
English [简体中文](README_ZH.md) [にほんご](README_JP.md)
## Intro
Mint's new game.
薄荷的新作游戏。
A pixel cross-platform Roguelite game.
一款像素的跨平台的Roguelite游戏。
## Recent Development progress
## Recent Development progress 近期研发进度
| Task 任务 | status 状态 |
| Task | status |
| ----------------------------------------------------------- | ------------------ |
| Randomly generated map 随机生成地图 | In progress 进行中 |
| loot 战利品 | await 等待 |
| Support still out of the knapsack system 支持仍出的背包系统 | await 等待 |
| Randomly generated map | In progress |
| loot | await |
| Support still out of the knapsack system | await |
## Run the project locally 在本地运行项目
## Run the project locally
#### Download engine 下载引擎
#### Download engine
1. Download [Godot Engine .Net](https://godotengine.org/).
下载[Godot Engine .Net](https://godotengine.org/)。
After downloading the engine, you will need to download an additional export template to export as an executable program.
下载引擎后,您需要额外下载导出模板才能导出为可执行程序。
2. Download [.NetSDK](https://dotnet.microsoft.com/download).
下载 [.NetSDK](https://dotnet.microsoft.com/download).
#### Clone project 克隆项目
#### Clone project
Enter the following command in your working directory:
在您的工作目录输入以下指令:
```
git clone https://github.com/Cold-Mint/Traveller.git
```
## Participate in translation 参与翻译
## Participate in translation
The project is prepared for localization at the beginning of writing. You can edit the csv file in the locals directory. To modify and add new translations.
此项目在编写之初就为本地化做好了准备。您可以编辑locals目录下的csv文件。来修改和添加新的翻译。
## License 许可证
## License
[GPL-3.0 license](LICENSE)
Chinese translation version[GPL-3.0 license 简体中文](LICENSE_ZH)
查看协议的中文翻译版本:[GPL-3.0 license 简体中文](LICENSE_ZH)
Support commercial, anyone can modify, build, and sell or distribute for free. For all derivative versions of this project, under the GPL, you shall **retain the author copyright** and **publish the modified source code**.
支持商用任何人可修改构建并用于售卖或免费发布。对于此项目的所有衍生版本根据GPL协议您应当**保留作者版权**,以及**公开修改后的源代码**。
> Note: You have the right to sell the modified version, but not the original.
>
> 注意:您有权售卖修改后的版本,但不能售卖原版。
## Star History 点赞历史
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=Cold-Mint/Traveller&type=Date)](https://star-history.com/#Cold-Mint/Traveller&Date)

50
README_JP.md Normal file
View File

@ -0,0 +1,50 @@
[English](README.md) [简体中文](README_ZH) にほんご
## こくじ
ミントの新作ゲームです。
マルチピクセルのRogueliteゲームです
## 最近の研究開発の進捗状況です
| ミッション | じょうたい |
| ----------------------------------------------------------- | ------------------ |
| マップをランダムに生成します | 進行中です |
| 戦利品 | すたんばい |
| バックパックのシステムをサポートしています | すたんばい |
## 地元でプロジェクトを進めています
#### ダウンロードエンジンです
1. ダウンロード[Godot Engine .Net](https://godotengine.org/)。
エンジンをダウンロードした後、エクスポートテンプレートを追加でダウンロードして実行可能なプログラムにする必要があります。
2. ダウンロード [.NetSDK](https://dotnet.microsoft.com/download).
#### クローンプロジェクトです
作業リストに次の指示を入力します。
```
git clone https://github.com/Cold-Mint/Traveller.git
```
## 翻訳に携わります
このプロジェクトは、当初からローカライズの準備ができていました。localsディレクトリのcsvファイルを編集することができます。新しい翻訳を加えたり修正したりしています
## 許可証です
[GPL-3.0 license](LICENSE)
プロトコルの日本語訳を見ます:[GPL-3.0 license にほんご](LICENSE_JP)
商用に対応しており、誰でも修正、構築、販売、無料配布が可能です。このプロジェクトのすべての派生バージョンについて、GPLプロトコルに基づいて、あなたは**作者の著作権**を保持し、**ソースコードの修正を公開します**。
> 注意:修正版を販売する権利はありますが、オリジナル版は販売できません。
## 歴史にいいですね
[![Star History Chart](https://api.star-history.com/svg?repos=Cold-Mint/Traveller&type=Date)](https://star-history.com/#Cold-Mint/Traveller&Date)

50
README_ZH.md Normal file
View File

@ -0,0 +1,50 @@
[English](README.md) 简体中文 [にほんご](README_JP.md)
## 简介
薄荷的新作游戏。
一款像素的跨平台的Roguelite游戏。
## 近期研发进度
| 任务 | 状态 |
| ----------------------------------------------------------- | ------------------ |
| 随机生成地图 | 进行中 |
| 战利品 | 等待 |
| 支持仍出的背包系统 | 等待 |
## 在本地运行项目
#### 下载引擎
1. 下载[Godot Engine .Net](https://godotengine.org/)。
下载引擎后,您需要额外下载导出模板才能导出为可执行程序。
2. 下载 [.NetSDK](https://dotnet.microsoft.com/download).
#### 克隆项目
在您的工作目录输入以下指令:
```
git clone https://github.com/Cold-Mint/Traveller.git
```
## 参与翻译
此项目在编写之初就为本地化做好了准备。您可以编辑locals目录下的csv文件。来修改和添加新的翻译。
## 许可证
[GPL-3.0 license](LICENSE)
查看协议的中文翻译版本:[GPL-3.0 license 简体中文](LICENSE_ZH)
支持商用任何人可修改构建并用于售卖或免费发布。对于此项目的所有衍生版本根据GPL协议您应当**保留作者版权**,以及**公开修改后的源代码**。
> 注意:您有权售卖修改后的版本,但不能售卖原版。
## 点赞历史
[![Star History Chart](https://api.star-history.com/svg?repos=Cold-Mint/Traveller&type=Date)](https://star-history.com/#Cold-Mint/Traveller&Date)