軟體系統規格書 SRS
===

# 目錄

1. 簡介
    1.1 規格目的
    1.2 規格範圍
2. 系統概述
    2.1 系統目標
    2.2 系統範圍
    2.3 系統架構
    2.4 系統需求概述
        2.4.1 子系統 X 需求概述
    2.5 系統環境需求
        2.5.1 系統開發環境需求
        2.5.2 系統執行環境需求
3. 系統需求分析
    3.1 系統模組功能說明
        3.1.1 模組方塊圖示
        3.1.2 模組功能描述
    3.2 系統類別需求
    3.3 系統績效需求分析
    3.4 系統保密安全需求分析
    3.5 系統資料庫需求分析
    3.6 系統品質需求分析
    3.7 系統設計限制
        3.7.1 子系統 XXX
    3.8 系統鑑定需求分析
    3.8.1 子系統 XXX
4. 系統需求追溯
    4.1 子系統 XXX 需求追溯
5. 附錄

# 1. 簡介
針對本軟體需求規格書的目的、適用範圍、以及撰寫時所參考之文件做一簡
要的說明。

## 1.1 規格目的
軟體需求規格主要目的乃在說明一軟體建構項目的工程(engineering)
與鑑定(qualification)的需求，經過軟體規格審查後，成為配置基準
(allocated baseline)，用以評估軟體產品是否達成軟體建構項目需求，
亦為軟體設計與軟體鑑定測試的依據。

## 1.2 規格範圍
軟體需求規格書適用於整體系統開發的所有發展過程，乃是系統開發時
必須時時刻刻遵循的準繩。

# 2. 系統概述
玩家操控 sparrow 一起合作將 sparrow 們寶貴的蛋，送至目的地，途中會遭遇各種怪物和燒腦的機關，俗話說三個臭皮匠勝過諸葛亮，遇到複雜的機關，最多可以連線 10 隻 sparrow 合作。

## 2.1 系統目標
- 實作 Client/Server 多人連線遊戲（最多十人）
- 實作簡易物理引擎
- 遊戲畫面擁有高刷新率，144Hz
- 豐富的關卡設計（2關以上）
- 多種玩法編織而成（2種模式以上）
- 設計團隊開發規則

## 2.2 系統範圍
硬體平台：運行在PC上
作業系統：Windows
檔案大小：1GB
遊戲類型：冒險、角色扮演、策略、模擬
遊戲規模：遊戲可以單人、多人遊玩
伺服器規格：須符合Client/Serve(主從式架構)

# 3. 系統需求

## 3.1 系統功能需求

## 3.2 系統績效需求

## 3.3 系統品質需求

### 3.3.1 GitHub

#### Commit 語法

##### Header

commit 顯示的主要訊息，可以想成標題，請參考以下種類與範例。

feat: 新增/修改功能 (feature)。（升級也可）
fix: 修補 bug (bug fix)。
docs: 文件 (documentation)。
style: 格式 (不影響程式碼運行的變動 white-space, formatting, missing semi colons, etc)。
refactor: 重構 (既不是新增功能，也不是修補 bug 的程式碼變動)。
perf: 改善效能 (A code change that improves performance)。 
test: 增加測試 (when adding missing tests)。
chore: 建構程序或輔助工具的變動 (maintain)。
revert: 撤銷回覆先前的 commit 例如：revert: type(scope): subject (回覆版本：xxxx)。

格式
<type>: <title>

範例
feat: 新增碰撞系統
fix: 修正 socket 錯誤

---

##### Body

將更改的檔案列出來，並說明修改內容，參考以下範例

格式
<檔案路徑>
- 修改內容

範例
src/block.py
- 修正地形碰撞

src/main.py
- 新增設定檔路徑

---

##### Issue

標題和上面 commit 一樣，但不需要加上 commit 種類，需另外加上 label。


---

##### Branch 分支命名規則

原則上一個 issue 一個 branch，issue 跟 branch 可以想成一組的。
注意！因 branch 名稱不得有空格，所以需要用 `-` 來取代空格，可以參考以下範例。

格式
<issue_type>/issue#<issue_id>:-<issue_title>

範例
feat/issue#1:-修正碰撞

---

## 3.4 系統環境需求

建議使用 `Pyenv` 進行 Python 版本切換。
[相關教學](https://www.maxlist.xyz/2022/05/06/python-pyenv/)

Python 版本: `3.11.5`
套件: 使用 `requirement.txt` 安裝

### 3.4.1 建立環境常用指令

安裝 python 虛擬環境
python -m venv venv

安裝套件
pip install -r .\env\requirements.txt

## 3.5 系統功能配置

### 3.5.1 VSCode 延伸模組

#### 必要

主要 Python 的插件

包含一堆工具像是 debugger

更好的 LS

用於程式碼格式規範

## 3.6 系統架構

## 3.7 系統介面

### 3.7.1 外部介面

### 3.7.2 內部介面

## 3.8 子系統需求

### 3.8.1 子系統 X 之需求

### 3.8.2 ….

## 3.9 系統保密安全需求

## 3.10 系統容量需求

## 3.11 電腦硬體需求

## 3.12 系統支援軟體需求

# 4. 附錄