A machine learning game framework based on Pygame
Project description
MLGame
這是一個遊戲AI競賽的框架,依照此框架所開發的遊戲,可以透過AI來玩遊戲,並進行AI競賽。
Table of Contents
! 重要 !
- 此次更新為大幅度更新專案架構,原有的指令方式、遊戲皆無法執行,因此請注意遊戲與MLGame的搭配。
使用方式
終端機範例
-
列出 help 文件
python -m mlgame -h
-
命令列格式
python -m mlgame [options] <game_folder> [game_params]
- 執行打磚塊遊戲
python -m mlgame \ -f 120 -i ./path/to/ai/ai_client_file_name.py \ ./path/to/game/arkanoid \ --difficulty NORMAL --level 3
- AI和遊戲的資料夾路徑可以使用
相對路徑
或是絕對路徑
- 遊戲參數
game_params
須參考各個遊戲
- AI和遊戲的資料夾路徑可以使用
- 執行打磚塊遊戲
位置引數(Positional Argument)
game_folder
required
- 遊戲資料夾所在的路徑,此路徑下需有
config.py
功能性引數(Functional Argument)
options
--version
顯示MLGame版本號-h
,--help
- 提供參數的說明
-f
FPS
,--fps
FPS
- 設定遊戲的遊戲更新率(frame per second),遊戲預設為每秒更新30次。
default
:30
-1
,--one-shot
- 表示遊戲只執行一次,沒有加上這個參數,遊戲皆會不斷重新執行。
default
:False
--nd
,--no-display
- 加上此參數就不會顯示螢幕畫面。
default
:False
--ws_url
WS_URL
- 加上此參數,會建立一個websocket connection,並將遊戲過程中的資料傳到指定的路徑,若路徑失效,則遊戲無法啟動。
-i
AI_Client
,--input-ai
AI_Client
- 指定要玩遊戲的AI,AI的檔案中,需要包含
MLPlay
這個class。 - 若有多個玩家,可直接參考下方案例,路徑可以使用絕對路徑與相對路徑。
-i ./path/to/ai/ai_01.py -i ./path/to/ai/ai_02.py
- AI數量需符合遊戲需求,每個遊戲都會有最小值與最大值,不足的會以最後一個AI自動補足,多的會自動刪去。
- 遊戲若需要2個AI,給到1個AI則會同時扮演1P 2P
- 遊戲若需要2個AI,給到3個AI則會自動排除最後一個
- 指定要玩遊戲的AI,AI的檔案中,需要包含
game_params
optional
- 執行遊戲的參數依照每個遊戲有所不同,格式為
--name_of_params
value_of_params
相關專案
- PAIA-Desktop
- 範例遊戲 easy_game
- 打磚塊 arkanoid
- 乒乓球 pingpong
- 賽車 Racing Car
- 迷宮自走車 Maze Car
Future Work
- Non-python Client Support
- test case
- 遊戲開發文件
Change Log
View CHANGELOG.md
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for mlgame-10.0.0.5a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e432b6338be0b286942ff254f63c7be867fd3d348131bc4930e2ee425344c7e |
|
MD5 | 8f26658f08309117251d2d423521b8f2 |
|
BLAKE2b-256 | 735fe7209ebcbd1f40a7dd02a634e4586fe20bea9be440b6d44d7fa021e30c45 |