Here are all the main informations about the project.
This project is more a private project for me to learn and practice C++ in a project. It will not be released or published at all.
The project uses only libraries that are available on the system itself. No third party libraries will be used.
In this section is described how to start using this project to develop it and what is required to do so.
To edit and build the project Visual Studio on Windows is required currently because of the solution file.
To clean the project from Visual Studio temporary files execute Clean.bat.
- Clone the repo
git clone https://github.com/VRSimDude/FindYourWayOut.git- open the project
open FindYourWayOut.sln
To play the game built it in Visual Studio or start it directly from Visual Studio.
You can also start the game without Visual Studio by download the executables for windows here:
v1.0.0 Win64
v1.0.0 Win32
Here is described how you use the projects features.
Move the player with WASD. Exit a level with Escape.
The renderer is responsible for rendering the pixels on the screen.
In the Init() function the size of the console can be changed.
Also the size of the font can be changed. But be aware that characters are rendered at this size too.
So if you change that to one pixel every char is only one pixel and not readable anymore.
The renderer also change the console during the game but reset it as it was before the game was started.
It has 2 overloaded functions to render something on the screen.
RenderAtPos(const WCHAR& _unicodeChar, const WORD& _attribute, const SVector2& _pos)With this function a single pixel can be drawn at the screen at the given position.
RenderAtPos(CHAR_INFO const* const _pSprite, const SVector2& _pos, int _width, int _height)With this function a sprite can be drawn on the screen starting at the given position.
There are 2 local files that can be used to change the game.
You can change these however you like.
Please be aware that it always needs a player and an exit for every level.
In these files every single level can be configured differently.
Here is an example of the first level config (level_1.cfg):
The degree values like Camera FOV are in degree.
The distance and height values are in cm.
The time is in seconds.
If this level is the last level, last_level must be set to 1 or anything but not 0
The char values are used in the level files to determine which chars are used for which class
These files are used for the actual architecture of the map.
It uses the chars from the config file to determine which char is what class.
Empty chars are used for normal ground and ceiling.
Here is an example of the first level (level_1.map):
The object manager is a singleton calls which handles every object in the level.
It is responsible for loading the level config and map from file and create the necessary objects.
Deleting the objects are also handled by the object manager.
It also has a functionality to check wether a given location hits a wall or not.
To prevent the game for handling too many object, the level is split in chunk of objects.
During the level loading the object manager splits the level in chunks which are the size of the camera max view distance from the config file Local files above).
Only the objects in the chunks around the chunk where the player currently is are updated and used for collision detection.
So in total there are 9 chunks to check.
The raytracer is responsible for the calculation of the distance to a wall or the exit location for the whole screen.
Here is a simplified version of the workflow of how this works:
- The starting angle is calculated by the camera angle and half of the horizontal field of view. The degree for every horizontal pixel is calculated, so that the field of view is displayed along the horizontal pixels of the screen.
- The forward vector for the current trace angle is calculated (1. line forward in image).
- Then the 2 vector for the axis are calculated to the nearest wall (horizontal and vertical check triangle in image).
-
Now the vector for a single step horizontal or vertical is calculated (horizontal and vertical check every step in image).
This works only in the was it does because the level layout is grid based.
- Now the shorter of the nearest to wall vector of horizontal or vertical (horizontal and vertical check triangle in image) is used to check for collision.
-
If there is no collision this location is increased by the horiztontal or vertical for one step (horizontal and vertical check every step in image).
Now again the shorter vector of the two is used to check for collision.
- This is done util a wall is hit or the max view distance is reached.
- If there is no collision the vertical line on the screen is only filled with the ground and ceiling color
- If there is a collision the height to the field of view vertical and the collision location is calculated (FOV height at wall location in image).
- The the wall percentage of that height is calculated (the wall is 200cm height). This percentage will the be used to calculate the start position of the wall in pixel of the screen height. Because the camera is in the middle of the screen the height of the wall is calculated. The closest starting pixel of the wall to the middle of the screen is saved.
- Now the wall and the ceiling and ground is drawn at the screen.
- Now the current trace angle is increased by one step (from calculation step 1). The steps 2 to 11 are now repeated for every horizontal line on the screen.
- After every line was drawn there is a check wether any starting pixel of a wall is closer to the middle than 40% of the screen height. All lines that have a dark green pixel there will be colored to a green pixel. Therefore, the green color is always until the lowest wall pixel.
Contributions to this project can be done by writing me.
Distributed under the MIT License License. See LICENSE for more information.
mail: contact@marcfriedrich.com
project link: https://github.com/VRSimDude/FindYourWayOut