diff --git a/AppConfig.yaml b/AppConfig.yaml new file mode 100644 index 0000000..4203649 --- /dev/null +++ b/AppConfig.yaml @@ -0,0 +1,3 @@ +open_observe: + address: [address] + access_token: [token] \ No newline at end of file diff --git a/README.md b/README.md index 60c9eb4..4385c17 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,32 @@ You need to fill in the Export Presets > Resources > Filter to export non-resour data/* ``` +## Configuring Openobserve + +> This is optional, and the game will work even if you do not configure Openobserve. + +openobserve is used to continuously collect logs and alarm information after a game has been released. + +#### Set up the openobserve server + +see:[openobserve](https://github.com/openobserve/openobserve) + +#### Write configuration + +After you have set up an openobserve server, follow the following steps to configure the file: + +1. Create a configuration file named **AppConfig.yaml** in the root directory of your project. + +2. Fill in the information for the remote server. + + ```yaml + open_observe: + address: [address] + access_token: [token] + ``` + + 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. diff --git a/README_ZH.md b/README_ZH.md index 83a0c80..b37986e 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -52,6 +52,32 @@ git clone https://github.com/Cold-Mint/Traveller.git data/* ``` +## 配置Openobserve + +> 这是可选的操作,即使您不配置Openobserve,游戏也能正常运行。 + +openobserve用于在游戏发布后,持续收集日志和报警信息。 + +#### 搭建openobserve服务器 + +请见:[openobserve](https://github.com/openobserve/openobserve) + +#### 编写配置 + +在您搭建完毕openobserve的服务器后,按如下步骤配置文件: + +1. 在项目的根目录创建名为**AppConfig.yaml**的配置文件。 + +2. 填入远程服务器的信息。 + + ```yaml + open_observe: + address: [address] + access_token: [token] + ``` + + address 服务器的地址,格式为 http(s)://www.example.com。(支持http和https) + ## 参与翻译 此项目在编写之初就为本地化做好了准备。您可以编辑locals目录下的csv文件。来修改和添加新的翻译。