daversini / bersinidavide_endyearexamination

End Year Examination Framework Test

MyEngine Framework

A simple SFML-ready Framework that supports the creation of game objects with attachable components.
Please help me to find a name, I have no imagination (ㆆ_ㆆ)

Table of Contents 📍

• Requirements 🏷️
• How to install 🚀
• Currently supported functionalities ⚙️
• Getting Started 🎬
• Contributing 🤝
• License 📜
• Contact 📧

Requirements

To open and build the Solution you need Visual Studio installed on your computer (Reccomended Visual Studio 2019).
To run the executable you also need OpenGL32 installed.
In order to generate the documentation you need to have installed Doxygen as an environment variable.

How to install

1. First of all, clone this Repository. (Note that you have to clone it into a path WITHOUT spaces, otherwise the Visual Studio Post build copy command will fail)

2. Then run the GenSolution.bat file inside the /Scripts folder and select a Visual Studio version to generate the Solution.

3. Open the Solution and try to build the Framework.

If there are no errors, you can now start to build your own Sandbox!

NB: If you want to generate the documentation, run GenDocumentation.bat file inside the /Scripts folder. It will automatically open index.html under /Docs/html

Currently supported Functionalities

At the moment the Framework supports the creation of simple Game Objects (as a Sprite, or a Character) and the possibility to attach different Components to them.

As for Game Objects:

• Area2D

  A GameObject with a 2D Area controlled by a RectTransform Component.

• Sprite

  An Area2D with a Renderer2D Component.

• Character

  A Sprite that can be controlled with an InputController and a MovementComponent.

As for Components:

• RectTransform

  A Component capable of giving a rectangle portion transform to a GameObject.

• Renderer2D

  A Component capable of giving 2D rendering to a GameObject.

• InputController

  A Component capable of receiving keyboard inputs from a GameObject.

• MovementComponent

  A Component capable of calculating the movement of a GameObject.

Getting Started

After you followed every step in the installation guide, you can now start the Solution and open Sandbox.cpp.

To run the Sandbox you need to include these headers:

#include <MyEngine/Core/EntryPoint.h>
#include "SandboxLayer.h"

You'll see a class that extends Application. It looks something like this:

class Sandbox : public MyEngine::Application
{
public:
	Sandbox() : Application(1920, 1080, "Sandbox")
	{
		// Game Settings
		enableFPSLimit();
		setMaxFPS(60);

		// Push SandboxLayer to Application
		pushLayer(new SandboxLayer);
	}

	~Sandbox() {}
};

In order to create an Application, we implement this method from the Framework:

MyEngine::Application* MyEngine::createApplication()
{
	return new Sandbox;
}

You can now open SandboxLayer.cpp were all SandboxLayer methods are implemented

Go into the onAttach() method and start to create your first Game Object!

MyEngine::Sprite* background = new MyEngine::Sprite();  // Creation of a Sprite Game Object

Now you need to define custom properties for the Game Object

// Make sure that the texture path is correct!
background->renderer->setTextureSource("resources/textures/AOT-background.jpg", true, true);
background->rectangleTransform->setScale(1920, 1080);

When you're done with a Game Object you need to push that into allEntities vector

allEntities.push_back(background);

Now let's create a Character that we can move in the viewport

MyEngine::Character* player = new MyEngine::Character();    // Move the Character with WASD
player->renderer->setTextureSource("resources/textures/Mikasa.png", true, false);
player->movementComponent->speed = 300;
player->rectangleTransform->setScale(400, 400);
player->rectangleTransform->setPosition(1920 / 2 - 400 / 2, 1080 / 2 - 400 / 2);
allEntities.push_back(player);

After the creation of all Game Objects, return allEntities back to the Application

return allEntities;

And we're done! You now have a movable Character rendered over a custom background!

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Davide Bersini - @Daversini - [email protected]

Project Link: https://github.com/Daversini/BersiniDavide_EndYearExamination