Awesome

An interactive Doom fire simulator with a simple options menu developed in Python + Pygame. In this project it is possible to change the amount of fps, flame decay, wind direction, wind force and make it possible to change the colors of the flames in the HSL(hue, saturation, lightness) color space, in addition to allowing to turn on/off the flames.

<a name=index>Table of contents 📚</a>

• Options menu
• How to use the options menu?
• Example of possible colors for the flames
• How can i run?
• Honorable mention
• Dependencies
• Version
• License

<a name=menu>Options menu 🧰⚙️</a> <h6>back to indice</h6>

The program has 8 adjustable options and allows you to use the Q key to turn the fire on/off. The options currently available are:

• FPS:
  • option to control the SPF, ranging from 10 to 60.
• Decay:
  • option to control the intensity with which the flames lose strength, varying from 1 to (1-amount of colors available in the color palette).
• Wind direction:
  • option to control the wind direction, having 3 modes: right, left and both.
• Wind force:
  • option to control the wind force, ranging from 0 to 10.
• Color intensity:
  • control option to change the color palette, varies from True to False.

The options below can only be changed if color intensity is True.

• H:
  • option to control the H component (hue) of the color, ranging from 0 to 360.
• S:
  • option to control the S component (saturation) of the color, ranging from 0.0 to 1.0.
• L:
  • option to control the L component (brightness) of the color, ranging from 0.0 to 1.0

<a name=using_menu>How to use the options menu 🕹️</a> <h6>back to indice</h6>

• use <kbd>ESC</kbd> to exit/close the program.
• use <kbd>Q</kbd> to turn the flames on/off 🔥.
• use <kbd>W</kbd> or: arrow_up: to select the menu above.
• use <kbd>Z</kbd> or: arrow_down: to select the menu below.
• use <kbd>S</kbd> or: arrow_right: to increase / change the value of the selected menu.
• use <kbd>A</kbd> or: arrow_left: to decrement / change the value of the selected menu.

<a name=example>Example of possible colors for the flames 🎨</a> <h6>back to indice</h6>

The image below is a demonstration of the colors that are possible for the flames.

<a name=run>How can I run? 🧠💭</a> <h6>back to indice</h6>

Download the project, install the dependencies, enter the src folder and execute:

python main.py

<a name=honorable_mention>Honorable mention 🥇</a> <h6>back to indice</h6>

This project is based on a <a href="https://youtu.be/fxm8cadCqbs" title="go to the Dechamps video tutorial">video</a> from <a href="https://github.com/filipedeschamps" title="Dechamps github profile">@filipedeschamps</a> , where he brings a doom fire algorithm that he implemented, in the video he explains how the algorithm works in a didactic, practical and simple way. My thanks for sharing your knowledge, diverse and fun content.

<a name=dependencies>Dependencies</a> <h6>back to indice</h6>

• Pygame == 1.9.6.
• Python == 3.7 or higher.

<a name=version>Version</a> <h6>back to indice</h6>

• current version of the project: 1.0.1.

<a name=license>License</a> <h6>back to indice</h6>

For more information on the license for this project read the <a href="./LICENSE" title="go to license file">LICENSE</a> file.