Update Readme.
更新Readme。
This commit is contained in:
parent
56d3ae4964
commit
e10e22e3bd
GPG Key ID:
C5A9BF8A98E0CE99
|
|
@ -1,4 +1,4 @@
|
|||
<Project Sdk="Godot.NET.Sdk/4.3.0-rc.2">
|
||||
<Project Sdk="Godot.NET.Sdk/4.3.0-rc.3">
|
||||
<PropertyGroup>
|
||||
<TargetFramework>net6.0</TargetFramework>
|
||||
<TargetFramework Condition=" '$(GodotTargetPlatform)' == 'android' ">net7.0</TargetFramework>
|
||||
|
|
|
|||
42
README.md
42
README.md
|
|
@ -10,12 +10,12 @@ A pixel cross-platform roguelite game.
|
|||
|
||||
## Recent Development progress
|
||||
|
||||
| Task | status |
|
||||
| ----------------------------------------------------------- | ------------------ |
|
||||
| Randomly generated map | complete |
|
||||
| loot | complete |
|
||||
| Support still out of the knapsack system | complete |
|
||||
| Add AI agents to creatures | In progress |
|
||||
| Task | status |
|
||||
|------------------------------------------|-------------|
|
||||
| Randomly generated map | complete |
|
||||
| loot | complete |
|
||||
| Support still out of the knapsack system | complete |
|
||||
| Add AI agents to creatures | In progress |
|
||||
|
||||
## Screenshot
|
||||
|
||||
|
|
@ -30,12 +30,20 @@ Level graph editor
|
|||
## Run the project locally
|
||||
|
||||
#### Download engine
|
||||
|
||||
1. Download [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.
|
||||
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).
|
||||
|
||||
Ubuntu or Linux Mint install the .net 8.0 Sdk.
|
||||
|
||||
```
|
||||
apt install dotnet-sdk-8.0
|
||||
```
|
||||
|
||||
#### Clone project
|
||||
|
||||
Enter the following command in your working directory:
|
||||
|
|
@ -55,7 +63,17 @@ data/*
|
|||
#### Custom feature
|
||||
|
||||
- **disableVersionIsolation** Disable version isolation.
|
||||
- **enableMod** Experimental feature, the game loads dll files and pck files in the mod directory when the mod is enabled. Due to the isolation of AssemblyLoadContext, the main game content cannot be accessed from within the Mod for the time being.
|
||||
- **enableMod** Experimental feature, the game loads dll files and pck files in the mod directory when the mod is
|
||||
enabled. Due to the isolation of AssemblyLoadContext, the main game content cannot be accessed from within the Mod for
|
||||
the time being.
|
||||
|
||||
#### Run the console on Linux
|
||||
|
||||
Enter the following command in the directory where the game is located:
|
||||
|
||||
```
|
||||
./Traveler.sh
|
||||
```
|
||||
|
||||
## Configuring Openobserve
|
||||
|
||||
|
|
@ -82,18 +100,20 @@ After you have set up an openobserve server, follow the following steps to confi
|
|||
org_id: [org_id]
|
||||
stream_name: [stream_name]
|
||||
```
|
||||
|
||||
|
||||
address Indicates the address of the server in the format of http(s)://www.example.com. (Support http and https)
|
||||
|
||||
## 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.
|
||||
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.
|
||||
|
||||
## License
|
||||
|
||||
[GPL-3.0 license](LICENSE)
|
||||
|
||||
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**.
|
||||
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**.
|
||||
|
||||
> Note: You have the right to sell the modified version, but not the original.
|
||||
>
|
||||
|
|
|
|||
15
README_JA.md
15
README_JA.md
|
|
@ -34,6 +34,13 @@
|
|||
|
||||
2. ダウンロード [.NetSDK](https://dotnet.microsoft.com/download).
|
||||
|
||||
UbuntuやLinux Mintに。net8.0Sdkをインストールします。
|
||||
|
||||
```
|
||||
apt install dotnet-sdk-8.0
|
||||
```
|
||||
|
||||
|
||||
#### クローンプロジェクトです
|
||||
|
||||
作業リストに次の指示を入力します。
|
||||
|
|
@ -55,6 +62,14 @@ data/*
|
|||
- **disableVersionIsolation** 版孤立を無効化する。
|
||||
- **enableMod**実験的な機能、modが有効になっている場合、ゲームはmodディレクトリにdllファイルとpckファイルをロードします。assemblyloadcontextが分離されているため、当面の間、mod内からメインゲームのコンテンツにアクセスすることはできません。
|
||||
|
||||
#### Linux上でコンソールを動かします
|
||||
|
||||
ゲームの存在するディレクトリに以下のコマンドを入力します:
|
||||
|
||||
```
|
||||
./Traveler.sh
|
||||
```
|
||||
|
||||
## はいちOpenobserve
|
||||
|
||||
> これはオプションなので、Openobserveを設定しなくてもゲームは正常に動作します。
|
||||
|
|
|
|||
30
README_ZH.md
30
README_ZH.md
|
|
@ -10,11 +10,11 @@
|
|||
|
||||
## 近期研发进度
|
||||
|
||||
| 任务 | 状态 |
|
||||
| ----------------------------------------------------------- |----|
|
||||
| 随机生成地图 | 完成 |
|
||||
| 战利品 | 完成 |
|
||||
| 支持仍出的背包系统 | 完成 |
|
||||
| 任务 | 状态 |
|
||||
|-----------|-----|
|
||||
| 随机生成地图 | 完成 |
|
||||
| 战利品 | 完成 |
|
||||
| 支持仍出的背包系统 | 完成 |
|
||||
| 为生物添加AI代理 | 进行中 |
|
||||
|
||||
## 屏幕截图
|
||||
|
|
@ -30,12 +30,19 @@
|
|||
## 在本地运行项目
|
||||
|
||||
#### 下载引擎
|
||||
|
||||
1. 下载[Godot Engine .Net](https://godotengine.org/)。
|
||||
|
||||
下载引擎后，您需要额外下载导出模板才能导出为可执行程序。
|
||||
|
||||
2. 下载 [.NetSDK](https://dotnet.microsoft.com/download).
|
||||
|
||||
Ubuntu或Linux Mint安装.net8.0Sdk。
|
||||
|
||||
```
|
||||
apt install dotnet-sdk-8.0
|
||||
```
|
||||
|
||||
#### 克隆项目
|
||||
|
||||
在您的工作目录输入以下指令：
|
||||
|
|
@ -57,6 +64,14 @@ data/*
|
|||
- **disableVersionIsolation** 禁用版本隔离。
|
||||
- **enableMod** 实验性功能，当启用模组时游戏会在mod目录加载dll文件和pck文件。由于AssemblyLoadContext的隔离性，暂时不能从Mod内访问主游戏内容。
|
||||
|
||||
#### 在Linux上运行控制台
|
||||
|
||||
在游戏所在目录输入以下命令：
|
||||
|
||||
```
|
||||
./Traveler.sh
|
||||
```
|
||||
|
||||
## 配置Openobserve
|
||||
|
||||
> 这是可选的操作，即使您不配置Openobserve，游戏也能正常运行。
|
||||
|
|
@ -82,7 +97,7 @@ openobserve用于在游戏发布后，持续收集日志和报警信息。
|
|||
org_id: [org_id]
|
||||
stream_name: [stream_name]
|
||||
```
|
||||
|
||||
|
||||
address 服务器的地址，格式为 http(s)://www.example.com。（支持http和https）
|
||||
|
||||
## 参与翻译
|
||||
|
|
@ -95,7 +110,8 @@ openobserve用于在游戏发布后，持续收集日志和报警信息。
|
|||
|
||||
查看协议的中文翻译版本：[GPL-3.0 license 简体中文](LICENSE_ZH)
|
||||
|
||||
支持商用，任何人可修改，构建，并用于售卖或免费发布。对于此项目的所有衍生版本，根据GPL协议，您应当**保留作者版权**，以及**公开修改后的源代码**。
|
||||
支持商用，任何人可修改，构建，并用于售卖或免费发布。对于此项目的所有衍生版本，根据GPL协议，您应当**保留作者版权**，以及*
|
||||
*公开修改后的源代码**。
|
||||
|
||||
> 注意：您有权售卖修改后的版本，但不能售卖原版。
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user