# **Swimming Squid** 魷來魷去
[](https://www.python.org/downloads/release/python-390/)
[](https://github.com/PAIA-Playful-AI-Arena/MLGame)
[](https://github.com/pygame/pygame/releases/tag/2.0.1)
這是一個魷魚吃東西小遊戲，你需要找到正確的食物、避開海中的垃圾，還要提防敵人的攻擊！（當然你也可以主動攻擊他人）
---
# 基礎介紹
## 啟動方式
- 直接啟動 [main.py](http://main.py) 即可執行
### 遊戲參數設定
```python
# main.py
game = SwimmingSquid(
level: int = 1,
level_file: str = None,
game_times: int = 1,
sound: str = "off")
```
- `level`: 選定內建關卡，預設為 1 選擇第一關。
- `level_file`: 使用外部檔案作為關卡，請注意，使用此設定將會覆蓋掉關卡編號，並且不會自動進入下一關。
- `game_times`：選擇要對戰幾次決勝負，可選擇一戰決勝負、三戰兩勝制、五戰三勝制。預設為一戰決勝負。
- `sound`: 音效。
## 玩法
- 1P：使用鍵盤 上、下、左、右 控制魷魚
- 2P：使用鍵盤 W、S、A、D 控制魷魚
## 遊戲規則
### 角色升級機制
角色初始等級皆為 1，隨著得分增加升 / 降級。等級將會影響角色長寬與移動速度，各等級對應資料如下：
| Lv| 角色寬度 | 角色高度 |移動速度|
| --- | ------- | ------ | ------|
| 1 | 30 | 45 |25|
| 2 | 36 | 54 |21|
| 3 | 42 | 63 |18|
| 4 | 48 | 72 |16|
| 5 | 54 | 81 |12|
| 6 | 60 | 90 |9|
### 得分 / 扣分規則
1. 吃東西：
1. 角色可以透過吃海裡漂浮的東西獲取分數，但海裡也有垃圾存在，吃到垃圾將會扣分。
2. 不同的食物 / 垃圾會有不同的大小與分數。資料如下：
|食物名稱 | 物件寬度 | 對應分數 |
| ----- | ------- | ------ |
| FOOD_1 | 30 | 1 |
| FOOD_2 | 40 | 2 |
| FOOD_3 | 50 | 4 |
| GARBAGE_1 | 30 | -1 |
| GARBAGE_3 | 40 | -4 |
| GARBAGE_3 | 50 | -10 |
3. 食物數量會隨遊戲時間增加
2. 玩家相撞：
1. 當地圖長寬皆大於 500 pixels 時，遊戲將增加碰撞機制。
2. 兩隻魷魚相撞時，如果一方等級較高，則等級高者加 10 分，等級低者扣 10 分。
3. 如果兩方等級相同，則雙方皆扣 5 分。
### 通關條件
1. 時間結束前，吃到的食物超過`score`，即可晉級下一關。
2. 若兩人同時通關，分數較高者勝。
3. 若兩人同時通關且同分，遊戲將進入延長賽：提高 `score` 50 分，並且延長遊戲時間 600 frame。
4. 遊戲最多延長 3 次。
### 失敗條件
1. 時間結束前，吃到的食物少於`score`，即算失敗。
2. 若兩人皆未能達成 `score`，分數較高者勝。
3. 若兩人皆未能達成 `score` 且同分，遊戲將進入延長賽：`score` 維持不變，並且延長遊戲時間 300 frame。
4. 遊戲最多延長 3 次。
---
# 進階說明
## 使用ＡＩ玩遊戲
```bash
# 在easy game中，打開終端機
python -m mlgame -i ./ml/ml_play_template.py ./ --level 3
python -m mlgame -i ./ml/ml_play_template.py ./ --level_file /path_to_file/level_file.json
```
## ＡＩ範例
```python
import random
class MLPlay:
def __init__(self,ai_name,*args, **kwargs):
print("Initial ml script")
def update(self, scene_info: dict,,*args, **kwargs):
# print("AI received data from game :", scene_info)
actions = ["UP", "DOWN", "LEFT", "RIGHT", "NONE"]
return random.sample(actions, 1)
def reset(self):
"""
Reset the status
"""
print("reset ml script")
pass
```
## 遊戲資訊
- scene_info 的資料格式如下
```json
{
"frame": 15,
"collision_mode": "True",
"score": 8,
"score_to_pass": 10,
"self_x": 100,
"self_y": 300,
"self_w": 30,
"self_h": 45,
"self_vel": 25,
"self_lv": 1,
"opponent_x":500,
"opponent_y":400,
"opponent_lv": 2,
"status": "GAME_ALIVE",
"foods": [
{
"h": 30,
"score": 1,
"type": "FOOD_1",
"w": 30,
"x": 40,
"y": 134
},
{
"h": 40,
"score": 2,
"type": "FOOD_2",
"w": 40,
"x": 422,
"y": 192
},
{
"h": 50,
"score": 4,
"type": "FOOD_3",
"w": 50,
"x": 264,
"y": 476
},
{
"h": 30,
"score": -1,
"type": "GARBAGE_1",
"w": 30,
"x": 100,
"y": 496
},
{
"h": 40,
"score": -4,
"type": "GARBAGE_2",
"w": 40,
"x": 633,
"y": 432
},
{
"h": 50,
"score": -10,
"type": "GARBAGE_3",
"w": 50,
"x": 54,
"y": 194
}
]
}
```
- `frame`：遊戲畫面更新的編號。
- `collision_mode`：本局是否有碰撞模式。
- `self_x`：玩家角色的Ｘ座標，表示方塊的`中心點`座標值，單位 pixel。
- `self_y`：玩家角色的Ｙ座標，表示方塊的`中心點`座標值，單位 pixel。
- `self_w`：玩家角色的寬度，單位 pixel。
- `self_h`：玩家角色的高度，單位 pixel。
- `self_vel`：玩家角色的速度，表示方塊每幀移動的像素，單位 pixel。
- `self_lv`：玩家角色的等級，最小 1 ，最大 6。
- `opponent_x`：對手角色的Ｘ座標，表示方塊的`中心點`座標值，單位 pixel。
- `opponent_y`：對手角色的Ｙ座標，表示方塊的`中心點`座標值，單位 pixel。
- `opponent_lv`：對手角色的等級，最小 1 ，最大 6。
- `foods`：食物的清單，清單內每一個物件都是一個食物的`中心點`座標值，也會提供此食物是什麼類型和分數多少。
- `type` 食物類型： `FOOD_1`, `FOOD_2`, `FOOD_3`, `GARBAGE_1`, `GARBAGE_2`, `GARBAGE_3`
- `score`：目前得到的分數
- `score_to_pass`：通關分數
- `status`： 目前遊戲的狀態
- `GAME_ALIVE`：遊戲進行中
- `GAME_PASS`：遊戲通關
- `GAME_OVER`：遊戲結束
## 動作指令
- 在 update() 最後要回傳一個字串，主角物件即會依照對應的字串行動，一次只能執行一個行動。
- `UP`：向上移動
- `DOWN`：向下移動
- `LEFT`：向左移動
- `RIGHT`：向右移動
- `NONE`：原地不動
## 遊戲結果
- 最後結果會顯示在console介面中，若是PAIA伺服器上執行，會回傳下列資訊到平台上。
```json
{
"frame_used": 100,
"state": "FAIL",
"attachment": [
{
"squid": "1P",
"score": 0,
"rank": 2,
"wins": "1 / 3"
},
{
"squid": "2P",
"score": 10,
"rank": 1,
"wins": "2 / 3"
}
]
}
```
- `frame_used`：表示使用了多少個frame
- `state`：表示遊戲結束的狀態
- `FAIL`：遊戲失敗
- `FINISH`：遊戲完成
- `attachment`：紀錄遊戲各個玩家的結果與分數等資訊
- `squid`：玩家編號
- `score`：吃到的食物總數
- `rank`：排名
- `wins`：目前勝場數
---
# 參考資源
- 音效
1. https://soundeffect-lab.info/sound/anime/
- 背景音樂
1. https://www.motionelements.com/zh-hant/stock-music-28190007-bossa-nova-short-loop
- 圖片
1. 魷魚 https://illustcenter.com/2022/07/03/rdesign_1659/
2. 湯匙 https://illustcenter.com/2021/11/24/rdesign_6275/
3. 薯條 https://illustcenter.com/2021/11/16/rdesign_5098/
4. 空罐 https://illustcenter.com/2021/11/19/rdesign_5772/
5. 魚1 https://illustcenter.com/2021/12/22/rdesign_8914/
6. 魚2 https://illustcenter.com/2021/10/28/rdesign_3149/
7. 蝦子 https://illustcenter.com/2021/10/28/rdesign_3157/