DR_Team/Difficult-Rocket
DR_Team/Difficult-Rocket
6
2
Fork 0
Code Issues Pull Requests Projects Releases 25 Wiki Activity

add sync readme

Browse Source
This commit is contained in:
shenjack 2024-06-13 22:11:42 +08:00
parent 0d43ea53bb
commit 8141723138
Signed by: shenjack
GPG Key ID: 7B1134A979775551
2 changed files with 271 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

138
README-en.md Normal file
View File

@ -0,0 +1,138 @@
# Difficult Rocket
Readme 请查看 [dr.shenjack.top](https://dr.shenjack.top/main/readme)
Readme please check out [dr.shenjack.top](https://dr.shenjack.top/main/readme-en)
## 下面是一个 老的, 未同步的 readme
## below is an old, unsynchronized readme
# Difficult Rocket
[中文](./README.md) | English
- [GitHub](https://github.com/shenjackyuanjie/Difficult-Rocket)
- [Gitee](https://gitee.com/shenjackyuanjie/Difficult-Rocket)
- [AtomGit](https://atomgit.com/shenjackyuanjie/Difficult-Rocket)
- [Discord](https://discord.gg/kWzw2JrG6M)
- [Kook](https://kook.top/sRPjFG)
> Note: This repo will only publish `DR SDK` updates, `DR game` updates will be published [here](https://github.com/shenjackyuanjie/DR-game).
[![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/)
[![python-3.8.10](https://img.shields.io/badge/编写于_Python_版本-3.8.10-blue.svg)](https://Python.org)
[![pyglet-2.x](https://img.shields.io/badge/编写于_Pyglet_版本-2.x-blue.svg)](https://pyglet.org)
[![support python 3.8~12](https://img.shields.io/badge/Python-_3.8_~_3.12_-blue.svg)](https://Python.org)
## Version
[About Versions](src/version.md)
[![release version](https://img.shields.io/badge/Release-0.9.1.0-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
[![pre version](https://img.shields.io/badge/Pre_Release-0.9.1.0-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
[![devlo version](https://img.shields.io/badge/Devloping-0.9.2-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
[![language badge](https://stats.deeptrain.net/repo/shenjackyuanjie/Difficult-Rocket?theme=dark)](https://stats.deeptrain.net/repo/shenjackyuanjie/Difficult-Rocket?theme=dark)
[DR sdk latest Action build](https://nightly.link/shenjackyuanjie/Difficult-Rocket/workflows/nuitka/main)
[DR rs latest Action build](https://nightly.link/shenjackyuanjie/Difficult-Rocket/workflows/dr_rs/main)
## Introduction
Difficult-rocket is a Simple Rocket liked game build with Python (shorten as "rocket simulator"). It is lighter than Vanilla SR.
[Plan feature list](src/plan_features/README.md)
[YouTrack](https://difficult-rocket.youtrack.cloud/projects/8dafd498-59c0-4ce7-9900-d9292e9ed1f0)
[Update logs](src/change_log/readme.md)
## Run
### 1. Clone
```bash title="clone.sh"
mkdir DR
cd DR
git clone https://github.com/shenjackyuanjie/Difficult-Rocket.git
# or
git clone https://gitee.com/shenjackyuanjie/Difficult-Rocket.git
# or
git clone git@github.com:shenjackyuanjie/Difficult-Rocket.git
```
### 2. Install requirements
```bash title="install.sh"
python gen_require.py 0
python -m pip install -r requirements.txt
git submodule update --init --recursive
cd libs
python -m pip install ./lib_not_dr
python -m pip install ./pyglet
```
### 3. Run
```bash title="run.sh"
python DR.py
```
## Environment
> The developing environment used Python `3.8.10`, but `3.8+` is also available.
>
> After `3.8` EOL, `3.11` will be used as the developing environment.
>
> We use 3.8 for now because it's the last version officially support Windows 7.
- `Develop platform 1 - Windows 10 x64 22H2`
- Python `3.8.18+`
- `Python 3.8.18+ (heads/3.8:7f59c4c1d4, Aug 26 2023, 00:20:02) [MSC v.1900 64 bit (AMD64)] on win32`
- `AMD R5 5800X`
- `AMD RX 558 8G`
## Required Python Modules
> 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`)
- `pyperclip` (pre-installed V1.8.2 path: `./libs/pyperclip`)
## Credits
- Open Source Projects
- [pyglet](https://github.com/pyglet/pyglet): GUI and graphics
- tomls
- `tomlkit`
- `tomli`
- `rtoml`
- `xmltodict`: translate data between xml and dict
- `pyperclip`: paste board!
- [rapier2d](https://rapier.rs/) : Phy simulate engine
- [pyo3](https://pyo3.rs/main) : Rust Python Binding
- Jundroo
- Thanks you for writing SR this ~~magical~~ fun game
- Main contributors
- [@shenjackyuanjie](https://github.com/shenjackyuanjie) : Main developer
- [@sssssssboom](https://github.com/ssssssssboom) : DR game developer
- [@InfyniteHeap](https://github.com/InfyniteHeap) : DR rs developer
- [@Rayawa](https://github.com/Rayawa) : Check mistake in docs & some translates
- [@rouxiao-you](https://github.com/ruoxiao-you) : Translate chinese to English
- [@Billchyi](https://github.com/Billchyi) : Check mistake in docs
- [@MSDNicrosoft](https://github.com/MSDNicrosoft) : Optimize code
## Other Links
[Offical Document](https://dr.shenjack.top)
## License
[MPL-2.0](LICENSE)

133
README.md
View File

@ -3,3 +3,136 @@
Readme 请查看 [dr.shenjack.top](https://dr.shenjack.top/main/readme) Readme 请查看 [dr.shenjack.top](https://dr.shenjack.top/main/readme)
Readme please check out [dr.shenjack.top](https://dr.shenjack.top/main/readme-en) Readme please check out [dr.shenjack.top](https://dr.shenjack.top/main/readme-en)
## below is an old, unsynchronized readme
## 下面是一个 老的, 未同步的 readme
# Difficult Rocket
中文 | [English](./README-en.md)
- [GitHub](https://github.com/shenjackyuanjie/Difficult-Rocket)
- [Gitee](https://gitee.com/shenjackyuanjie/Difficult-Rocket)
- [AtomGit](https://atomgit.com/shenjackyuanjie/Difficult-Rocket)
- [Discord](https://discord.gg/kWzw2JrG6M)
- [Kook](https://kook.top/sRPjFG)
> 注意：本仓库未来只会发布`DR SDK`的更新。`DR game` 的更新会在[这里](https://github.com/shenjackyuanjie/DR-game)发布。
[![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/)
[![python-3.8.10](https://img.shields.io/badge/编写于_Python_版本-3.8.10-blue.svg)](https://Python.org)
[![pyglet-2.x](https://img.shields.io/badge/编写于_Pyglet_版本-2.x-blue.svg)](https://pyglet.org)
[![support python 3.8~12](https://img.shields.io/badge/Python-_3.8_~_3.12_-blue.svg)](https://Python.org)
## 版本
[关于版本号的说明](./docs/src/version.md)
[![release version](https://img.shields.io/badge/Release-0.9.1.0-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
[![pre version](https://img.shields.io/badge/Pre_Release-0.9.1.0-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
[![devlo version](https://img.shields.io/badge/Devloping-0.9.2-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
[![language badge](https://stats.deeptrain.net/repo/shenjackyuanjie/Difficult-Rocket?theme=dark)](https://stats.deeptrain.net/repo/shenjackyuanjie/Difficult-Rocket?theme=dark)
[DR sdk 最新 Action 构建](https://nightly.link/shenjackyuanjie/Difficult-Rocket/workflows/nuitka/main)
[DR rs 最新 Action 构建](https://nightly.link/shenjackyuanjie/Difficult-Rocket/workflows/dr_rs/main)
## 介绍
这是一个用Python制作的类Simple Rocket游戏（简称：火箭模拟器）。相对于原版SR，它更加轻量。
[计划特性列表](docs/src/plan_features/README.md)
[YouTrack](https://difficult-rocket.youtrack.cloud/projects/8dafd498-59c0-4ce7-9900-d9292e9ed1f0)
[更新日志](docs/src/change_log/readme.md)
## 运行
### 1. Clone
```bash title="clone.sh"
mkdir DR
cd DR
git clone https://github.com/shenjackyuanjie/Difficult-Rocket.git
# 或者
git clone https://gitee.com/shenjackyuanjie/Difficult-Rocket.git
# 又或者
git clone git@github.com:shenjackyuanjie/Difficult-Rocket.git
```
### 2. 安装依赖
```bash title="install.sh"
python gen_require.py 0
python -m pip install -r requirements.txt
git submodule update --init --recursive
cd libs
python -m pip install ./lib_not_dr
python -m pip install ./pyglet
```
### 3. 运行
```bash title="run.sh"
python DR.py
```
## 环境需求
> 开发环境使用的Python版本为`3.8.18`，但`3.8+`同样可用。
>
> 在 `3.8` EOL 之后会使用 `3.11` 作为开发环境。
>
> 毕竟现在使用 3.8 开发是因为他官方支持 Windows 7, 而 3.9+ 不支持。
- `开发平台 1 - Windows 10 x64 22H2`
- Python `3.8.18+`
- `Python 3.8.18+ (heads/3.8:7f59c4c1d4, Aug 26 2023, 00:20:02) [MSC v.1900 64 bit (AMD64)] on win32`
- `AMD R5 5800X`
- `AMD RX 580 8G`
## 需要的Python模块
> python gen_require.py [-h] {0,1,2}
> run / build / compile
- `pyglet` (已经内置 V2.x 路径：`./libs/pyglet`)
- `xmltodict` (已经内置 V0.12.0 路径:`./libs/xmltodict`)
- `pyperclip` (已经内置 V1.8.2 路径: `./libs/pyperclip`)
## 鸣谢
- 开源项目
- [pyglet](https://github.com/pyglet/pyglet) : GUI 和画面渲染
- tomls
- `tomlkit`
- `tomli`
- `rtoml`
- `xmltodict`: xml 与 dict 转换器
- `pyperclip`: 剪贴板!
- [rapier2d](https://rapier.rs/) : 物理模拟引擎
- [pyo3](https://pyo3.rs/main): Rust Python 扩展
- Jundroo
- 感谢为我们编写了 SR 这么一个 ~~魔法~~ 好玩的游戏
- 主要贡献者
- [@shenjackyuanjie](https://github.com/shenjackyuanjie) : 主开发
- [@sssssssboom](https://github.com/ssssssssboom) : DR game 开发
- [@InfyniteHeap](https://github.com/InfyniteHeap) : DR rs 开发
- [@Rayawa](https://github.com/Rayawa) : 文档矫正 & 翻译部分 lang
- [@rouxiao-you](https://github.com/ruoxiao-you) : 翻译 lang
- [@Billchyi](https://github.com/Billchyi) : 文档矫正
- [@MSDNicrosoft](https://github.com/MSDNicrosoft) : 优化代码
## 相关链接
[官方文档](https://dr.shenjack.top)
## 许可
[MPL-2.0](LICENSE)