DR_Team/DR-docs
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

同步了项目内的readme

Browse Source 
顺便迁移了一下
This commit is contained in:
shenjack 2023-12-31 15:46:16 +08:00
parent 3f3eca444d
commit 640f0dfe88
Signed by: shenjack
GPG Key ID: 7B1134A979775551
2 changed files with 67 additions and 222 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

147
docs/main/readme-en.md
View File

@ -1,15 +1,13 @@
# Difficult Rocket # Difficult Rocket
[中文](/main/readme.md) | English [中文](../README.md) | English
- [GitHub](https://github.com/shenjackyuanjie/Difficult-Rocket) - [GitHub](https://github.com/shenjackyuanjie/Difficult-Rocket)
- [gitee](https://gitee.com/shenjackyuanjie/Difficult-Rocket) - [Gitee](https://gitee.com/shenjackyuanjie/Difficult-Rocket)
- [discord](https://discord.gg/kWzw2JrG6M) - [Discord](https://discord.gg/kWzw2JrG6M)
- [kook](https://kook.top/sRPjFG) - [Kook](https://kook.top/sRPjFG)
## Notice: This repo will only publish `DR SDK` updates, `DR game` updates will be published [here](https://github.com/shenjackyuanjie/DR-game) >Note: This repo will only publish `DR SDK` updates, `DR game` updates will be published [here](https://github.com/shenjackyuanjie/DR-game).
![demo](/demo.png)
[![996.icu](https://img.shields.io/badge/996.icu-996.icu-red.svg)](https://996.icu) [![996.icu](https://img.shields.io/badge/996.icu-996.icu-red.svg)](https://996.icu)
[![semver](https://img.shields.io/badge/SemVer-2.0.0-blue.svg)](https://Semver.org/) [![semver](https://img.shields.io/badge/SemVer-2.0.0-blue.svg)](https://Semver.org/)
@ -19,7 +17,7 @@
## Version ## Version
[About Versions](./version.md) [About Versions](src/version.md)
[![release version](https://img.shields.io/badge/Release-0.8.7.2-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases) [![release version](https://img.shields.io/badge/Release-0.8.7.2-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
[![pre version](https://img.shields.io/badge/Pre_Release-0.8.7.2-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases) [![pre version](https://img.shields.io/badge/Pre_Release-0.8.7.2-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
@ -31,23 +29,19 @@
[DR rs latest Action build](https://nightly.link/shenjackyuanjie/Difficult-Rocket/workflows/dr_rs/main) [DR rs latest Action build](https://nightly.link/shenjackyuanjie/Difficult-Rocket/workflows/dr_rs/main)
## 中文README请移步 [这里](../README.md) ## Introduction
> Difficult-rocket is a Simple Rocket liked game build with Python (in short: rocket simulator) Difficult-rocket is a Simple Rocket liked game build with Python (shorten as "rocket simulator"). It is lighter than Vanilla SR.
## Advantage [Plan feature list](src/plan_features/README.md)
> Lighter than Vanilla SR
## [Plan feature list](/main/plan_features/README.md)
[YouTrack](https://difficult-rocket.youtrack.cloud/projects/8dafd498-59c0-4ce7-9900-d9292e9ed1f0) [YouTrack](https://difficult-rocket.youtrack.cloud/projects/8dafd498-59c0-4ce7-9900-d9292e9ed1f0)
## [Update logs](/main/change_log) [Update logs](src/change_log/readme.md)
## How To Run ## Run
### clone ### 1. Clone
```bash title="clone.sh" ```bash title="clone.sh"
mkdir DR mkdir DR
@ -59,87 +53,47 @@ git clone https://gitee.com/shenjackyuanjie/Difficult-Rocket.git
git clone git@github.com:shenjackyuanjie/Difficult-Rocket.git git clone git@github.com:shenjackyuanjie/Difficult-Rocket.git
``` ```
### Install requirements ### 2. Install requirements
```bash title="install.sh" ```bash title="install.sh"
python gen_require.py 0
python -m pip install -r requirements.txt python -m pip install -r requirements.txt
git submodule update --init --recursive git submodule update --init --recursive
cd libs cd libs
cd lib_not_dr python -m pip install ./lib_not_dr
python -m pip install . python -m pip install ./pyglet
``` ```
### Run ### 3. Run
```bash title="run.sh" ```bash title="run.sh"
python DR.py python DR.py
``` ```
## Environment (been tested / developed on) ## Environment
>The developing environment used Python `3.8.10`, but `3.8+` is also available.
- `Develop platform 1 - Windows 10 x64 22H2` - `Develop platform 1 - Windows 10 x64 22H2`
- Python `3.8.10` / `3.10.11` - Python `3.8.10+`
- pillow `10.0.0` - `requirements`
- psutil `5.9.5`
- rtoml `0.9.0`
- tomlkit `0.12.1`
- defusedxml `0.7.1`
- objprint `0.2.2`
- viztracer `0.15.6`
- vizplugins `0.1.3`
- nuitka `1.7.10`
- ordered-set `4.1.0`
- imageio `2.31.2`
- wheel `0.41.2`
- setuptools `68.1.2`
- setuptools-rust `1.7.0`
- `AMD R5 5600X` - `AMD R5 5600X`
- `AMD RX 550 4G` - `AMD RX 558 8G`
## Required python modules ## Required Python Modules
- `pyglet` (pre-installed V2.0.8 path:`./libs/pyglet`) > python gen_require.py [-h] {0,1,2}
> run / build / compile
- `pyglet` (pre-installed V2.x path:`./libs/pyglet`)
- `xmltodict` (pre-installed V0.12.0 path:`./libs/xmltodict`) - `xmltodict` (pre-installed V0.12.0 path:`./libs/xmltodict`)
- `pyperclip` (pre-installed V1.8.2 path: `./libs/pyperclip`) - `pyperclip` (pre-installed V1.8.2 path: `./libs/pyperclip`)
```text ## Credits
# this requirement is for
# DR basic running from source
# DR build (by nuitka)
# DR contributing
# for images
# not for pypy >= 3.10
pillow >= 10.0.0; (platform_python_implementation == "PyPy" and python_version < "3.10") or platform_python_implementation == "CPython"
# for sys info
psutil >= 5.9.5
# for files
rtoml >= 0.9.0
tomlkit >= 0.11.8
defusedxml >= 0.7.1
# for debug
objprint >= 0.2.2
viztracer >= 0.15.6; platform_python_implementation != "PyPy"
vizplugins >= 0.1.3; platform_python_implementation != "PyPy"
# for compile
nuitka >= 1.7.5
ordered-set >= 4.1.0
imageio >= 2.31.0; (platform_python_implementation == "PyPy" and python_version < "3.10") or platform_python_implementation == "CPython"
wheel >= 0.40.0
setuptools >= 67.8.0
setuptools-rust >= 1.6.0
```
## thanks to
- Open Source Projects - Open Source Projects
- [pyglet](https://github.com/pyglet/pyglet): GUI and graphics - [pyglet](https://github.com/pyglet/pyglet): GUI and graphics
- `tomlkit` / `rtoml` toml parser - `tomlkit` toml parser
- `xmltodict`: translate data between xml and dict - `xmltodict`: translate data between xml and dict
- `pyperclip`: paste board! - `pyperclip`: paste board!
- [rapier2d](https://rapier.rs/) : Phy simulate engine - [rapier2d](https://rapier.rs/) : Phy simulate engine
@ -151,43 +105,10 @@ setuptools-rust >= 1.6.0
- [@Billchyi](https://github.com/Billchyi) : Check mistake in docs - [@Billchyi](https://github.com/Billchyi) : Check mistake in docs
- [@MSDNicrosoft](https://github.com/MSDNicrosoft) : Optimize code - [@MSDNicrosoft](https://github.com/MSDNicrosoft) : Optimize code
## Other links ## Other Links
## About License [Offical Document](https://dr.shenjack.top)
#### https://creativecommons.org/licenses/by-nc-sa/4.0/ ## License
#### Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) [MPL-2.0](LICENSE)
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
You are free to:
Share — copy and redistribute the material in any medium or format
Adapt — remix, transform, and build upon the material
The licensor cannot revoke these freedoms as long as you follow the license terms.
Under the following terms:
Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You
may do so in any reasonable manner, but not in any way
that suggests the licensor endorses you or your use.
NonCommercial — You may not use the material for commercial purposes.
ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same
license as the original.
No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from
doing anything the license permits.
Notices:
You do not have to comply with the license for elements of the material in the public domain or where your use is
permitted by an applicable exception or limitation.
No warranties are given. The license may not give you all the permissions necessary for your intended use. For example,
other rights such as publicity, privacy, or moral rights may limit how you use the material.

142
docs/main/readme.md
View File

@ -1,17 +1,13 @@
<div style="text-align: center;">
# Difficult Rocket # Difficult Rocket
中文 | [English](/main/readme-en.md) 中文 | [English](./docs/README-en.md)
- [GitHub](https://github.com/shenjackyuanjie/Difficult-Rocket) - [GitHub](https://github.com/shenjackyuanjie/Difficult-Rocket)
- [gitee](https://gitee.com/shenjackyuanjie/Difficult-Rocket) - [Gitee](https://gitee.com/shenjackyuanjie/Difficult-Rocket)
- [discord](https://discord.gg/kWzw2JrG6M) - [Discord](https://discord.gg/kWzw2JrG6M)
- [kook](https://kook.top/sRPjFG) - [Kook](https://kook.top/sRPjFG)
## 请注意 这个仓库未来只会发布 `DR SDK` 的更新 `DR game` 的更新会在 [这里](https://github.com/shenjackyuanjie/DR-game) 发布 >注意：本仓库未来只会发布`DR SDK`的更新。`DR game`的更新会在[这里](https://github.com/shenjackyuanjie/DR-game)发布。
![demo](/demo.png)
[![996.icu](https://img.shields.io/badge/996.icu-996.icu-red.svg)](https://996.icu) [![996.icu](https://img.shields.io/badge/996.icu-996.icu-red.svg)](https://996.icu)
[![semver](https://img.shields.io/badge/SemVer-2.0.0-blue.svg)](https://Semver.org/) [![semver](https://img.shields.io/badge/SemVer-2.0.0-blue.svg)](https://Semver.org/)
@ -21,7 +17,7 @@
## 版本 ## 版本
[关于版本号的说明](/main/version.md) [关于版本号的说明](./docs/src/version.md)
[![release version](https://img.shields.io/badge/Release-0.8.7.2-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases) [![release version](https://img.shields.io/badge/Release-0.8.7.2-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
[![pre version](https://img.shields.io/badge/Pre_Release-0.8.7.2-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases) [![pre version](https://img.shields.io/badge/Pre_Release-0.8.7.2-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
@ -33,23 +29,19 @@
[DR rs 最新 Action 构建](https://nightly.link/shenjackyuanjie/Difficult-Rocket/workflows/dr_rs/main) [DR rs 最新 Action 构建](https://nightly.link/shenjackyuanjie/Difficult-Rocket/workflows/dr_rs/main)
## English README please look [here](/main/readme-en.md) ## 介绍
> 这是一个用Python制作的类Simple Rocket游戏(简称：火箭模拟器) 这是一个用Python制作的类Simple Rocket游戏（简称：火箭模拟器）。相对于原版SR，它更加轻量。
## 优势 [计划特性列表](docs/src/plan_features/README.md)
> 相对于原版SR比较“轻量化”
## [计划特性列表](/main/plan_features/README.md)
[YouTrack](https://difficult-rocket.youtrack.cloud/projects/8dafd498-59c0-4ce7-9900-d9292e9ed1f0) [YouTrack](https://difficult-rocket.youtrack.cloud/projects/8dafd498-59c0-4ce7-9900-d9292e9ed1f0)
## [更新日志](/main/change_log) [更新日志](docs/src/change_log/readme.md)
## 运行方式 ## 运行
### clone ### 1. Clone
```bash title="clone.sh" ```bash title="clone.sh"
mkdir DR mkdir DR
@ -61,87 +53,47 @@ git clone https://gitee.com/shenjackyuanjie/Difficult-Rocket.git
git clone git@github.com:shenjackyuanjie/Difficult-Rocket.git git clone git@github.com:shenjackyuanjie/Difficult-Rocket.git
``` ```
### 安装依赖 ### 2. 安装依赖
```bash title="install.sh" ```bash title="install.sh"
python gen_require.py 0
python -m pip install -r requirements.txt python -m pip install -r requirements.txt
git submodule update --init --recursive git submodule update --init --recursive
cd libs cd libs
cd lib_not_dr python -m pip install ./lib_not_dr
python -m pip install . python -m pip install ./pyglet
``` ```
### 运行 ### 3. 运行
```bash title="run.sh" ```bash title="run.sh"
python DR.py python DR.py
``` ```
## 环境需求 (测试过的 / 开发平台) ## 环境需求
>开发环境使用的Python版本为`3.8.18`，但`3.8+`同样可用。
- `开发平台 1 - Windows 10 x64 22H2` - `开发平台 1 - Windows 10 x64 22H2`
- Python `3.8.10` / `3.10.11` - Python `3.8.10+`
- pillow `10.0.0` - `requirements`
- psutil `5.9.5`
- rtoml `0.9.0`
- tomlkit `0.12.1`
- defusedxml `0.7.1`
- objprint `0.2.2`
- viztracer `0.15.6`
- vizplugins `0.1.3`
- nuitka `1.7.10`
- ordered-set `4.1.0`
- imageio `2.31.2`
- wheel `0.41.2`
- setuptools `68.1.2`
- setuptools-rust `1.7.0`
- `AMD R5 5600X` - `AMD R5 5600X`
- `AMD RX 550 4G` - `AMD RX 580 8G`
## 需要的 Python 模块 ## 需要的Python模块
- `pyglet` (已经内置 V2.0.8 路径：`./libs/pyglet`) > python gen_require.py [-h] {0,1,2}
> run / build / compile
- `pyglet` (已经内置 V2.x 路径：`./libs/pyglet`)
- `xmltodict` (已经内置 V0.12.0 路径:`./libs/xmltodict`) - `xmltodict` (已经内置 V0.12.0 路径:`./libs/xmltodict`)
- `pyperclip` (已经内置 V1.8.2 路径: `./libs/pyperclip`) - `pyperclip` (已经内置 V1.8.2 路径: `./libs/pyperclip`)
```text ## 鸣谢
# this requirement is for
# DR basic running from source
# DR build (by nuitka)
# DR contributing
# for images
# not for pypy >= 3.10
pillow >= 10.0.0; (platform_python_implementation == "PyPy" and python_version < "3.10") or platform_python_implementation == "CPython"
# for sys info
psutil >= 5.9.5
# for files
rtoml >= 0.9.0
tomlkit >= 0.11.8
defusedxml >= 0.7.1
# for debug
objprint >= 0.2.2
viztracer >= 0.15.6; platform_python_implementation != "PyPy"
vizplugins >= 0.1.3; platform_python_implementation != "PyPy"
# for compile
nuitka >= 1.7.5
ordered-set >= 4.1.0
imageio >= 2.31.0; (platform_python_implementation == "PyPy" and python_version < "3.10") or platform_python_implementation == "CPython"
wheel >= 0.40.0
setuptools >= 67.8.0
setuptools-rust >= 1.6.0
```
## 感谢
- 开源项目 - 开源项目
- [pyglet](https://github.com/pyglet/pyglet) : GUI 和画面渲染 - [pyglet](https://github.com/pyglet/pyglet) : GUI 和画面渲染
- `tomlkit` / `rtoml` : toml 解析器 - `tomlkit` : toml 解析器
- `xmltodict`: xml 与 dict 转换器 - `xmltodict`: xml 与 dict 转换器
- `pyperclip`: 剪贴板! - `pyperclip`: 剪贴板!
- [rapier2d](https://rapier.rs/) : 物理模拟引擎 - [rapier2d](https://rapier.rs/) : 物理模拟引擎
@ -153,38 +105,10 @@ setuptools-rust >= 1.6.0
- [@Billchyi](https://github.com/Billchyi) : 文档矫正 - [@Billchyi](https://github.com/Billchyi) : 文档矫正
- [@MSDNicrosoft](https://github.com/MSDNicrosoft) : 优化代码 - [@MSDNicrosoft](https://github.com/MSDNicrosoft) : 优化代码
</div>
## 相关链接 ## 相关链接
## 关于分享协议 [官方文档](https://dr.shenjack.top)
#### https://creativecommons.org/licenses/by-nc-sa/4.0/ ## 许可
#### 署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0) [MPL-2.0](LICENSE)
这是一份普通人可以理解的许可协议概要 (但不是替代) 。 免责声明.
您可以自由地：
共享 — 在任何媒介以任何形式复制、发行本作品
演绎 — 修改、转换或以本作品为基础进行创作
只要你遵守许可协议条款，许可人就无法收回你的这些权利。
惟须遵守下列条件：
署名 — 您必须给出地当的署名，提供指向本许可协议的链接，同时标明是否（对原始作品）作了修改。您可以用任何合理的方式来署名，但是不得以任何方式暗示许可人为您或您的使用背书。
非商业性使用 — 您不得将本作品用于商业目的。
相同方式共享 — 如果您再混合、转换或者基于本作品进行创作，您必须基于与原先许可协议地同的许可协议 分发您贡献的作品。
没有附加限制 — 您不得适用法律术语或者 技术措施 从而限制其他人做许可协议允许的事情。
声明：
您不必因为公共领域的作品要素而遵守许可协议，或者您的使用被可适用的 例外或限制所允许。
不提供担保。许可协议可能不会给与您意图使用的所必须的所有许可。例如，其他权利比如形象权、隐私权或人格权可能限制您如何使用作品。