118 lines
3.9 KiB
Markdown
118 lines
3.9 KiB
Markdown
# Difficult Rocket
|
|
|
|
[中文](../README.md) | English
|
|
|
|
- [GitHub](https://github.com/shenjackyuanjie/Difficult-Rocket)
|
|
- [Gitee](https://gitee.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).
|
|
|
|
[](https://996.icu)
|
|
[](https://Semver.org/)
|
|
[](https://Python.org)
|
|
[](https://pyglet.org)
|
|
[](https://Python.org)
|
|
|
|
## Version
|
|
|
|
[About Versions](src/version.md)
|
|
|
|
[](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
|
|
[](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
|
|
[](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
|
|
|
|
[](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 -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.
|
|
|
|
- `Develop platform 1 - Windows 10 x64 22H2`
|
|
- Python `3.8.10+`
|
|
- `requirements`
|
|
- `AMD R5 5600X`
|
|
- `AMD RX 558 8G`
|
|
|
|
## Required Python Modules
|
|
|
|
> python gen_require.py [-h] {0,1,2}
|
|
> run / build / compile
|
|
|
|
- `pyglet` (pre-installed V2.0.8 path:`./libs/pyglet`)
|
|
- `xmltodict` (pre-installed V0.12.0 path:`./libs/xmltodict`)
|
|
- `pyperclip` (pre-installed V1.8.2 path: `./libs/pyperclip`)
|
|
|
|
[requirement.txt](requirement.txt)
|
|
[requirement-build.txt](requirement-build.txt)
|
|
[requirement-dev.txt](requirement-dev.txt)
|
|
|
|
## Credits
|
|
|
|
- Open Source Projects
|
|
- [pyglet](https://github.com/pyglet/pyglet): GUI and graphics
|
|
- `tomlkit` toml parser
|
|
- `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
|
|
|
|
- Main contributors
|
|
- [@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)
|