rexwangsida / craftmaster

Minecraft-like 3D sandbox game built with Python and Pyglet

Welcome to CraftMaster 👋

Welcome to the repository of our Mcmaster SFWRENG 3XA3 Software Project, lead by Prof. Asghar Bokhari and supervised by TA Thien Trandinh. The information of the group members is listed below:

Group Member	Role(s)	Contact Info
Sida Wang	Full-Stack Developer, Game Developer	[email protected]
Weidong Yang	Full-Stack Developer, Game Developer	[email protected]
Deuce Cao	Game Developer	[email protected]

Table of Content

• What is CraftMaster?
• Where to start?
• CraftMaster Views
• Open Issues
• Special Thanks

What is CraftMaster❓

CraftMaster is a 3D sandbox game developed by three software engineering students at Mcmaster University. It is a reimplementation of @fogleman/Minecraft(refered to as orginal project) which is developed by Michael Fogleman. CraftMaster is written in Python with Pyglet. All the media source are open-source and found online. The executable game is generated by Pyintsaller. We believe the software design principles and software architectural design patterns that we applied to the project significantly increased the quality of the software. The highlights of CraftMaster are the module decomposition and novel functionalities/features of the game. The team has also developed and deployed a game website to hold the game for downloads and updates.

Where to start❓

Download the executable game and play

• The Official Game Website can be found at HERE.
• To learn the instruction of how to download and play the game, follow the CraftMaster User Guide.

OR

Run the game in terminal

• This can be done in Windows PowerShell or Linux/Mac Terminal, and it requires git, python and pyglet, or at least pip.
• The instruction of how to install python can be found at HERE.
• The instruction of how to install pip can be found at HERE.
• The instruction of how to install git can be found at HERE.
• To install python(it requires pip to be installed), run:

pip install python

• To install pyglet(it requires pip to be installed), run:

pip install pyglet

• To start the program, sequentially run:

git clone https://github.com/RexWangSida/CraftMaster.git

cd CraftMaster/CraftMasterGame/src

python main.py

• To learn the instruction of how to play the game, follow the CraftMaster User Guide.

CraftMaster Views🏔

Open Issues 🚑

So far the executable game is only supported on Windows OS.

• Windows OS
• Mac OS

The Mac OS version is still on the way.

Special Thanks 🎉

We gratefully thank Thien Trandinh for the guidance throughout the term and Michael Fogleman for giving us permissions to modify the amazing original project and allow us to develop CraftMaster on the base of it.

[Last Edited 06/19/2020]