From 0df42b1e35603dc127be488e9d79b29d0631df4d Mon Sep 17 00:00:00 2001 From: Max-001 <80035972+Max-001@users.noreply.github.com> Date: Fri, 6 Sep 2024 11:33:41 +0200 Subject: added project lessons --- time.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/time.txt b/time.txt index c24e2eb..ad24354 100644 --- a/time.txt +++ b/time.txt @@ -8,6 +8,8 @@ loek: 2024-09-04 45m repository scaffolding / visual studio code latex configura loek: 2024-09-04 20m repository scaffolding / visual studio code cmake configuration loek: 2024-09-05 15m repository scaffolding / additional latex contributing guidelines +max: 2024-09-02 1h30m project kickoff +max: 2024-09-03 1h30m project lesson max: 2024-09-04 1h30m installing and configuring latex max: 2024-09-04 2h reading project info max: 2024-09-05 20m discussing GitHub with Jaro -- cgit v1.2.3 From c6e647b81ce1077b885d9a18d53a651cffcb9432 Mon Sep 17 00:00:00 2001 From: Max-001 <80035972+Max-001@users.noreply.github.com> Date: Fri, 6 Sep 2024 16:42:05 +0200 Subject: added tasks --- time.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/time.txt b/time.txt index b9d44e7..2ce10e4 100644 --- a/time.txt +++ b/time.txt @@ -17,6 +17,7 @@ max: 2024-09-04 1h30m installing and configuring latex max: 2024-09-04 2h reading project info max: 2024-09-05 20m discussing GitHub with Jaro max: 2024-09-05 1h30m first group meeting +max: 2024-09-06 45m writing email and fixing clang-format/-tidy wouter: 2024-09-03 1h reading project info wouter: 2024-09-04 1h setting up working environment -- cgit v1.2.3 From cbe83a7e0de75bf452bb514c025598382866d4ca Mon Sep 17 00:00:00 2001 From: Max-001 <80035972+Max-001@users.noreply.github.com> Date: Mon, 9 Sep 2024 17:54:54 +0200 Subject: added new tasks --- time.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/time.txt b/time.txt index e686608..1bf9987 100644 --- a/time.txt +++ b/time.txt @@ -19,6 +19,7 @@ max: 2024-09-04 2h reading project info max: 2024-09-05 20m discussing GitHub with Jaro max: 2024-09-05 1h30m first group meeting max: 2024-09-06 45m writing email and fixing clang-format/-tidy +max: 2024-09-09 3h10m investigating Unity (in relation to the class diagram) wouter: 2024-09-02 1h project meeting :: project kickoff wouter: 2024-09-02 45m project meeting -- cgit v1.2.3 From e2129e31d57eb6967094e26960e59256c1f9dbab Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Tue, 10 Sep 2024 13:13:46 +0200 Subject: add comparison environment + more example LaTeX code --- comparison.sty | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ example.tex | 27 +++++++++++++++++++- projdoc.cls | 1 + 3 files changed, 107 insertions(+), 1 deletion(-) create mode 100644 comparison.sty diff --git a/comparison.sty b/comparison.sty new file mode 100644 index 0000000..d10f95f --- /dev/null +++ b/comparison.sty @@ -0,0 +1,80 @@ +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{comparison}[2024-01-19 package comparison] + +\RequirePackage{booktabs} +\RequirePackage{etoolbox} +\RequirePackage{tabularx} +\RequirePackage{environ} +\RequirePackage{enumitem} + +% comparison environment, usage: +% +% \begin{comparison} +% \pro{reason why thing is good} +% \pro{...} +% \con{reason why thing is bad} +% \con{...} +% \end{comparison} +% +% output: +% +% Pros (2) Cons (2) +% ---------------------------------------------------------- +% - reason why thing is good - reason why thing is bad +% - ... - ... +% + +\newcounter{pro-count} +\newcounter{pro-index} +\newcounter{con-count} +\newcounter{con-index} +\newcounter{cmp-count} +\newcounter{cmp-index} +\NewEnviron{comparison}{% + \par% + \setcounter{pro-count}{0}% + \newcommand{\pro}[1]{% + \stepcounter{pro-count}% + \csdef{pro-\the\value{pro-count}}{##1}% + }% + \setcounter{con-count}{0}% + \newcommand{\con}[1]{% + \stepcounter{con-count}% + \csdef{con-\the\value{con-count}}{##1}% + }% + \BODY% + \def\spacing{3mm}% + \newcommand{\halfbox}[1]{% + \begin{minipage}[t]{\dimexpr(\linewidth - \spacing) / 2\relax}% + ##1% + \end{minipage}% + }% + \begin{minipage}{\linewidth}% + \halfbox{\strut\centering\textsc{Benefits}~(\the\value{pro-count})\strut}% + \hfill% + \halfbox{\strut\centering\textsc{Drawbacks}~(\the\value{con-count})\strut}% + \par% + \vspace*{\dimexpr-\parskip-0.5\baselineskip\relax}% + \noindent\rule{\linewidth}{0.66pt}\par% + \vspace*{\dimexpr-\parskip\relax}% + \halfbox{% + \begin{itemize}[leftmargin=5mm]% + \setcounter{pro-index}{0}% + \whileboolexpr{test{\ifnumcomp{\value{pro-index}}{<}{\value{pro-count}}}}{% + \stepcounter{pro-index}% + \item \csuse{pro-\the\value{pro-index}}% + }% + \end{itemize}% + }\hfill\halfbox{% + \begin{itemize}[leftmargin=5mm]% + \setcounter{con-index}{0}% + \whileboolexpr{test{\ifnumcomp{\value{con-index}}{<}{\value{con-count}}}}{% + \stepcounter{con-index}% + \item \csuse{con-\the\value{con-index}}% + }% + \end{itemize}% + }% + \end{minipage}% + \par% +} + diff --git a/example.tex b/example.tex index 8525973..ce45f6f 100644 --- a/example.tex +++ b/example.tex @@ -108,7 +108,7 @@ The \codeinline{blockcode} environment can be used to insert a code block: This is all included verbatim: \verb|asdf| \ $%!(*@#&)$ \end{blockcode} -\subsection{Lists} +\subsection{Information dumps} Unordered (bullet) list: @@ -136,9 +136,34 @@ Numbered list: (See \cref{item:enum-nest-ref}) +Description: + +\begin{description} + \item[Item one] description of item one + \item[Item two] description of item two + \item[Item three] ... +\end{description} + +\subsection{Comparisons} + +\begin{comparison} + \pro{Good thing} + \con{Bad thing} + \pro{Good thing 2} + \con{Bad thing 2} +\end{comparison} + \subsection{Citations} Citations are inserted using the \codeinline{\autocite} command \autocite{rfc:3339}. +The bibliography is automatically printed after \codeinline{\end{document}}. + +\subsection{Glossary} + +Glossary entries can be inserted using the \codeinline{\gls} commands. Example: +``\Gls{sdl2} handles \glspl{hid} as well!''. In following occurrences of acronyms, +only their short form is printed: `\gls{sdl2}' and `\gls{hid}'. All of these link to +the glossary that is automatically printed after \codeinline{\end{document}}. \end{document} diff --git a/projdoc.cls b/projdoc.cls index 503f049..388f901 100644 --- a/projdoc.cls +++ b/projdoc.cls @@ -57,6 +57,7 @@ \RequirePackage{enumitem} \RequirePackage{subcaption} \RequirePackage{multicol} +\RequirePackage{comparison} % ./comparison.sty % font style \setmainfont{TeX Gyre Schola} -- cgit v1.2.3 From 5cda6efa88659b3ce3c7931e1213e23f1140533d Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Tue, 10 Sep 2024 13:48:07 +0200 Subject: update time --- time.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/time.txt b/time.txt index db345f3..671ea4f 100644 --- a/time.txt +++ b/time.txt @@ -17,6 +17,7 @@ loek: 2024-09-09 25m documentation style guide loek: 2024-09-10 1h55m project meeting loek: 2024-09-10 25m briefing :: watch bob videos loek: 2024-09-10 5m docs :: update readme +loek: 2024-09-10 12m docs :: add comparison package and more example latex code max: 2024-09-02 1h project meeting :: project kickoff max: 2024-09-02 45m project meeting -- cgit v1.2.3 From 50c5a9057ed43ff6d363e5f74ffc78e83eb40288 Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Tue, 10 Sep 2024 15:00:18 +0200 Subject: update time.txt --- time.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/time.txt b/time.txt index 671ea4f..2323f20 100644 --- a/time.txt +++ b/time.txt @@ -18,6 +18,7 @@ loek: 2024-09-10 1h55m project meeting loek: 2024-09-10 25m briefing :: watch bob videos loek: 2024-09-10 5m docs :: update readme loek: 2024-09-10 12m docs :: add comparison package and more example latex code +loek: 2024-09-10 30m project meeting max: 2024-09-02 1h project meeting :: project kickoff max: 2024-09-02 45m project meeting -- cgit v1.2.3 From ef1c7e56de6c9083614b53d6645883c371775b22 Mon Sep 17 00:00:00 2001 From: Max-001 <80035972+Max-001@users.noreply.github.com> Date: Wed, 11 Sep 2024 16:07:58 +0200 Subject: added new tasks and deleted :: at some places (as dicussed during team meeting) --- time.txt | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/time.txt b/time.txt index 1bf9987..2d7a181 100644 --- a/time.txt +++ b/time.txt @@ -12,14 +12,19 @@ loek: 2024-09-05 1h40m project meeting loek: 2024-09-05 1h24m time report script loek: 2024-09-06 55m time report script -max: 2024-09-02 1h project meeting :: project kickoff -max: 2024-09-02 45m project meeting +max: 2024-09-02 1h project kickoff +max: 2024-09-02 45m first project meeting +max: 2024-09-03 1h30m first project lesson max: 2024-09-04 1h30m installing and configuring latex max: 2024-09-04 2h reading project info max: 2024-09-05 20m discussing GitHub with Jaro -max: 2024-09-05 1h30m first group meeting +max: 2024-09-05 1h30m second project meeting max: 2024-09-06 45m writing email and fixing clang-format/-tidy max: 2024-09-09 3h10m investigating Unity (in relation to the class diagram) +max: 2024-09-10 1h30m third project meeting +max: 2024-09-10 20m discussing about class diagram +max: 2024-09-10 40m second project lesson (one-to-one meeting with Bob) +max: 2024-09-11 1h50m first review of Jaro's Plan document wouter: 2024-09-02 1h project meeting :: project kickoff wouter: 2024-09-02 45m project meeting -- cgit v1.2.3 From 37cd579403c86833d3fdb6ebe7f3cd2235649b27 Mon Sep 17 00:00:00 2001 From: WBoerenkamps Date: Thu, 12 Sep 2024 13:00:55 +0200 Subject: changed some research headers and added time --- research.tex | 31 +++++++++++++++++++++++++------ time.txt | 2 ++ 2 files changed, 27 insertions(+), 6 deletions(-) diff --git a/research.tex b/research.tex index ca2afed..7ae6856 100644 --- a/research.tex +++ b/research.tex @@ -152,7 +152,7 @@ for audio some options could be: FMOD, Wwise, or iirKlang \subsection{Conclusion} -\section{Gameloop/resource manager} +\section{Resource manager} \subsection{Introduction} @@ -168,7 +168,7 @@ for audio some options could be: FMOD, Wwise, or iirKlang \subsection{Conclusion} -\section{Event manager} +\section{Event manager/game loop} \subsection{Introduction} @@ -176,7 +176,7 @@ for audio some options could be: FMOD, Wwise, or iirKlang \subsection{Conclusion} -\section{Memory/debugging} +\section{Profiling/debugging} \subsection{Introduction} @@ -184,7 +184,7 @@ for audio some options could be: FMOD, Wwise, or iirKlang \subsection{Conclusion} -\section{Physics/scripting} +\section{Physics} \subsection{Introduction} @@ -192,16 +192,35 @@ for audio some options could be: FMOD, Wwise, or iirKlang \subsection{Conclusion} -\section{Conclusion} +\section{Scripting} + +\subsection{Introduction} + +\subsection{Findings} + +\subsection{Conclusion} +\section{Audio} + +\subsection{Introduction} + +\subsection{Findings} + +\subsection{Conclusion} \section{Gameobjects/components} \subsection{Introduction} +\subsection{Findings} +\subsection{Conclusion} +\section{AI} + +\subsection{Introduction} + \subsection{Findings} \subsection{Conclusion} -\section{Conclusion} +\section{Conclusion} \end{document} diff --git a/time.txt b/time.txt index db345f3..dbf3107 100644 --- a/time.txt +++ b/time.txt @@ -33,6 +33,8 @@ wouter: 2024-09-04 1h30m researching 3rd party tools wouter: 2024-09-05 1h30m first group meeting wouter: 2024-09-05 20m setting up research document wouter: 2024-09-05 1h researching game enigne +wouter: 2024-09-06 3h researching game enigne +wouter: 2024-09-09 2h researching SDL and SFML2 niels: 2024-09-02 1h project meeting :: project kickoff niels: 2024-09-02 45m project meeting -- cgit v1.2.3 From 541e851ad1d704598f6c6286c9007b3d94e81fb1 Mon Sep 17 00:00:00 2001 From: Max-001 <80035972+Max-001@users.noreply.github.com> Date: Thu, 12 Sep 2024 16:48:24 +0200 Subject: added new task --- time.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/time.txt b/time.txt index d7f1fbf..6158bc5 100644 --- a/time.txt +++ b/time.txt @@ -33,6 +33,7 @@ max: 2024-09-10 1h30m third project meeting max: 2024-09-10 20m discussing about class diagram max: 2024-09-10 40m second project lesson (one-to-one meeting with Bob) max: 2024-09-11 1h50m first review of Jaro's Plan document +max: 2024-09-12 1h trying to fix LaTeX and VS code settings wouter: 2024-09-02 1h project meeting :: project kickoff wouter: 2024-09-02 45m project meeting -- cgit v1.2.3 From 4de2d802fcca20c4759e3bf1ce269dbee9c03b8a Mon Sep 17 00:00:00 2001 From: Max-001 <80035972+Max-001@users.noreply.github.com> Date: Thu, 12 Sep 2024 17:08:36 +0200 Subject: Started GameObjects section --- research.tex | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/research.tex b/research.tex index ca2afed..9f95428 100644 --- a/research.tex +++ b/research.tex @@ -195,11 +195,10 @@ for audio some options could be: FMOD, Wwise, or iirKlang \section{Conclusion} \section{Gameobjects/components} - \subsection{Introduction} - +One of the requirements of our customer, is that the game engine's structure is similar to Unity. The customer has created a class diagram of the game engine's API, which is (of course) very similar to Unity. One of the most important parts of the class diagram is a so-called gameObject (with several components). It's needed to understand the exact meaning/function of these gameObjects, that's why this research question arose. \subsection{Findings} - +A gameObject itself does/is nothing. \subsection{Conclusion} \section{Conclusion} -- cgit v1.2.3 From f7f4849f1ca92f3b0689e4eacb60291d1306d865 Mon Sep 17 00:00:00 2001 From: Max-001 <80035972+Max-001@users.noreply.github.com> Date: Thu, 12 Sep 2024 17:44:58 +0200 Subject: Worked on gameObject research --- research.tex | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/research.tex b/research.tex index 9f95428..8f368a1 100644 --- a/research.tex +++ b/research.tex @@ -198,7 +198,15 @@ for audio some options could be: FMOD, Wwise, or iirKlang \subsection{Introduction} One of the requirements of our customer, is that the game engine's structure is similar to Unity. The customer has created a class diagram of the game engine's API, which is (of course) very similar to Unity. One of the most important parts of the class diagram is a so-called gameObject (with several components). It's needed to understand the exact meaning/function of these gameObjects, that's why this research question arose. \subsection{Findings} -A gameObject itself does/is nothing. +A gameObject is the most important concept in Unity. Every object in a game is a GameObject, from characters and collectible items to the lights, cameras and special effects. However, a gameObject itself can't do anything on its own. A gameObject needs to be given properties before it can become a character, an envirnment, or a special effect. https://docs.unity3d.com/Manual/GameObjects.html + +A gameObject can be seen as a container for components. Components are the properties of the gameObject. A few examples of components are sprites, animators, audioSources, and so on. Multiple (different) components can be assigned to a single gameObject (e.g. a sprite and an audioSource). + +Since we now know that a gameObject needs components to do something, it's obvious that there should be a way to add components to a gameObject. Some components (e.g. the behaviorScript component) should also be able to reference to its gameObject. + +Each gameObject always has one transform class. The transform class describes the position, rotation, and scale within the scene. Some component use this information to e.g. scale a sprite. Other components eddit this information to e.g. model gravity. https://docs.unity3d.com/Manual/class-Transform.html + +A gameObject can have one (or multiple) children gameObject(s). All children gameObjects, of course, also have one transform class. However, the position, rotation, and scale of this class, is always the same as the child's parent. A child can not have more than one parent. https://docs.unity3d.com/Manual/class-Transform.html \subsection{Conclusion} \section{Conclusion} -- cgit v1.2.3 From 4035609492877364e90e14e6a8c59c4424ddee64 Mon Sep 17 00:00:00 2001 From: Max-001 <80035972+Max-001@users.noreply.github.com> Date: Thu, 12 Sep 2024 17:47:34 +0200 Subject: worked on gameObject research --- time.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/time.txt b/time.txt index 6158bc5..c9f5261 100644 --- a/time.txt +++ b/time.txt @@ -34,6 +34,7 @@ max: 2024-09-10 20m discussing about class diagram max: 2024-09-10 40m second project lesson (one-to-one meeting with Bob) max: 2024-09-11 1h50m first review of Jaro's Plan document max: 2024-09-12 1h trying to fix LaTeX and VS code settings +max: 2024-09-12 1h worked on gameObject research wouter: 2024-09-02 1h project meeting :: project kickoff wouter: 2024-09-02 45m project meeting -- cgit v1.2.3 From 7ecc34231fb20951cdafb083b909cf133e84c610 Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Thu, 12 Sep 2024 19:51:42 +0200 Subject: update time.txt --- time.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/time.txt b/time.txt index dd12eb5..eb25c7e 100644 --- a/time.txt +++ b/time.txt @@ -19,6 +19,7 @@ loek: 2024-09-10 25m briefing :: watch bob videos loek: 2024-09-10 5m docs :: update readme loek: 2024-09-10 12m docs :: add comparison package and more example latex code loek: 2024-09-10 30m project meeting +loek: 2024-09-12 15m integration :: PR merge max: 2024-09-02 1h project kickoff max: 2024-09-02 45m first project meeting -- cgit v1.2.3 From 5a1f278d794d19be143b3a2e5059fdf0b1d7db66 Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Fri, 13 Sep 2024 10:03:11 +0200 Subject: revert line wrapping options in vscode config --- .vscode/settings.json | 3 --- 1 file changed, 3 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 25effcc..4a05df8 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,7 +1,4 @@ { - "editor.wordWrap": "wordWrapColumn", - "editor.wrappingIndent": "same", - "editor.wordWrapColumn": 85, "files.trimTrailingWhitespace": true, "latex-workshop.latex.recipe.default": "latexmk", "latex-workshop.latex.tools": [ -- cgit v1.2.3 From f62aa77892f22868f204dd777ae5a45eb64460fb Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Fri, 13 Sep 2024 10:05:40 +0200 Subject: add latex workshop to extensions.json --- .vscode/extensions.json | 1 + 1 file changed, 1 insertion(+) diff --git a/.vscode/extensions.json b/.vscode/extensions.json index e2e2139..1ce5b20 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -1,5 +1,6 @@ { "recommendations": [ + "James-Yu.latex-workshop", "EditorConfig.EditorConfig" ] } -- cgit v1.2.3