Difficult-Rocket/README.md

# Difficult Rocket

[中文](./docs/README-cn.md) | English

[comment]: <> (中文 | [English]&#40;https://github.com/shenjackyuanjie/Difficult-Rocket&#41;.)

- [GitHub](https://github.com/shenjackyuanjie/Difficult-Rocket)
- [Gitee](https://gitee.com/shenjackyuanjie/Difficult-Rocket)

[![Generic badge](https://img.shields.io/badge/SemVer-2.0.0-blue.svg)](https://Semver.org/)
[![Generic badge](https://img.shields.io/badge/Write_with_Python-3.8.10-blue.svg)](https://Python.org)
[![Generic badge](https://img.shields.io/badge/Write_with_Pyglet-2.0dev13-blue.svg)](https://pyglet.org)
[![Generic badge](https://img.shields.io/badge/Python-_3.8_|_3.9_|_3.10_-blue.svg)](https://Python.org)

## Version

[![Generic badge](https://img.shields.io/badge/Release-0.6.1-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
<br/>[![Generic badge](https://img.shields.io/badge/Pre_Release-0.6.1-blue.svg)](https://github.com/shenjackyuanjie/Difficult-Rocket/releases)
<br/>![Generic badge](https://img.shields.io/badge/Devloping-0.6.2-blue.svg)

## 中文README请移步 [这里](/docs/README-cn.md)

> Difficult-rocket is a Simple Rocket liked game build with Python (in short: rocket simulator)

## Advantage

> Lighter than Vanilla SR

## [Plan feature list](/docs/plan_features)

- [microsoft TODO](https://to-do.microsoft.com/sharing?InvitationToken=Q6SN1kdtitK8cwFktFl71gSnsRMNmrH7CC7kHY_Tq6ReMRwHgInP4_q5ie2IwrHx8)

## [Update logs](/docs/update_logs.md)

## Environment (been tested / develop on)

- `Develop platform 1 - Windows 10`
  - `Python 3.8.10`
  - `Windows10 x64`
  - `json5 0.9.6`
  - `pillow 8.1.0`
  - `pyperclip 1.8.2`
  - `pyglet 2.0.dev13`
  - `xmltodict 0.12.0`
  - `toml 0.10.2`
  - `AMD R5 5600X`
  - `AMD RX 550 4G`
- `Develop platform 2 - macOS Big Sur`
  - `Python 3.8.7`
  - `macOS Big Sur 11.2.1`
  - `Pyglet 1.5.15`
  - `Json5 0.9.5`
  - `pillow 8.1.2`
  - `Intel I5 8279U`

## Required python modules

- `json5` (pre-installed V0.9.6 path:`./libs/json5`)
- `toml` (pre-installed V0.10.2 path:`./libs/toml`)
- `pyglet` (pre-installed V2.0.dev11 path:`./libs/pyglet`)
- `xmltodict` (pre-installed V0.12.0 path:`./libs/xmltodict`)
- `pyperclip` (pre-installed V1.8.2 path: `./libs/pyperclip`)
- `pillow`
- `semver`

## thanks to

- [pyglet](https://github.com/pyglet/pyglet): GUI
- `json5`: json5 parser
- `toml` toml parser
- `xmltodict`: translate data between xml and dict
- `pyperclip`: paste board!
- [@Rayawa](https://github.com/Rayawa) : check mistake in docs & some transelates
- [@rouxiao-you](https://github.com/ruoxiao-you) : translate chinese to English
- [@Billchyi](https://github.com/Billchyi) : check mistake in docs

## Other links

## About License

#### https://creativecommons.org/licenses/by-nc-sa/4.0/

#### Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)

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.