Untitled Game

Warning

Do not use the make tool with any other OS than Windows right now!

Build-Prerequisites

Note

Linux Development hasn't started yet. macOS Version needs help.

OS:	Windows	Linux	macOS
Minimum:	Windows 10	Ubuntu 22.04	macOS Monterey (Intel)
Python:	3.12.6	sudo apt install python	3.12.6
IDE:	Visual Studio 2022 Build Tools	sudo snap install --classic code	Xcode
PowerShell:	7.4.5	sudo snap install powershell	7.4.5
Misc:	MSYS2 (Optional)	QT	HomeBrew

Building the Project on macOS

1. Setup make tool (REDACTED) This can cause IRREVERSABLE HARM to your system if PyInstaller is not installed!
2. Use Xcode to manage the project

Building the Project on Windows (USING Visual Studio Powershell)

1. Clone the Repository

   git clone --recurse-submodules https://github.com/Daniel-McGuire-Corporation/WIP-Game.git
   cd WIP-Game

2. Setup (Does not require make, uses custom program)

   ./makeinit
   ./setenv
   make -setupengine

3. Compile the Project Learn Make Syntax

   make -compile (-run) -[game, tools, all]

USAGE:

Game Controls

• Left Arrow: Move left
• Right Arrow: Move right
• Up Arrow: Jump

Level Files

Levels are defined in .ini files located in the data/levels directory. The format of these files determines the layout of platforms and other elements.

Debug Mode

To enable debugging features, you have to recomp:

make -compile (-run) -[game, tools, all] -debug

Known Issues

• The game currently assumes the level file format is correct and doesn't handle errors in the level file.
• Collision detection is basic and might need improvements for more complex levels.
• macOS Version is not loading textures and just doesnt really want to work.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For questions or issues, please contact Daniel McGuire.

Acknowledgments

• SFML: A great library for multimedia applications.
• QT: A great GUI library
• Apple: swift (took me 2 days to learn the basics lol)
• DMC MVPs