Skip to content

lukewhitingdev/Necrodoggiecon

Repository files navigation

Necrodoggiecon

How the project works

The engine holds all the intrinsic components and the other outer projects can create classes that inherit these components and then the class can be used to create the game ontop of the engine.

Specific Areas I Worked on:

Audio - See Audio

Utility - See Utility

AssetManagement - See AssetManagement

Event System - See Event System

Debug + Error Logging - See Debug

Camera Manager - See Camera Manager

IO Utility - See IO

I also worked on Build scripts and general build improvements like de-coupling the game and engine by compiling the engine into a static library and also creating post-build scripts within visual studio which copies resources from project to project to allow for easy coherence across all the projects built ontop of the engine and game.

For a easier time looking at the Build Steps etc, I recommend opening the project in Visual Studio.

Furthermore, I also helped create the engine architecture and helped other developers on this project improve areas of their code through code review which the whole team conducted on other team members pull requests.

Instructions

How to compile the Engine

Open the CerberusEngine project in Visual Studio. Right click on the project and click build. Do not debug the engine, just build it.

How to compile the Game

Firstly, compile the engine. Open the Necrodoggicon project in Visual Studio. Right click on the project and set as startup project. Set to release mode and press F5 to run the game.

How to access documentation

The technical documentation is automatically generated using Doxygen. To view the generated documentation for this project see the generated PDF HERE.

To generate / contribute documentation.

Firstly, to add auto-styled doxygen comments, use of the Visual Studio Extension Doxygen Comments
To generate the documentation, a doxygen binary is required. This is the responsibility of the developer sadly as including Doxygen source in this project would increase the project size dramatically.

How to play the Game

Controls:

  • WASD - Movement
  • Left click - Fire weapon
  • F - Interact

Naming Convention

Variables:

varNameHere.

Functions:

FunctionNameHere.

Enums, Defines:

ANGRYENUMS

Links to the aspects of the Engine/Game

About

Game and Game Engine built in 6 weeks

Resources

Stars

Watchers

Forks

Contributors 10