Skip to content

UnityTeam5/LoveScript

Repository files navigation

LoveScript

如何協作此專案?(限共同開發者)

步驟一:請先fork這支專案(右上角)

步驟二:打開git bash(或者VSCode有裝bash也可使用)先cd至事先建立好的資料夾中,輸入剛剛fork專案的位置並複製至本地端,範例: git clone https://github.com/George15526/LoveScript.git

步驟三:打開Unity Hub,左側選單選擇Project,並在右上點擊"Add",選擇"Add project from disk",選擇剛剛clone下來的資料夾位置

步驟四:若有發現Unity Hub的Project裡面有LoveScript名字的專案,即可雙擊開啟專案並開始開發囉~

注意:在正式開發專案前,請各位確定是否將自己的專案分支改至dev,檢查方式為輸入git branch,若不是dev,則請輸入指令git checkout -b dev,即可轉至分支dev 注意:若在VSCode的話,在畫面的左下角可更容易知道現在的分支狀況

專案資料夾結構(協作者必看!!)

Assets/
├── Resources/
│   ├── Fonts/             # 儲存字體相關
│   │   ├── FontGenerator/ # 儲存 TMP_FontAsset
│   │   │   ├── MINGLIU--確認.asset
│   │   │   └── MINGLIU--按任意鍵開始遊戲.asset
│   │   └── FontStyle/     # 儲存字體檔案 (.TTC/.ttf/.otf)
│   │       └── MINGLIU.TTC
│   │
│   ├── Sprites/           # 2D 精靈圖像或 UI 資源
│   │   ├── Backgrounds/
│   │   │   └── MainMenuBackground.png
│   │   ├── Icons/
│   │   │   ├── Arrow-Previous.png
│   │   │   └── Exit.png
│   │   └── Roles/   # 背景圖片放置區
│   │       ├── Arrow-Previous.png
│   │       └── Exit.png
│   │
│   ├── Audio/             # 音效與音樂(預計加入,未新增資料夾)
│   │   ├── BGM/
│   │   │   └── MainTheme.mp3
│   │   │
│   │   └── SFX/
│   │       └── ButtonClick.wav
│   │
│   │
│   └── Data/              # 遊戲配置或數據文件(預計加入,未新增資料夾)
│       ├── GameConfig.json
│       └── Localization/
│           └── zh_TW.json 
│
├── Scripts/               # 腳本文件(**資料夾**命名請依場景名稱做分別,**檔案**命名無特別限制)
│   ├── Menu/
│   │   ├── ButtonPlayTextSetter.cs
│   │   ├── PlayGameHandler.cs
│   │   ├── QuitGameHandler.cs
│   │   └── TextEffect.cs
│   └── SubMenu/
│       ├── ButtonSubmitTextSetter.cs
│       ├── ReturnButtonEvent.cs
│       └── SubmitButtonEvent.cs
│
├── Editor/                # 腳本文件
│   └── EventSystemChecker.cs
│
├── Scenes/                # 遊戲場景檔案
│   ├── MainMenu.unity
│   └── Game.unity
│
├── Flower/                # 開源套件引入包
│
└── TextMesh Pro/          # 下載TextMesh Pro套件後自動生成,不可更動

Git如何使用?(給還不會使用或不太熟悉git的人服用)

以此專案為例,假設已經跟著上面的說明成功將專案clone下來後,接下來就只需要特別記三項事情(最常用)

  1. git add + 要新增的檔案位置 => 新增剛剛改動的檔案
  2. git commit -m "這裡放剛剛新增檔案的相關說明" => 在git中留言剛剛新增檔案的相關詳細說明(說明改動了什麼,新增?重構?樣式更改?等等其他)
  3. git push -u origin dev => 將剛剛的新增並留言完畢的git檔,推至遠端的git repository的dev分支

提醒:若是fork,則會有一個同名字的repo複製到你的倉庫裡,此時可以不必特別將分支改為dev,可逕行使用main分支,並在每次做完push至你的倉庫後(此時main會因為你的push而更新,但我這邊的主要倉庫並不會),選擇PR至主要倉庫的dev分支(第一次的執行PR時需選擇,未選擇預設為PR至main),之後等待核可即可

注意:若未核可,請注意退回後的commit,上面會說明為何退回,和可能需要修正的地方
(等待核可需一些時間,請耐心等候~)

例子:(branch -> dev)
git add Assets/
git commit -m "add a person in project"
git push -u origin dev

而在之後專案已經clone到本地端情況下,在每一次的協作中,請一定要先至GitHub倉庫中,查看是否需要更新程式碼(有可能其他協作者有更新東西在dev中,或者經過code review後合併至專案的主要main分支中),若需要更新程式碼,則需要在改動程式碼前,輸入git pull,先將更新的程式碼抓取下來,再做改動會比較好哦~

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •