Add @SpartaqS changes

This commit is contained in:
Krzysztof Stefan Rudnicki 2022-05-12 12:22:00 +02:00
parent aa74a8dc68
commit 867a6b110b

View File

@ -3,6 +3,7 @@
\usepackage{listings} \usepackage{listings}
\usepackage{xcolor} \usepackage{xcolor}
\usepackage{graphicx} \usepackage{graphicx}
\usepackage{soul}
\lstdefinestyle{sharpc}{language=[Sharp]C, frame=lr, rulecolor=\color{blue!80!black}} \lstdefinestyle{sharpc}{language=[Sharp]C, frame=lr, rulecolor=\color{blue!80!black}}
@ -19,33 +20,34 @@
\subsection{Goal of project} \subsection{Goal of project}
Creating an analogy in form of a real time strategy game to operating system processes and how they function. \\ Creating an analogy in form of a real time strategy game to operating system processes and how they function. \\
Each soldier in our game will represent a process which can receive and send signals from and to "the general" (player), soldiers communicate with each other, exchange information, divide resources among themselves and work together to achieve a goal or set of goals. \\ Each soldier in our game will represent a process which can receive and send signals from and to "the general" (player), soldiers communicate with each other, exchange information, divide resources among themselves and work together to achieve a goal or set of goals. \\
We will focus mainly on the parts of the game which represent how processes work in operating systems first, then on how the game actually looks and works We will focus on the parts of the game which represent how processes work in operating systems first, then on how the game actually looks and works
\subsection{Tools} \subsection{Tools}
We will use Unity Game Engine, for simplicity sake we will use Mono-behaviours on prefabs of the soldiers. This is not the most optimal solution but it is easy enough to implement in realistic (one month) time. \\ We will use the Unity Game Engine, for simplicity's sake we will use Mono-behaviours on prefabs to represent the soldiers. This is not the most performant solution but it is easy enough to implement in realistic (one month) timeframe.\\
When it comes to more detailed usage of different tools to accomplish different goals all of them will come up as the project progresses and we will actually work on the tasks. When it comes to more detailed usage of different tools to accomplish different goals all of them will come up as the project progresses and we actually work on the tasks.
\subsection{Dividing Tasks} \subsection{Dividing Tasks}
Every week our group will meet on Monday at 12:00 and work for approximately 3 hours. This ensures that everybody does similar amount of work. \\ Every week our group will meet on Monday at 12:00 and work for approximately 3 hours. This will ensure that everybody does a similar amount of work. \\
Dividing tasks will be done using trello before or at the beginning of the weekly meeting. Task division will be done using Trello before or at the beginning of the weekly meeting.
\newpage \newpage
\subsection{Workflow} \subsection{Workflow}
We use gitlab hosted on studia elka servers. There are 3 types of branches in our project: We use gitlab hosted on studia elka servers. There are 3 types of branches in our project:
\begin{enumerate} \begin{enumerate}
\item Main - Rarely used, hosting only stable versions of the game \item Main - Rarely used, hosting stable versions of the game
\item Development - Branch where we merge all individual branches and actively change on weekly basis. \item Development - Branch where we merge all individual branches and actively change on weekly basis.
\item Individual branches - Created for each task and merged when this task is finished \item Individual branches - Created for each task and merged when this task is finished
\end{enumerate} \end{enumerate}
We also use separate scenes on which we will work for each member of the project. \\ We also use separate scenes on which we will work for each member of the project. \\
Branching and separate scenes minimize the risk of corrupted gitlab project and simplifies merging and management of the project. Branching and separate scenes minimize the risk of corrupting the gitlab project and simplifies merging and management of the project.
\section{Goals} \section{Goals}
\subsection{Minimum Viable Product} \subsection{Minimum Viable Product}
This is a minimum goal we want to achieve in order to consider this project as finished \\ This is a minimum goal we want to achieve in order to consider this project as finished \\
\paragraph{Goal of the game} Destroying enemy base, for sake of simplicity enemy base is just enemy "soldier" without option to attack, move and bigger health points. Destroying means reducing health points to zero. \paragraph{Goal of the game} Destroying enemy base.
\paragraph{Realization of goal} Attacking the base with our soldiers. For simplicity's sake, the enemy base is just a "soldier" without the ability to attack or move, with more health points. "Base destruction" is accomplished by reducing its health points to zero.
\paragraph{Realization of the goal} Attacking the base with our soldiers.
\paragraph{Map} \paragraph{Map}
Map is divided into tiles Map is divided into tiles
@ -63,16 +65,16 @@ Soldiers have following attributes:
\item Damage per attack \item Damage per attack
\item Speed of attack \item Speed of attack
\end{itemize} \end{itemize}
We decided to split range of attack and range of view since combining them can lead to difficult code problems to entangle should we reach higher level of our project. \\ We have decided to split range of attack and range of view since combining them may lead to difficult code problems to solve should we reach higher level(s) of our project. \\
Soldiers take physical space - a tile \\ Soldiers occupy physical space - a tile \\
\subsubsection{Soldiers Communication} \subsubsection{Soldiers Communication}
Soldiers receive global orders from the player but they use their local vision to fulfill those orders. (For example by looking at where their neighbours stand and adjust to that. Used to simulate communication between operating system and processes. \\ Soldiers receive global orders from the player but they use their local vision to fulfill those orders. (For example by looking at where their neighbours stand and adjust their position accordingly). Used to simulate communication between operating system and processes. \\
In order to communicate something to the whole squad (like killing enemy soldier), the soldier sends communicate to neighbours soldiers which further distribute this info to the whole squad. This is used to simulate processes communicating with each other. \\ In order to communicate something to the whole squad (like killing of an enemy soldier), the soldiers sends a message to its neighbours, causing the info to be distributed to the whole squad immediately
Every tick a single (topmost) action from the Soldier's action stack is executed \\ This is used to simulate processes communicating with each other. \\
Each soldier has its own Action "stack". Every tick a single (topmost) action from the Soldier's Action stack is executed
\\ \\
Every soldier has its own "stack" of actions, each tick he does one action from the top of the stack \\ There are process interrupts sent by the player which force the soldier to perform a special action instead of executing what is on the action stack.
There are process interrupts send by the player which force the soldier to do something regardless of what he has on stack.
\subsection{Squads} \subsection{Squads}
Exactly one squad on map \\ Exactly one squad on map \\
@ -84,8 +86,8 @@ class Squad{
\end{lstlisting} \end{lstlisting}
\subsection{Fighting} \subsection{Fighting}
If the enemy is in rage of attack we attack \\ If an enemy is within a Soldier's attack range, the Soldier will perform an "attack" action\\
Attack means that the closest enemy to the soldier, receives damage (which means that his health gets decreased) accordingly to the soldier stats) "Attack" means that the closest enemy to the soldier, receives damage (which means that its health gets decreased, accordingly to the soldier stats)
\subsubsection{Player} \subsubsection{Player}
Player orders are first in priority for soldiers, (like interrupt signals) \\ Player orders are first in priority for soldiers, (like interrupt signals) \\
@ -99,11 +101,11 @@ No AI \\
\subsection{Expansion 1} \subsection{Expansion 1}
This is what we would like to introduce should we finish MVP. We mostly focused This is what we would like to introduce should we finish MVP. We mostly focused
on operating systems and processes related features. \\ on operating systems and processes related features. \\
Expansion 1 eeans that those are first features in prority we would like to Expansion 1 means that those are first priority features we would like to
implement after finishing minimum viable product. implement after finishing minimum viable product.
\subsubsection{Fighting} \subsubsection{Fighting}
Priority points regarding who should soldier attack based on distance from the Priority points determining who the soldiers should attack based on distance from the
enemy, how many friendly soldiers are near or the enemy health. \\ enemy, how many friendly soldiers are nearby or the enemy health. \\
Soldiers automatically get in fighting distance to enemy soldiers \\ Soldiers automatically get in fighting distance to enemy soldiers \\
When soldier sees enemy he communicates so to the squad and the whole squad goes towards enemy When soldier sees enemy he communicates so to the squad and the whole squad goes towards enemy
@ -124,7 +126,7 @@ If there is at least one living soldier in a squad he will send every \textit{x}
Symbolically player sees different color outlines of the squads based on whether they send statistics or not Symbolically player sees different color outlines of the squads based on whether they send statistics or not
\subsection{Expansion 2} \subsection{Expansion 2}
Expansion 2 means that those are second features in prority we would like to Expansion 2 means that those are second priority features we would like to
implement after finishing minimum viable product AND expansion 1 implement after finishing minimum viable product AND expansion 1
Creating soldiers in the main base and spawning them near the base in a new squad. \\ Creating soldiers in the main base and spawning them near the base in a new squad. \\
Soldiers have limited resources (as in limited memory and CPU power) \\ Soldiers have limited resources (as in limited memory and CPU power) \\