Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
seigot committed Dec 26, 2021
1 parent bdefbed commit e89a091
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 25 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Tetris Game
# Tetris

プログラミング学習を目的とした、ブロックを操作してスコアを競うゲームです。<br>
[FAQ](https://github.com/seigot/tetris/blob/master/doc/files/FAQ.md)はこちら。<br>
[tutorial](https://github.com/seigot/tetris_tutorial)はこちら。
[tutorial](https://github.com/seigot/tetris_game_tutorial)はこちら。

## 実行環境準備

Expand Down Expand Up @@ -48,7 +48,7 @@ git clone https://github.com/seigot/tetris

```shell
cd tetris
bash start.sh
python start.py
```

![Screenshot](doc/pics/screenshot_02.png)
Expand All @@ -59,8 +59,8 @@ bash start.sh

* `game_manager/game_manager.py` : ゲーム管理用プログラム
* `game_manager/board_manager.py` : ボード管理用プログラム
* `block_controller.py` : ブロック操作用プログラム(ブロックの操作は、このファイルを更新して下さい。)
* `start.sh` : ゲーム開始用スクリプト
* `game_manager/block_controller.py` : ブロック操作用プログラム(ブロックの操作は、このファイルを更新して下さい。)
* `start.py` : ゲーム開始用スクリプト

#### 詳細

Expand All @@ -81,7 +81,7 @@ bash start.sh

| 手動操作 | PC操作準拠 | ゲーム機コントローラ準拠 |
| ---- | ---- | ---- |
| 実行コマンド | bash start.sh -m y | bash start.sh -m g |
| 実行コマンド | python start.py -m y | python start.py -m g |
| *up* key | 回転 | 落下 |
| *left* key | 左に移動 | 左に移動 |
| *right* key | 右に移動 | 右に移動 |
Expand All @@ -95,7 +95,7 @@ bash start.sh
サンプルコードについて[ブロック操作用サンプルプログラム](https://github.com/seigot/tetris/blob/master/doc/files/block_controller_sample.md)を参照下さい。<br>

```shell
bash start.sh -s y
python start.py -s y
```

# Play rules
Expand Down Expand Up @@ -126,7 +126,7 @@ bash start.sh -s y

| | level1 | level2 | level3 |
| --- | --- | --- | --- |
| 実行方法 | bash start.sh | bash start.sh -l2 | bash start.sh -l3 |
| 実行方法 | python start.py | python start.py -l2 | python start.py -l3 |
| 制限時間 | 180秒 | 180秒 | 180秒 |
| ブロックの順番 | 固定(1-7まで順番に繰り返し) | ランダム | ランダム |
| フィールドの初期ブロック | なし | なし | あり |
Expand Down Expand Up @@ -167,7 +167,7 @@ sudo rm -rf tetris
### 実行

`実行方法`を参考に実行環境の構築をして下さい。<br>
環境構築の完了後、ブロック操作用プログラム[`block_controller.py`](https://github.com/seigot/tetris/blob/master/block_controller.py)を更新していってください。<br>
環境構築の完了後、ブロック操作用プログラム[`block_controller.py`](https://github.com/seigot/tetris/blob/master/game_manager/block_controller.py)を更新していってください。<br>

### 自リポジトリのバイナリを公式リリースする

Expand Down Expand Up @@ -213,8 +213,8 @@ git push # 変更を反映

# 参考

[https://github.com/LoveDaisy/tetris](https://github.com/LoveDaisy/tetris) <br>
[https://github.com/seigot/tetris(2021.12時点まで使用)](https://github.com/seigot/tetris)
[https://github.com/LoveDaisy/tetris](https://github.com/LoveDaisy/tetris_game) <br>
[https://github.com/seigot/tetris(2021.12時点まで使用)](https://github.com/seigot/tetris_game)<br>
[http://zetcode.com/gui/pyqt5/tetris/](http://zetcode.com/gui/pyqt5/tetris/)<br>
[テトリスの歴史を「ブロックが落ちるルール」の進化から学ぶ](https://gigazine.net/news/20191116-tetris-algorithm/)<br>

Expand Down
7 changes: 4 additions & 3 deletions doc/files/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
| ---- | ---- |
| ubuntu18.04,20.04 | [こちら](https://github.com/seigot/tetris/blob/master/doc/files/install_ubuntu.md) |
| Mac | [こちら](https://github.com/seigot/tetris/blob/master/doc/files/install_mac.md) |
| Windows+powershell | [こちら](https://github.com/seigot/tetris/blob/master/doc/files/install_windows_powershell.md) |
| Windows+Docker | [こちら](https://github.com/seigot/tetris/blob/master/docker/README.md) |
| JetsonNano | (動作未確認だがおそらく動くはず) |
| RaspberryPi | (動作未確認だがおそらく動くはず) |
Expand All @@ -33,7 +34,7 @@ bash doc/files/install_ubuntu.sh
--> installが成功すればOK

```
bash start.sh
python start.py
```

--> テトリスが表示されればOK
Expand All @@ -49,7 +50,7 @@ $ sudo rm /var/lib/dpkg/lock
$ sudo rm /var/lib/dpkg/lock-frontend
```

## サンプルプログラム(`bash start.sh -s y`で動くやつ)の中身はどうなってるのか
## サンプルプログラム(`python start.py -s y`で動くやつ)の中身はどうなってるのか
[こちら](https://github.com/seigot/tetris/blob/master/doc/files/block_controller_sample.md)で解説

## スコアアタック時の動作PC環境について
Expand Down Expand Up @@ -126,7 +127,7 @@ function install_torch(){
(kyadさんありがとうございます)<br>
<br>
追記:cygwin環境構築手順<br>
[isshy-youさんによる`Cygwin Install for tetris`構築手順](https://github.com/isshy-you/tetris/wiki/Cygwin-Install-for-tetris)<br>
[isshy-youさんによる`Cygwin Install for tetris`構築手順](https://github.com/isshy-you/tetris_game/wiki/Cygwin-Install-for-tetris_game)<br>
(isshy-youさんありがとうございます)

### 以下、順次追記
2 changes: 1 addition & 1 deletion doc/files/install_windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Terminalを立ち上げて以下を実行

```
cd ~/tetris
bash start.sh
python start.py
```

注意)パワーシェルを閉じたり電源OFFするとコンテナも終了します。作成中データが失われないよう注意してください。
2 changes: 1 addition & 1 deletion doc/files/install_windows_wsl.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ git clone https://github.com/seigot/tetris
### tetrisを実行する
```
cd ~/tetris
bash start.sh
python start.py
```

一度実行環境を立ち上げた後の2回目からは、Step 3以降を実行すれば良い。
4 changes: 2 additions & 2 deletions doc/files/reference_score.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
| | level1 | level2 | level3 | 自由部門 |
| --- | --- | --- | --- | - |
| random | -916 | -731 | -4948 | - |
| sample(bash start.sh -s y) | 6935 | 6259 | 3737 | - |
| [kyadさん作の無限テトリス](https://github.com/kyad/tetris/blob/forever-branch/forever.md) | - | - | - | 20617 |
| sample(python start.py -s y) | 6935 | 6259 | 3737 | - |
| [kyadさん作の無限テトリス](https://github.com/kyad/tetris_game/blob/forever-branch/forever.md) | - | - | - | 20617 |
| 理論値 | 23400+落下ボーナス | - | - | - |

理論値は「(全てI字の棒が出るなどして)全て4ライン消しをした場合」を想定。<br>
Expand Down
12 changes: 6 additions & 6 deletions doc/files/test.sh
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#!/bin/bash

bash start.sh -l 1 -f test_l1_random.log
bash start.sh -l 2 -f test_l2_random.log
bash start.sh -l 3 -f test_l3_random.log
bash start.sh -l 1 -s y -f test_l1_sample.log
bash start.sh -l 2 -s y -f test_l2_sample.log
bash start.sh -l 3 -s y -f test_l3_sample.log
python start.py -l 1 -f test_l1_random.log
python start.py -l 2 -f test_l2_random.log
python start.py -l 3 -f test_l3_random.log
python start.py -l 1 -s y -f test_l1_sample.log
python start.py -l 2 -s y -f test_l2_sample.log
python start.py -l 3 -s y -f test_l3_sample.log

2 changes: 1 addition & 1 deletion docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Terminalを立ち上げて以下を実行

```
cd ~/tetris
bash start.sh
python start.py
```

## update docker container
Expand Down

0 comments on commit e89a091

Please sign in to comment.