From 0c25c5f869afe4f4ac3736c218f3bb30fe26a3f4 Mon Sep 17 00:00:00 2001 From: WBoerenkamps Date: Fri, 6 Sep 2024 09:29:35 +0200 Subject: added research document --- research.tex | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 research.tex diff --git a/research.tex b/research.tex new file mode 100644 index 0000000..7a0e7d1 --- /dev/null +++ b/research.tex @@ -0,0 +1,23 @@ +\documentclass{projdoc} +\input{meta.tex} + +\title{Research document} + +\begin{document} +\tablestables +\section{Introduction} +\section{Game engine} + \subsection{Introduction} + To build a game engine it must first be known how it works. + Which functionalities it must have and how these functionalities work together. + this section describes the general functioning of a game engine and the different parts required. + \subsection{Findings} + \subsection{Conclusion} + +\section{3rd party tools} +\subsection{Introduction} +\subsection{Findings} +\subsection{Conclusion} +\section{Conclusion} +\end{document} + -- cgit v1.2.3 From 6eadb4b8282b23d51193090bf25c803b8e5e3277 Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Fri, 6 Sep 2024 12:41:25 +0200 Subject: add project kickoff & first meeting to everyone's time --- time.txt | 12 +++++++++--- time2tex.py | 2 +- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/time.txt b/time.txt index 7fd0bc3..ebd4d3b 100644 --- a/time.txt +++ b/time.txt @@ -1,4 +1,5 @@ -# : +loek: 2024-09-02 1h project meeting :: project kickoff +loek: 2024-09-02 45m project meeting loek: 2024-09-02 1h4m repository scaffolding loek: 2024-09-03 25m repository scaffolding loek: 2024-09-03 1h30m repository scaffolding :: engine repository, unit testing @@ -11,11 +12,15 @@ 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-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 +wouter: 2024-09-02 1h project meeting :: project kickoff +wouter: 2024-09-02 45m project meeting wouter: 2024-09-03 1h reading project info wouter: 2024-09-04 1h setting up working environment wouter: 2024-09-04 1h30m researching 3rd party tools @@ -23,6 +28,8 @@ 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 +niels: 2024-09-02 1h project meeting :: project kickoff +niels: 2024-09-02 45m project meeting niels: 2024-09-03 1h reading project info niels: 2024-09-04 30m validation app ideas niels: 2024-09-04 2h setting up vimtex on neovim @@ -30,7 +37,7 @@ niels: 2024-09-04 1h researching different code styles and c++ guidelines niels: 2024-09-05 1h30m first group meeting niels: 2024-09-06 2h added c++ guidelines in the contributing.md -jaro: 2024-09-02 1h project kickoff +jaro: 2024-09-02 1h project meeting :: project kickoff jaro: 2024-09-02 45m project meeting jaro: 2024-09-02 1h45m scrumboard(miro), installing dependencies jaro: 2024-09-04 4h15m latex environment, code environment and project plan @@ -38,5 +45,4 @@ jaro: 2024-09-05 2h preparing meeting, project plan, discussing github with max jaro: 2024-09-05 1h30m project meeting jaro: 2024-09-05 1h documentatie review and improving environment - # vim:ft=cfg diff --git a/time2tex.py b/time2tex.py index 1d0cd90..fe3091f 100755 --- a/time2tex.py +++ b/time2tex.py @@ -87,7 +87,7 @@ def fmt_weekly_overview(times): # begin table out += r"\begin{table}\centering" out += f"\\begin{{tabular}}{{l{'r@{~}l' * len(members)}@{{\\qquad}}r}}\\toprule" - out += r"\textbf{Week\#}" + out += r"\textbf{\#}" for member in members: out += f"&\\textbf{{{member}}}&" out += r"&\textbf{Subtotal}\\\midrule{}" -- cgit v1.2.3 From 0b4cc3410c327a843c127ec732d60ca6124742d5 Mon Sep 17 00:00:00 2001 From: WBoerenkamps Date: Sun, 8 Sep 2024 11:28:18 +0200 Subject: added information about game engine and ECS and created some research questions --- research.bbl-SAVE-ERROR | 20 + research.bcf-SAVE-ERROR | 2384 +++++++++++++++++++++++++++++++++++++++++++++++ research.tex | 72 +- timerep.bcf-SAVE-ERROR | 2384 +++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 4853 insertions(+), 7 deletions(-) create mode 100644 research.bbl-SAVE-ERROR create mode 100644 research.bcf-SAVE-ERROR create mode 100644 timerep.bcf-SAVE-ERROR diff --git a/research.bbl-SAVE-ERROR b/research.bbl-SAVE-ERROR new file mode 100644 index 0000000..005f385 --- /dev/null +++ b/research.bbl-SAVE-ERROR @@ -0,0 +1,20 @@ +% $ biblatex auxiliary file $ +% $ biblatex bbl format version 3.2 $ +% Do not modify the above lines! +% +% This is an auxiliary file used by the 'biblatex' package. +% This file may safely be deleted. It will be recreated by +% biber as required. +% +\begingroup +\makeatletter +\@ifundefined{ver@biblatex.sty} + {\@latex@error + {Missing 'biblatex' package} + {The bibliography requires the 'biblatex' package.} + \aftergroup\endinput} + {} +\endgroup + +\endinput + diff --git a/research.bcf-SAVE-ERROR b/research.bcf-SAVE-ERROR new file mode 100644 index 0000000..d36ea3a --- /dev/null +++ b/research.bcf-SAVE-ERROR @@ -0,0 +1,2384 @@ + + + + + + output_encoding + utf8 + + + input_encoding + utf8 + + + debug + 0 + + + mincrossrefs + 2 + + + minxrefs + 2 + + + sortcase + 1 + + + sortupper + 1 + + + + + + + alphaothers + + + + + extradatecontext + labelname + labeltitle + + + labelalpha + 0 + + + labelnamespec + shortauthor + author + shorteditor + editor + translator + + + labeltitle + 0 + + + labeltitlespec + shorttitle + title + maintitle + + + labeltitleyear + 0 + + + labeldateparts + 0 + + + labeldatespec + origdate + date + year + dateaddon + eventdate + nodate + + + julian + 0 + + + gregorianstart + 1582-10-15 + + + maxalphanames + 3 + + + maxbibnames + 99 + + + maxcitenames + 99 + + + maxsortnames + 99 + + + maxitems + 3 + + + minalphanames + 1 + + + minbibnames + 1 + + + mincitenames + 1 + + + minsortnames + 1 + + + minitems + 1 + + + nohashothers + 0 + + + noroman + 0 + + + nosortothers + 0 + + + pluralothers + 0 + + + singletitle + 0 + + + skipbib + 0 + + + skipbiblist + 0 + + + skiplab + 0 + + + sortalphaothers + + + + + sortlocale + english + + + sortingtemplatename + none + + + sortsets + 0 + + + uniquelist + false + + + uniquename + false + + + uniqueprimaryauthor + 0 + + + uniquetitle + 0 + + + uniquebaretitle + 0 + + + uniquework + 0 + + + useprefix + 0 + + + useafterword + 1 + + + useannotator + 1 + + + useauthor + 1 + + + usebookauthor + 1 + + + usecommentator + 1 + + + useeditor + 1 + + + useeditora + 1 + + + useeditorb + 1 + + + useeditorc + 1 + + + useforeword + 1 + + + useholder + 1 + + + useintroduction + 1 + + + usenamea + 1 + + + usenameb + 1 + + + usenamec + 1 + + + usetranslator + 0 + + + useshortauthor + 1 + + + useshorteditor + 1 + + + usesupervisor + 1 + + + + + + extradatecontext + labelname + labeltitle + + + labelalpha + 0 + + + labelnamespec + holder + shortauthor + author + shorteditor + editor + translator + + + labeltitle + 0 + + + labeltitlespec + shorttitle + title + maintitle + + + labeltitleyear + 0 + + + labeldateparts + 0 + + + labeldatespec + origdate + date + year + dateaddon + eventdate + nodate + + + maxalphanames + 3 + + + maxbibnames + 99 + + + maxcitenames + 99 + + + maxsortnames + 99 + + + maxitems + 3 + + + minalphanames + 1 + + + minbibnames + 1 + + + mincitenames + 1 + + + minsortnames + 1 + + + minitems + 1 + + + nohashothers + 0 + + + noroman + 0 + + + nosortothers + 0 + + + singletitle + 0 + + + skipbib + 0 + + + skipbiblist + 0 + + + skiplab + 0 + + + uniquelist + false + + + uniquename + false + + + uniqueprimaryauthor + 0 + + + uniquetitle + 0 + + + uniquebaretitle + 0 + + + uniquework + 0 + + + useprefix + 0 + + + useafterword + 1 + + + useannotator + 1 + + + useauthor + 1 + + + usebookauthor + 1 + + + usecommentator + 1 + + + useeditor + 1 + + + useeditora + 1 + + + useeditorb + 1 + + + useeditorc + 1 + + + useforeword + 1 + + + useholder + 1 + + + useintroduction + 1 + + + usenamea + 1 + + + usenameb + 1 + + + usenamec + 1 + + + usetranslator + 0 + + + useshortauthor + 1 + + + useshorteditor + 1 + + + usesupervisor + 1 + + + + + datamodel + labelalphanametemplate + labelalphatemplate + inheritance + translit + uniquenametemplate + sortingnamekeytemplate + sortingtemplate + extradatespec + extradatecontext + labelnamespec + labeltitlespec + labeldatespec + controlversion + alphaothers + sortalphaothers + presort + texencoding + bibencoding + sortingtemplatename + sortlocale + language + autolang + langhook + indexing + hyperref + backrefsetstyle + block + pagetracker + citecounter + citetracker + ibidtracker + idemtracker + opcittracker + loccittracker + labeldate + labeltime + dateera + date + time + eventdate + eventtime + origdate + origtime + urldate + urltime + alldatesusetime + alldates + alltimes + gregorianstart + autocite + notetype + uniquelist + uniquename + refsection + refsegment + citereset + sortlos + babel + datelabel + backrefstyle + arxiv + familyinits + giveninits + prefixinits + suffixinits + useafterword + useannotator + useauthor + usebookauthor + usecommentator + useeditor + useeditora + useeditorb + useeditorc + useforeword + useholder + useintroduction + usenamea + usenameb + usenamec + usetranslator + useshortauthor + useshorteditor + usesupervisor + debug + loadfiles + safeinputenc + sortcase + sortupper + terseinits + abbreviate + dateabbrev + clearlang + sortcites + sortsets + backref + backreffloats + trackfloats + parentracker + labeldateusetime + datecirca + dateuncertain + dateusetime + eventdateusetime + origdateusetime + urldateusetime + julian + datezeros + timezeros + timezones + seconds + autopunct + punctfont + labelnumber + labelalpha + labeltitle + labeltitleyear + labeldateparts + pluralothers + nohashothers + nosortothers + noroman + singletitle + uniquetitle + uniquebaretitle + uniquework + uniqueprimaryauthor + defernumbers + locallabelwidth + bibwarn + useprefix + skipbib + skipbiblist + skiplab + dataonly + defernums + firstinits + sortfirstinits + sortgiveninits + labelyear + spacecolon + pagetotal + shortnumeration + thesisinfoinnotes + url + isbn + doi + eprint + articlepubinfo + currentlang + noenddot + bibtexcaseprotection + mincrossrefs + minxrefs + maxnames + minnames + maxbibnames + minbibnames + maxcitenames + mincitenames + maxsortnames + minsortnames + maxitems + minitems + maxalphanames + minalphanames + maxparens + dateeraauto + + + alphaothers + sortalphaothers + presort + indexing + citetracker + ibidtracker + idemtracker + opcittracker + loccittracker + uniquelist + uniquename + familyinits + giveninits + prefixinits + suffixinits + useafterword + useannotator + useauthor + usebookauthor + usecommentator + useeditor + useeditora + useeditorb + useeditorc + useforeword + useholder + useintroduction + usenamea + usenameb + usenamec + usetranslator + useshortauthor + useshorteditor + usesupervisor + terseinits + abbreviate + dateabbrev + clearlang + labelnumber + labelalpha + labeltitle + labeltitleyear + labeldateparts + nohashothers + nosortothers + noroman + singletitle + uniquetitle + uniquebaretitle + uniquework + uniqueprimaryauthor + useprefix + skipbib + skipbiblist + skiplab + dataonly + skiplos + labelyear + bibtexcaseprotection + labelalphatemplate + translit + sortexclusion + sortinclusion + extradatecontext + labelnamespec + labeltitlespec + labeldatespec + maxnames + minnames + maxbibnames + minbibnames + maxcitenames + mincitenames + maxsortnames + minsortnames + maxitems + minitems + maxalphanames + minalphanames + + + noinherit + nametemplates + labelalphanametemplatename + uniquenametemplatename + sortingnamekeytemplatename + presort + indexing + citetracker + ibidtracker + idemtracker + opcittracker + loccittracker + uniquelist + uniquename + familyinits + giveninits + prefixinits + suffixinits + useafterword + useannotator + useauthor + usebookauthor + usecommentator + useeditor + useeditora + useeditorb + useeditorc + useforeword + useholder + useintroduction + usenamea + usenameb + usenamec + usetranslator + useshortauthor + useshorteditor + usesupervisor + terseinits + abbreviate + dateabbrev + clearlang + labelnumber + labelalpha + labeltitle + labeltitleyear + labeldateparts + nohashothers + nosortothers + noroman + singletitle + uniquetitle + uniquebaretitle + uniquework + uniqueprimaryauthor + useprefix + skipbib + skipbiblist + skiplab + dataonly + skiplos + bibtexcaseprotection + maxnames + minnames + maxbibnames + minbibnames + maxcitenames + mincitenames + maxsortnames + minsortnames + maxitems + minitems + maxalphanames + minalphanames + + + nametemplates + labelalphanametemplatename + uniquenametemplatename + sortingnamekeytemplatename + uniquelist + uniquename + familyinits + giveninits + prefixinits + suffixinits + terseinits + nohashothers + nosortothers + useprefix + + + nametemplates + labelalphanametemplatename + uniquenametemplatename + sortingnamekeytemplatename + uniquename + familyinits + giveninits + prefixinits + suffixinits + terseinits + useprefix + + + + + + + + + + + + + + + + + + + patent + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + prefix + family + + + + + shorthand + label + labelname + labelname + + + year + + + + + + labelyear + year + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + prefix + family + given + + + + + prefix + family + + + given + + + suffix + + + prefix + + + mm + + + + sf,sm,sn,pf,pm,pn,pp + family,given,prefix,suffix + boolean,integer,string,xml + default,transliteration,transcription,translation + + + article + artwork + audio + bibnote + book + bookinbook + booklet + collection + commentary + customa + customb + customc + customd + custome + customf + dataset + inbook + incollection + inproceedings + inreference + image + jurisdiction + legal + legislation + letter + manual + misc + movie + music + mvcollection + mvreference + mvproceedings + mvbook + online + patent + performance + periodical + proceedings + reference + report + review + set + software + standard + suppbook + suppcollection + suppperiodical + thesis + unpublished + video + xdata + + + sortyear + volume + volumes + abstract + addendum + annotation + booksubtitle + booktitle + booktitleaddon + chapter + edition + eid + entrysubtype + eprintclass + eprinttype + eventtitle + eventtitleaddon + gender + howpublished + indexsorttitle + indextitle + isan + isbn + ismn + isrn + issn + issue + issuesubtitle + issuetitle + issuetitleaddon + iswc + journalsubtitle + journaltitle + journaltitleaddon + label + langid + langidopts + library + mainsubtitle + maintitle + maintitleaddon + nameaddon + note + number + origtitle + pagetotal + part + relatedstring + relatedtype + reprinttitle + series + shorthandintro + subtitle + title + titleaddon + usera + userb + userc + userd + usere + userf + venue + version + shorthand + shortjournal + shortseries + shorttitle + sorttitle + sortshorthand + sortkey + presort + institution + lista + listb + listc + listd + liste + listf + location + organization + origlocation + origpublisher + publisher + afterword + annotator + author + bookauthor + commentator + editor + editora + editorb + editorc + foreword + holder + introduction + namea + nameb + namec + translator + shortauthor + shorteditor + sortname + authortype + editoratype + editorbtype + editorctype + editortype + bookpagination + nameatype + namebtype + namectype + pagination + pubstate + type + language + origlanguage + crossref + xref + date + endyear + year + month + day + hour + minute + second + timezone + yeardivision + endmonth + endday + endhour + endminute + endsecond + endtimezone + endyeardivision + eventdate + eventendyear + eventyear + eventmonth + eventday + eventhour + eventminute + eventsecond + eventtimezone + eventyeardivision + eventendmonth + eventendday + eventendhour + eventendminute + eventendsecond + eventendtimezone + eventendyeardivision + origdate + origendyear + origyear + origmonth + origday + orighour + origminute + origsecond + origtimezone + origyeardivision + origendmonth + origendday + origendhour + origendminute + origendsecond + origendtimezone + origendyeardivision + urldate + urlendyear + urlyear + urlmonth + urlday + urlhour + urlminute + urlsecond + urltimezone + urlyeardivision + urlendmonth + urlendday + urlendhour + urlendminute + urlendsecond + urlendtimezone + urlendyeardivision + doi + eprint + file + verba + verbb + verbc + url + xdata + ids + entryset + related + keywords + options + relatedoptions + pages + execute + supervisor + dateaddon + + + abstract + annotation + authortype + bookpagination + crossref + day + doi + eprint + eprintclass + eprinttype + endday + endhour + endminute + endmonth + endsecond + endtimezone + endyear + endyeardivision + entryset + entrysubtype + execute + file + gender + hour + ids + indextitle + indexsorttitle + isan + ismn + iswc + keywords + label + langid + langidopts + library + lista + listb + listc + listd + liste + listf + minute + month + namea + nameb + namec + nameatype + namebtype + namectype + nameaddon + options + origday + origendday + origendhour + origendminute + origendmonth + origendsecond + origendtimezone + origendyear + origendyeardivision + orighour + origminute + origmonth + origsecond + origtimezone + origyear + origyeardivision + origlocation + origpublisher + origtitle + pagination + presort + related + relatedoptions + relatedstring + relatedtype + second + shortauthor + shorteditor + shorthand + shorthandintro + shortjournal + shortseries + shorttitle + sortkey + sortname + sortshorthand + sorttitle + sortyear + timezone + url + urlday + urlendday + urlendhour + urlendminute + urlendmonth + urlendsecond + urlendtimezone + urlendyear + urlhour + urlminute + urlmonth + urlsecond + urltimezone + urlyear + usera + userb + userc + userd + usere + userf + verba + verbb + verbc + xdata + xref + year + yeardivision + + + set + entryset + + + article + addendum + annotator + author + commentator + editor + editora + editorb + editorc + editortype + editoratype + editorbtype + editorctype + eid + issn + issue + issuetitle + issuesubtitle + issuetitleaddon + journalsubtitle + journaltitle + journaltitleaddon + language + note + number + origlanguage + pages + pubstate + series + subtitle + title + titleaddon + translator + version + volume + + + bibnote + note + + + book + author + addendum + afterword + annotator + chapter + commentator + edition + editor + editora + editorb + editorc + editortype + editoratype + editorbtype + editorctype + eid + foreword + introduction + isbn + language + location + maintitle + maintitleaddon + mainsubtitle + note + number + origlanguage + pages + pagetotal + part + publisher + pubstate + series + subtitle + title + titleaddon + translator + volume + volumes + + + mvbook + addendum + afterword + annotator + author + commentator + edition + editor + editora + editorb + editorc + editortype + editoratype + editorbtype + editorctype + foreword + introduction + isbn + language + location + note + number + origlanguage + pagetotal + publisher + pubstate + series + subtitle + title + titleaddon + translator + volume + volumes + + + inbook + bookinbook + suppbook + addendum + afterword + annotator + author + booktitle + bookauthor + booksubtitle + booktitleaddon + chapter + commentator + edition + editor + editora + editorb + editorc + editortype + editoratype + editorbtype + editorctype + eid + foreword + introduction + isbn + language + location + mainsubtitle + maintitle + maintitleaddon + note + number + origlanguage + part + publisher + pages + pubstate + series + subtitle + title + titleaddon + translator + volume + volumes + + + booklet + addendum + author + chapter + editor + editortype + eid + howpublished + language + location + note + pages + pagetotal + pubstate + subtitle + title + titleaddon + type + + + collection + reference + addendum + afterword + annotator + chapter + commentator + edition + editor + editora + editorb + editorc + editortype + editoratype + editorbtype + editorctype + eid + foreword + introduction + isbn + language + location + mainsubtitle + maintitle + maintitleaddon + note + number + origlanguage + pages + pagetotal + part + publisher + pubstate + series + subtitle + title + titleaddon + translator + volume + volumes + + + mvcollection + mvreference + addendum + afterword + annotator + author + commentator + edition + editor + editora + editorb + editorc + editortype + editoratype + editorbtype + editorctype + foreword + introduction + isbn + language + location + note + number + origlanguage + publisher + pubstate + subtitle + title + titleaddon + translator + volume + volumes + + + incollection + suppcollection + inreference + addendum + afterword + annotator + author + booksubtitle + booktitle + booktitleaddon + chapter + commentator + edition + editor + editora + editorb + editorc + editortype + editoratype + editorbtype + editorctype + eid + foreword + introduction + isbn + language + location + mainsubtitle + maintitle + maintitleaddon + note + number + origlanguage + pages + part + publisher + pubstate + series + subtitle + title + titleaddon + translator + volume + volumes + + + dataset + addendum + author + edition + editor + editortype + language + location + note + number + organization + publisher + pubstate + series + subtitle + title + titleaddon + type + version + + + manual + addendum + author + chapter + edition + editor + editortype + eid + isbn + language + location + note + number + organization + pages + pagetotal + publisher + pubstate + series + subtitle + title + titleaddon + type + version + + + misc + software + addendum + author + editor + editortype + howpublished + language + location + note + organization + pubstate + subtitle + title + titleaddon + type + version + + + online + addendum + author + editor + editortype + language + note + organization + pubstate + subtitle + title + titleaddon + version + + + patent + addendum + author + holder + location + note + number + pubstate + subtitle + title + titleaddon + type + version + + + periodical + addendum + editor + editora + editorb + editorc + editortype + editoratype + editorbtype + editorctype + issn + issue + issuesubtitle + issuetitle + issuetitleaddon + language + note + number + pubstate + series + subtitle + title + titleaddon + volume + yeardivision + + + mvproceedings + addendum + editor + editortype + eventday + eventendday + eventendhour + eventendminute + eventendmonth + eventendsecond + eventendtimezone + eventendyear + eventendyeardivision + eventhour + eventminute + eventmonth + eventsecond + eventtimezone + eventyear + eventyeardivision + eventtitle + eventtitleaddon + isbn + language + location + note + number + organization + pagetotal + publisher + pubstate + series + subtitle + title + titleaddon + venue + volumes + + + proceedings + addendum + chapter + editor + editortype + eid + eventday + eventendday + eventendhour + eventendminute + eventendmonth + eventendsecond + eventendtimezone + eventendyear + eventendyeardivision + eventhour + eventminute + eventmonth + eventsecond + eventtimezone + eventyear + eventyeardivision + eventtitle + eventtitleaddon + isbn + language + location + mainsubtitle + maintitle + maintitleaddon + note + number + organization + pages + pagetotal + part + publisher + pubstate + series + subtitle + title + titleaddon + venue + volume + volumes + + + inproceedings + addendum + author + booksubtitle + booktitle + booktitleaddon + chapter + editor + editortype + eid + eventday + eventendday + eventendhour + eventendminute + eventendmonth + eventendsecond + eventendtimezone + eventendyear + eventendyeardivision + eventhour + eventminute + eventmonth + eventsecond + eventtimezone + eventyear + eventyeardivision + eventtitle + eventtitleaddon + isbn + language + location + mainsubtitle + maintitle + maintitleaddon + note + number + organization + pages + part + publisher + pubstate + series + subtitle + title + titleaddon + venue + volume + volumes + + + report + addendum + author + chapter + eid + institution + isrn + language + location + note + number + pages + pagetotal + pubstate + subtitle + title + titleaddon + type + version + + + thesis + addendum + author + chapter + eid + institution + language + location + note + pages + pagetotal + pubstate + subtitle + title + titleaddon + type + + + unpublished + addendum + author + eventday + eventendday + eventendhour + eventendminute + eventendmonth + eventendsecond + eventendtimezone + eventendyear + eventendyeardivision + eventhour + eventminute + eventmonth + eventsecond + eventtimezone + eventyear + eventyeardivision + eventtitle + eventtitleaddon + howpublished + language + location + note + pubstate + subtitle + title + titleaddon + type + venue + + + thesis + supervisor + + + dateaddon + + + abstract + addendum + afterword + annotator + author + bookauthor + booksubtitle + booktitle + booktitleaddon + chapter + commentator + editor + editora + editorb + editorc + foreword + holder + institution + introduction + issuesubtitle + issuetitle + issuetitleaddon + journalsubtitle + journaltitle + journaltitleaddon + location + mainsubtitle + maintitle + maintitleaddon + nameaddon + note + organization + origlanguage + origlocation + origpublisher + origtitle + part + publisher + relatedstring + series + shortauthor + shorteditor + shorthand + shortjournal + shortseries + shorttitle + sortname + sortshorthand + sorttitle + subtitle + title + titleaddon + translator + venue + + + article + book + inbook + bookinbook + suppbook + booklet + collection + incollection + suppcollection + manual + misc + mvbook + mvcollection + online + patent + periodical + suppperiodical + proceedings + inproceedings + reference + inreference + report + set + thesis + unpublished + + + date + year + + + + + set + + entryset + + + + article + + author + journaltitle + title + + + + book + mvbook + + author + title + + + + inbook + bookinbook + suppbook + + author + title + booktitle + + + + booklet + + + author + editor + + title + + + + collection + reference + mvcollection + mvreference + + editor + title + + + + incollection + suppcollection + inreference + + author + editor + title + booktitle + + + + dataset + + title + + + + manual + + title + + + + misc + software + + title + + + + online + + title + + url + doi + eprint + + + + + patent + + author + title + number + + + + periodical + + editor + title + + + + proceedings + mvproceedings + + title + + + + inproceedings + + author + title + booktitle + + + + report + + author + title + type + institution + + + + thesis + + author + title + type + institution + + + + unpublished + + author + title + + + + + isbn + + + issn + + + ismn + + + gender + + + + + + + sources.bib + + diff --git a/research.tex b/research.tex index 7a0e7d1..3938cf1 100644 --- a/research.tex +++ b/research.tex @@ -8,16 +8,74 @@ \section{Introduction} \section{Game engine} \subsection{Introduction} - To build a game engine it must first be known how it works. - Which functionalities it must have and how these functionalities work together. - this section describes the general functioning of a game engine and the different parts required. + To build a game engine, it must first be understood how it operates. + The functionalities it requires and how these functionalities work together must be determined. + In this section, the general functioning of a game engine and the different parts required are described. \subsection{Findings} + A game engine is not the game itself but a platform with which games are built. It should provide the functionalities with which the game is constructed. + The purpose of a game engine is not to create data out of nothing. Instead, data is read, and the correlating features and effects are generated. + However, the engine is also used to create these files, referred to as "assets." The game engine must be able to accept a certain format of these assets—whether levels, sprites, or textures—and convert them into usable data. + \subsubsection{Layers} + A game engine is composed of multiple layers, each with its own functions. These layers are divided into the following categories: + \begin{itemize} + \item Resource manager: Responsible for what happens when the engine is launched, including loading data formats. + \item Application: Manages the run loop, time, code execution, and events (e.g., input events). + \item Window/HID (Human Interface Devices): Handles input and events. + \item Renderer: Responsible for drawing the necessary objects on the screen, usually once per frame. + \item Debugging support: Provides testing for the engine, such as logging or performance profiling. + \item Scripting layer: Runs scripts, such as Lua or Python. + \item Memory systems: Handles and monitors memory usage. + \item Entity-Component System (ECS): Provides a modular way to create game objects, add physics, and define how the engine interacts with objects. + \item Physics: Adds specific physics to objects. + \item Audio: Processes audio. + \item AI: Provides artificial inteligent behavior. + \end{itemize} + + \subsubsection{ECS} + A game engine must have the ability to keep track and update several game objects. To do this most game engines employ an ECS model which uses modulair components to give entities properties and features. + The need for an entity component system arises because multiple game objects are required to create a scene in a game. These game objects exist within the scene and perform actions, such as a UI display for a score. + This game object does not need to be rendered; it could be a script running in the background. + It could also be a player sprite that is controlled. + These entities need to be aware of other entities, for example, during collisions. + For this to function, a scene is required to host all game objects. + Within this scene, the game objects must be stored efficiently, and entities must be provided with the required behavior, such as audio, position, or physics. + To create diverse entities with specific functions: + A scene can contain many different kinds of entities, each with different properties and functions. + But no matter how different each entity is, it remains an entity. + To assign properties and functions to entities, components are used. + Entt is an example of an ECS. \subsection{Conclusion} \section{3rd party tools} -\subsection{Introduction} -\subsection{Findings} -\subsection{Conclusion} + \subsection{Introduction} + \subsection{Findings} + \subsection{Conclusion} +\section{Gameloop/resource manager} + \subsection{Introduction} + \subsection{Findings} + \subsection{Conclusion} +\section{Rendering} + \subsection{Introduction} + \subsection{Findings} + \subsection{Conclusion} +\section{Event manager} + \subsection{Introduction} + The event manager is responsible for handling input. The system is notified when an input or event occurs. + The layers can subscribe to these events and respond to them. A method for querying the state of an input or event, such as the mouse position, should also be provided by the engine. + \subsection{Findings} + \subsection{Conclusion} +\section{Memory/debugging} + \subsection{Introduction} + \subsection{Findings} + \subsection{Conclusion} +\section{Physics/scripting} + \subsection{Introduction} + \subsection{Findings} + \subsection{Conclusion} +\section{Conclusion} +\section{Gameobjects/components} + \subsection{Introduction} + \subsection{Findings} + \subsection{Conclusion} \section{Conclusion} \end{document} - diff --git a/timerep.bcf-SAVE-ERROR b/timerep.bcf-SAVE-ERROR new file mode 100644 index 0000000..d36ea3a --- /dev/null +++ b/timerep.bcf-SAVE-ERROR @@ -0,0 +1,2384 @@ + + + + + + output_encoding + utf8 + + + input_encoding + utf8 + + + debug + 0 + + + mincrossrefs + 2 + + + minxrefs + 2 + + + sortcase + 1 + + + sortupper + 1 + + + + + + + alphaothers + + + + + extradatecontext + labelname + labeltitle + + + labelalpha + 0 + + + labelnamespec + shortauthor + author + shorteditor + editor + translator + + + labeltitle + 0 + + + labeltitlespec + shorttitle + title + maintitle + + + labeltitleyear + 0 + + + labeldateparts + 0 + + + labeldatespec + origdate + date + year + dateaddon + eventdate + nodate + + + julian + 0 + + + gregorianstart + 1582-10-15 + + + maxalphanames + 3 + + + maxbibnames + 99 + + + maxcitenames + 99 + + + maxsortnames + 99 + + + maxitems + 3 + + + minalphanames + 1 + + + minbibnames + 1 + + + mincitenames + 1 + + + minsortnames + 1 + + + minitems + 1 + + + nohashothers + 0 + + + noroman + 0 + + + nosortothers + 0 + + + pluralothers + 0 + + + singletitle + 0 + + + skipbib + 0 + + + skipbiblist + 0 + + + skiplab + 0 + + + sortalphaothers + + + + + sortlocale + english + + + sortingtemplatename + none + + + sortsets + 0 + + + uniquelist + false + + + uniquename + false + + + uniqueprimaryauthor + 0 + + + uniquetitle + 0 + + + uniquebaretitle + 0 + + + uniquework + 0 + + + useprefix + 0 + + + useafterword + 1 + + + useannotator + 1 + + + useauthor + 1 + + + usebookauthor + 1 + + + usecommentator + 1 + + + useeditor + 1 + + + useeditora + 1 + + + useeditorb + 1 + + + useeditorc + 1 + + + useforeword + 1 + + + useholder + 1 + + + useintroduction + 1 + + + usenamea + 1 + + + usenameb + 1 + + + usenamec + 1 + + + usetranslator + 0 + + + useshortauthor + 1 + + + useshorteditor + 1 + + + usesupervisor + 1 + + + + + + extradatecontext + labelname + labeltitle + + + labelalpha + 0 + + + labelnamespec + holder + shortauthor + author + shorteditor + editor + translator + + + labeltitle + 0 + + + labeltitlespec + shorttitle + title + maintitle + + + labeltitleyear + 0 + + + labeldateparts + 0 + + + labeldatespec + origdate + date + year + dateaddon + eventdate + nodate + + + maxalphanames + 3 + + + maxbibnames + 99 + + + maxcitenames + 99 + + + maxsortnames + 99 + + + maxitems + 3 + + + minalphanames + 1 + + + minbibnames + 1 + + + mincitenames + 1 + + + minsortnames + 1 + + + minitems + 1 + + + nohashothers + 0 + + + noroman + 0 + + + nosortothers + 0 + + + singletitle + 0 + + + skipbib + 0 + + + skipbiblist + 0 + + + skiplab + 0 + + + uniquelist + false + + + uniquename + false + + + uniqueprimaryauthor + 0 + + + uniquetitle + 0 + + + uniquebaretitle + 0 + + + uniquework + 0 + + + useprefix + 0 + + + useafterword + 1 + + + useannotator + 1 + + + useauthor + 1 + + + usebookauthor + 1 + + + usecommentator + 1 + + + useeditor + 1 + + + useeditora + 1 + + + useeditorb + 1 + + + useeditorc + 1 + + + useforeword + 1 + + + useholder + 1 + + + useintroduction + 1 + + + usenamea + 1 + + + usenameb + 1 + + + usenamec + 1 + + + usetranslator + 0 + + + useshortauthor + 1 + + + useshorteditor + 1 + + + usesupervisor + 1 + + + + + datamodel + labelalphanametemplate + labelalphatemplate + inheritance + translit + uniquenametemplate + sortingnamekeytemplate + sortingtemplate + extradatespec + extradatecontext + labelnamespec + labeltitlespec + labeldatespec + controlversion + alphaothers + sortalphaothers + presort + texencoding + bibencoding + sortingtemplatename + sortlocale + language + autolang + langhook + indexing + hyperref + backrefsetstyle + block + pagetracker + citecounter + citetracker + ibidtracker + idemtracker + opcittracker + loccittracker + labeldate + labeltime + dateera + date + time + eventdate + eventtime + origdate + origtime + urldate + urltime + alldatesusetime + alldates + alltimes + gregorianstart + autocite + notetype + uniquelist + uniquename + refsection + refsegment + citereset + sortlos + babel + datelabel + backrefstyle + arxiv + familyinits + giveninits + prefixinits + suffixinits + useafterword + useannotator + useauthor + usebookauthor + usecommentator + useeditor + useeditora + useeditorb + useeditorc + useforeword + useholder + useintroduction + usenamea + usenameb + usenamec + usetranslator + useshortauthor + useshorteditor + usesupervisor + debug + loadfiles + safeinputenc + sortcase + sortupper + terseinits + abbreviate + dateabbrev + clearlang + sortcites + sortsets + backref + backreffloats + trackfloats + parentracker + labeldateusetime + datecirca + dateuncertain + dateusetime + eventdateusetime + origdateusetime + urldateusetime + julian + datezeros + timezeros + timezones + seconds + autopunct + punctfont + labelnumber + labelalpha + labeltitle + labeltitleyear + labeldateparts + pluralothers + nohashothers + nosortothers + noroman + singletitle + uniquetitle + uniquebaretitle + uniquework + uniqueprimaryauthor + defernumbers + locallabelwidth + bibwarn + useprefix + skipbib + skipbiblist + skiplab + dataonly + defernums + firstinits + sortfirstinits + sortgiveninits + labelyear + spacecolon + pagetotal + shortnumeration + thesisinfoinnotes + url + isbn + doi + eprint + articlepubinfo + currentlang + noenddot + bibtexcaseprotection + mincrossrefs + minxrefs + maxnames + minnames + maxbibnames + minbibnames + maxcitenames + mincitenames + maxsortnames + minsortnames + maxitems + minitems + maxalphanames + minalphanames + maxparens + dateeraauto + + + alphaothers + sortalphaothers + presort + indexing + citetracker + ibidtracker + idemtracker + opcittracker + loccittracker + uniquelist + uniquename + familyinits + giveninits + prefixinits + suffixinits + useafterword + useannotator + useauthor + usebookauthor + usecommentator + useeditor + useeditora + useeditorb + useeditorc + useforeword + useholder + useintroduction + usenamea + usenameb + usenamec + usetranslator + useshortauthor + useshorteditor + usesupervisor + terseinits + abbreviate + dateabbrev + clearlang + labelnumber + labelalpha + labeltitle + labeltitleyear + labeldateparts + nohashothers + nosortothers + noroman + singletitle + uniquetitle + uniquebaretitle + uniquework + uniqueprimaryauthor + useprefix + skipbib + skipbiblist + skiplab + dataonly + skiplos + labelyear + bibtexcaseprotection + labelalphatemplate + translit + sortexclusion + sortinclusion + extradatecontext + labelnamespec + labeltitlespec + labeldatespec + maxnames + minnames + maxbibnames + minbibnames + maxcitenames + mincitenames + maxsortnames + minsortnames + maxitems + minitems + maxalphanames + minalphanames + + + noinherit + nametemplates + labelalphanametemplatename + uniquenametemplatename + sortingnamekeytemplatename + presort + indexing + citetracker + ibidtracker + idemtracker + opcittracker + loccittracker + uniquelist + uniquename + familyinits + giveninits + prefixinits + suffixinits + useafterword + useannotator + useauthor + usebookauthor + usecommentator + useeditor + useeditora + useeditorb + useeditorc + useforeword + useholder + useintroduction + usenamea + usenameb + usenamec + usetranslator + useshortauthor + useshorteditor + usesupervisor + terseinits + abbreviate + dateabbrev + clearlang + labelnumber + labelalpha + labeltitle + labeltitleyear + labeldateparts + nohashothers + nosortothers + noroman + singletitle + uniquetitle + uniquebaretitle + uniquework + uniqueprimaryauthor + useprefix + skipbib + skipbiblist + skiplab + dataonly + skiplos + bibtexcaseprotection + maxnames + minnames + maxbibnames + minbibnames + maxcitenames + mincitenames + maxsortnames + minsortnames + maxitems + minitems + maxalphanames + minalphanames + + + nametemplates + labelalphanametemplatename + uniquenametemplatename + sortingnamekeytemplatename + uniquelist + uniquename + familyinits + giveninits + prefixinits + suffixinits + terseinits + nohashothers + nosortothers + useprefix + + + nametemplates + labelalphanametemplatename + uniquenametemplatename + sortingnamekeytemplatename + uniquename + familyinits + giveninits + prefixinits + suffixinits + terseinits + useprefix + + + + + + + + + + + + + + + + + + + patent + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + prefix + family + + + + + shorthand + label + labelname + labelname + + + year + + + + + + labelyear + year + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + prefix + family + given + + + + + prefix + family + + + given + + + suffix + + + prefix + + + mm + + + + sf,sm,sn,pf,pm,pn,pp + family,given,prefix,suffix + boolean,integer,string,xml + default,transliteration,transcription,translation + + + article + artwork + audio + bibnote + book + bookinbook + booklet + collection + commentary + customa + customb + customc + customd + custome + customf + dataset + inbook + incollection + inproceedings + inreference + image + jurisdiction + legal + legislation + letter + manual + misc + movie + music + mvcollection + mvreference + mvproceedings + mvbook + online + patent + performance + periodical + proceedings + reference + report + review + set + software + standard + suppbook + suppcollection + suppperiodical + thesis + unpublished + video + xdata + + + sortyear + volume + volumes + abstract + addendum + annotation + booksubtitle + booktitle + booktitleaddon + chapter + edition + eid + entrysubtype + eprintclass + eprinttype + eventtitle + eventtitleaddon + gender + howpublished + indexsorttitle + indextitle + isan + isbn + ismn + isrn + issn + issue + issuesubtitle + issuetitle + issuetitleaddon + iswc + journalsubtitle + journaltitle + journaltitleaddon + label + langid + langidopts + library + mainsubtitle + maintitle + maintitleaddon + nameaddon + note + number + origtitle + pagetotal + part + relatedstring + relatedtype + reprinttitle + series + shorthandintro + subtitle + title + titleaddon + usera + userb + userc + userd + usere + userf + venue + version + shorthand + shortjournal + shortseries + shorttitle + sorttitle + sortshorthand + sortkey + presort + institution + lista + listb + listc + listd + liste + listf + location + organization + origlocation + origpublisher + publisher + afterword + annotator + author + bookauthor + commentator + editor + editora + editorb + editorc + foreword + holder + introduction + namea + nameb + namec + translator + shortauthor + shorteditor + sortname + authortype + editoratype + editorbtype + editorctype + editortype + bookpagination + nameatype + namebtype + namectype + pagination + pubstate + type + language + origlanguage + crossref + xref + date + endyear + year + month + day + hour + minute + second + timezone + yeardivision + endmonth + endday + endhour + endminute + endsecond + endtimezone + endyeardivision + eventdate + eventendyear + eventyear + eventmonth + eventday + eventhour + eventminute + eventsecond + eventtimezone + eventyeardivision + eventendmonth + eventendday + eventendhour + eventendminute + eventendsecond + eventendtimezone + eventendyeardivision + origdate + origendyear + origyear + origmonth + origday + orighour + origminute + origsecond + origtimezone + origyeardivision + origendmonth + origendday + origendhour + origendminute + origendsecond + origendtimezone + origendyeardivision + urldate + urlendyear + urlyear + urlmonth + urlday + urlhour + urlminute + urlsecond + urltimezone + urlyeardivision + urlendmonth + urlendday + urlendhour + urlendminute + urlendsecond + urlendtimezone + urlendyeardivision + doi + eprint + file + verba + verbb + verbc + url + xdata + ids + entryset + related + keywords + options + relatedoptions + pages + execute + supervisor + dateaddon + + + abstract + annotation + authortype + bookpagination + crossref + day + doi + eprint + eprintclass + eprinttype + endday + endhour + endminute + endmonth + endsecond + endtimezone + endyear + endyeardivision + entryset + entrysubtype + execute + file + gender + hour + ids + indextitle + indexsorttitle + isan + ismn + iswc + keywords + label + langid + langidopts + library + lista + listb + listc + listd + liste + listf + minute + month + namea + nameb + namec + nameatype + namebtype + namectype + nameaddon + options + origday + origendday + origendhour + origendminute + origendmonth + origendsecond + origendtimezone + origendyear + origendyeardivision + orighour + origminute + origmonth + origsecond + origtimezone + origyear + origyeardivision + origlocation + origpublisher + origtitle + pagination + presort + related + relatedoptions + relatedstring + relatedtype + second + shortauthor + shorteditor + shorthand + shorthandintro + shortjournal + shortseries + shorttitle + sortkey + sortname + sortshorthand + sorttitle + sortyear + timezone + url + urlday + urlendday + urlendhour + urlendminute + urlendmonth + urlendsecond + urlendtimezone + urlendyear + urlhour + urlminute + urlmonth + urlsecond + urltimezone + urlyear + usera + userb + userc + userd + usere + userf + verba + verbb + verbc + xdata + xref + year + yeardivision + + + set + entryset + + + article + addendum + annotator + author + commentator + editor + editora + editorb + editorc + editortype + editoratype + editorbtype + editorctype + eid + issn + issue + issuetitle + issuesubtitle + issuetitleaddon + journalsubtitle + journaltitle + journaltitleaddon + language + note + number + origlanguage + pages + pubstate + series + subtitle + title + titleaddon + translator + version + volume + + + bibnote + note + + + book + author + addendum + afterword + annotator + chapter + commentator + edition + editor + editora + editorb + editorc + editortype + editoratype + editorbtype + editorctype + eid + foreword + introduction + isbn + language + location + maintitle + maintitleaddon + mainsubtitle + note + number + origlanguage + pages + pagetotal + part + publisher + pubstate + series + subtitle + title + titleaddon + translator + volume + volumes + + + mvbook + addendum + afterword + annotator + author + commentator + edition + editor + editora + editorb + editorc + editortype + editoratype + editorbtype + editorctype + foreword + introduction + isbn + language + location + note + number + origlanguage + pagetotal + publisher + pubstate + series + subtitle + title + titleaddon + translator + volume + volumes + + + inbook + bookinbook + suppbook + addendum + afterword + annotator + author + booktitle + bookauthor + booksubtitle + booktitleaddon + chapter + commentator + edition + editor + editora + editorb + editorc + editortype + editoratype + editorbtype + editorctype + eid + foreword + introduction + isbn + language + location + mainsubtitle + maintitle + maintitleaddon + note + number + origlanguage + part + publisher + pages + pubstate + series + subtitle + title + titleaddon + translator + volume + volumes + + + booklet + addendum + author + chapter + editor + editortype + eid + howpublished + language + location + note + pages + pagetotal + pubstate + subtitle + title + titleaddon + type + + + collection + reference + addendum + afterword + annotator + chapter + commentator + edition + editor + editora + editorb + editorc + editortype + editoratype + editorbtype + editorctype + eid + foreword + introduction + isbn + language + location + mainsubtitle + maintitle + maintitleaddon + note + number + origlanguage + pages + pagetotal + part + publisher + pubstate + series + subtitle + title + titleaddon + translator + volume + volumes + + + mvcollection + mvreference + addendum + afterword + annotator + author + commentator + edition + editor + editora + editorb + editorc + editortype + editoratype + editorbtype + editorctype + foreword + introduction + isbn + language + location + note + number + origlanguage + publisher + pubstate + subtitle + title + titleaddon + translator + volume + volumes + + + incollection + suppcollection + inreference + addendum + afterword + annotator + author + booksubtitle + booktitle + booktitleaddon + chapter + commentator + edition + editor + editora + editorb + editorc + editortype + editoratype + editorbtype + editorctype + eid + foreword + introduction + isbn + language + location + mainsubtitle + maintitle + maintitleaddon + note + number + origlanguage + pages + part + publisher + pubstate + series + subtitle + title + titleaddon + translator + volume + volumes + + + dataset + addendum + author + edition + editor + editortype + language + location + note + number + organization + publisher + pubstate + series + subtitle + title + titleaddon + type + version + + + manual + addendum + author + chapter + edition + editor + editortype + eid + isbn + language + location + note + number + organization + pages + pagetotal + publisher + pubstate + series + subtitle + title + titleaddon + type + version + + + misc + software + addendum + author + editor + editortype + howpublished + language + location + note + organization + pubstate + subtitle + title + titleaddon + type + version + + + online + addendum + author + editor + editortype + language + note + organization + pubstate + subtitle + title + titleaddon + version + + + patent + addendum + author + holder + location + note + number + pubstate + subtitle + title + titleaddon + type + version + + + periodical + addendum + editor + editora + editorb + editorc + editortype + editoratype + editorbtype + editorctype + issn + issue + issuesubtitle + issuetitle + issuetitleaddon + language + note + number + pubstate + series + subtitle + title + titleaddon + volume + yeardivision + + + mvproceedings + addendum + editor + editortype + eventday + eventendday + eventendhour + eventendminute + eventendmonth + eventendsecond + eventendtimezone + eventendyear + eventendyeardivision + eventhour + eventminute + eventmonth + eventsecond + eventtimezone + eventyear + eventyeardivision + eventtitle + eventtitleaddon + isbn + language + location + note + number + organization + pagetotal + publisher + pubstate + series + subtitle + title + titleaddon + venue + volumes + + + proceedings + addendum + chapter + editor + editortype + eid + eventday + eventendday + eventendhour + eventendminute + eventendmonth + eventendsecond + eventendtimezone + eventendyear + eventendyeardivision + eventhour + eventminute + eventmonth + eventsecond + eventtimezone + eventyear + eventyeardivision + eventtitle + eventtitleaddon + isbn + language + location + mainsubtitle + maintitle + maintitleaddon + note + number + organization + pages + pagetotal + part + publisher + pubstate + series + subtitle + title + titleaddon + venue + volume + volumes + + + inproceedings + addendum + author + booksubtitle + booktitle + booktitleaddon + chapter + editor + editortype + eid + eventday + eventendday + eventendhour + eventendminute + eventendmonth + eventendsecond + eventendtimezone + eventendyear + eventendyeardivision + eventhour + eventminute + eventmonth + eventsecond + eventtimezone + eventyear + eventyeardivision + eventtitle + eventtitleaddon + isbn + language + location + mainsubtitle + maintitle + maintitleaddon + note + number + organization + pages + part + publisher + pubstate + series + subtitle + title + titleaddon + venue + volume + volumes + + + report + addendum + author + chapter + eid + institution + isrn + language + location + note + number + pages + pagetotal + pubstate + subtitle + title + titleaddon + type + version + + + thesis + addendum + author + chapter + eid + institution + language + location + note + pages + pagetotal + pubstate + subtitle + title + titleaddon + type + + + unpublished + addendum + author + eventday + eventendday + eventendhour + eventendminute + eventendmonth + eventendsecond + eventendtimezone + eventendyear + eventendyeardivision + eventhour + eventminute + eventmonth + eventsecond + eventtimezone + eventyear + eventyeardivision + eventtitle + eventtitleaddon + howpublished + language + location + note + pubstate + subtitle + title + titleaddon + type + venue + + + thesis + supervisor + + + dateaddon + + + abstract + addendum + afterword + annotator + author + bookauthor + booksubtitle + booktitle + booktitleaddon + chapter + commentator + editor + editora + editorb + editorc + foreword + holder + institution + introduction + issuesubtitle + issuetitle + issuetitleaddon + journalsubtitle + journaltitle + journaltitleaddon + location + mainsubtitle + maintitle + maintitleaddon + nameaddon + note + organization + origlanguage + origlocation + origpublisher + origtitle + part + publisher + relatedstring + series + shortauthor + shorteditor + shorthand + shortjournal + shortseries + shorttitle + sortname + sortshorthand + sorttitle + subtitle + title + titleaddon + translator + venue + + + article + book + inbook + bookinbook + suppbook + booklet + collection + incollection + suppcollection + manual + misc + mvbook + mvcollection + online + patent + periodical + suppperiodical + proceedings + inproceedings + reference + inreference + report + set + thesis + unpublished + + + date + year + + + + + set + + entryset + + + + article + + author + journaltitle + title + + + + book + mvbook + + author + title + + + + inbook + bookinbook + suppbook + + author + title + booktitle + + + + booklet + + + author + editor + + title + + + + collection + reference + mvcollection + mvreference + + editor + title + + + + incollection + suppcollection + inreference + + author + editor + title + booktitle + + + + dataset + + title + + + + manual + + title + + + + misc + software + + title + + + + online + + title + + url + doi + eprint + + + + + patent + + author + title + number + + + + periodical + + editor + title + + + + proceedings + mvproceedings + + title + + + + inproceedings + + author + title + booktitle + + + + report + + author + title + type + institution + + + + thesis + + author + title + type + institution + + + + unpublished + + author + title + + + + + isbn + + + issn + + + ismn + + + gender + + + + + + + sources.bib + + -- cgit v1.2.3 From c9ec253299eba8829d31b2b5eec95aefe7bf7cd8 Mon Sep 17 00:00:00 2001 From: WBoerenkamps Date: Sun, 8 Sep 2024 11:29:19 +0200 Subject: removed some error files --- research.bbl-SAVE-ERROR | 20 - research.bcf-SAVE-ERROR | 2384 ----------------------------------------------- timerep.bcf-SAVE-ERROR | 2384 ----------------------------------------------- 3 files changed, 4788 deletions(-) delete mode 100644 research.bbl-SAVE-ERROR delete mode 100644 research.bcf-SAVE-ERROR delete mode 100644 timerep.bcf-SAVE-ERROR diff --git a/research.bbl-SAVE-ERROR b/research.bbl-SAVE-ERROR deleted file mode 100644 index 005f385..0000000 --- a/research.bbl-SAVE-ERROR +++ /dev/null @@ -1,20 +0,0 @@ -% $ biblatex auxiliary file $ -% $ biblatex bbl format version 3.2 $ -% Do not modify the above lines! -% -% This is an auxiliary file used by the 'biblatex' package. -% This file may safely be deleted. It will be recreated by -% biber as required. -% -\begingroup -\makeatletter -\@ifundefined{ver@biblatex.sty} - {\@latex@error - {Missing 'biblatex' package} - {The bibliography requires the 'biblatex' package.} - \aftergroup\endinput} - {} -\endgroup - -\endinput - diff --git a/research.bcf-SAVE-ERROR b/research.bcf-SAVE-ERROR deleted file mode 100644 index d36ea3a..0000000 --- a/research.bcf-SAVE-ERROR +++ /dev/null @@ -1,2384 +0,0 @@ - - - - - - output_encoding - utf8 - - - input_encoding - utf8 - - - debug - 0 - - - mincrossrefs - 2 - - - minxrefs - 2 - - - sortcase - 1 - - - sortupper - 1 - - - - - - - alphaothers - + - - - extradatecontext - labelname - labeltitle - - - labelalpha - 0 - - - labelnamespec - shortauthor - author - shorteditor - editor - translator - - - labeltitle - 0 - - - labeltitlespec - shorttitle - title - maintitle - - - labeltitleyear - 0 - - - labeldateparts - 0 - - - labeldatespec - origdate - date - year - dateaddon - eventdate - nodate - - - julian - 0 - - - gregorianstart - 1582-10-15 - - - maxalphanames - 3 - - - maxbibnames - 99 - - - maxcitenames - 99 - - - maxsortnames - 99 - - - maxitems - 3 - - - minalphanames - 1 - - - minbibnames - 1 - - - mincitenames - 1 - - - minsortnames - 1 - - - minitems - 1 - - - nohashothers - 0 - - - noroman - 0 - - - nosortothers - 0 - - - pluralothers - 0 - - - singletitle - 0 - - - skipbib - 0 - - - skipbiblist - 0 - - - skiplab - 0 - - - sortalphaothers - + - - - sortlocale - english - - - sortingtemplatename - none - - - sortsets - 0 - - - uniquelist - false - - - uniquename - false - - - uniqueprimaryauthor - 0 - - - uniquetitle - 0 - - - uniquebaretitle - 0 - - - uniquework - 0 - - - useprefix - 0 - - - useafterword - 1 - - - useannotator - 1 - - - useauthor - 1 - - - usebookauthor - 1 - - - usecommentator - 1 - - - useeditor - 1 - - - useeditora - 1 - - - useeditorb - 1 - - - useeditorc - 1 - - - useforeword - 1 - - - useholder - 1 - - - useintroduction - 1 - - - usenamea - 1 - - - usenameb - 1 - - - usenamec - 1 - - - usetranslator - 0 - - - useshortauthor - 1 - - - useshorteditor - 1 - - - usesupervisor - 1 - - - - - - extradatecontext - labelname - labeltitle - - - labelalpha - 0 - - - labelnamespec - holder - shortauthor - author - shorteditor - editor - translator - - - labeltitle - 0 - - - labeltitlespec - shorttitle - title - maintitle - - - labeltitleyear - 0 - - - labeldateparts - 0 - - - labeldatespec - origdate - date - year - dateaddon - eventdate - nodate - - - maxalphanames - 3 - - - maxbibnames - 99 - - - maxcitenames - 99 - - - maxsortnames - 99 - - - maxitems - 3 - - - minalphanames - 1 - - - minbibnames - 1 - - - mincitenames - 1 - - - minsortnames - 1 - - - minitems - 1 - - - nohashothers - 0 - - - noroman - 0 - - - nosortothers - 0 - - - singletitle - 0 - - - skipbib - 0 - - - skipbiblist - 0 - - - skiplab - 0 - - - uniquelist - false - - - uniquename - false - - - uniqueprimaryauthor - 0 - - - uniquetitle - 0 - - - uniquebaretitle - 0 - - - uniquework - 0 - - - useprefix - 0 - - - useafterword - 1 - - - useannotator - 1 - - - useauthor - 1 - - - usebookauthor - 1 - - - usecommentator - 1 - - - useeditor - 1 - - - useeditora - 1 - - - useeditorb - 1 - - - useeditorc - 1 - - - useforeword - 1 - - - useholder - 1 - - - useintroduction - 1 - - - usenamea - 1 - - - usenameb - 1 - - - usenamec - 1 - - - usetranslator - 0 - - - useshortauthor - 1 - - - useshorteditor - 1 - - - usesupervisor - 1 - - - - - datamodel - labelalphanametemplate - labelalphatemplate - inheritance - translit - uniquenametemplate - sortingnamekeytemplate - sortingtemplate - extradatespec - extradatecontext - labelnamespec - labeltitlespec - labeldatespec - controlversion - alphaothers - sortalphaothers - presort - texencoding - bibencoding - sortingtemplatename - sortlocale - language - autolang - langhook - indexing - hyperref - backrefsetstyle - block - pagetracker - citecounter - citetracker - ibidtracker - idemtracker - opcittracker - loccittracker - labeldate - labeltime - dateera - date - time - eventdate - eventtime - origdate - origtime - urldate - urltime - alldatesusetime - alldates - alltimes - gregorianstart - autocite - notetype - uniquelist - uniquename - refsection - refsegment - citereset - sortlos - babel - datelabel - backrefstyle - arxiv - familyinits - giveninits - prefixinits - suffixinits - useafterword - useannotator - useauthor - usebookauthor - usecommentator - useeditor - useeditora - useeditorb - useeditorc - useforeword - useholder - useintroduction - usenamea - usenameb - usenamec - usetranslator - useshortauthor - useshorteditor - usesupervisor - debug - loadfiles - safeinputenc - sortcase - sortupper - terseinits - abbreviate - dateabbrev - clearlang - sortcites - sortsets - backref - backreffloats - trackfloats - parentracker - labeldateusetime - datecirca - dateuncertain - dateusetime - eventdateusetime - origdateusetime - urldateusetime - julian - datezeros - timezeros - timezones - seconds - autopunct - punctfont - labelnumber - labelalpha - labeltitle - labeltitleyear - labeldateparts - pluralothers - nohashothers - nosortothers - noroman - singletitle - uniquetitle - uniquebaretitle - uniquework - uniqueprimaryauthor - defernumbers - locallabelwidth - bibwarn - useprefix - skipbib - skipbiblist - skiplab - dataonly - defernums - firstinits - sortfirstinits - sortgiveninits - labelyear - spacecolon - pagetotal - shortnumeration - thesisinfoinnotes - url - isbn - doi - eprint - articlepubinfo - currentlang - noenddot - bibtexcaseprotection - mincrossrefs - minxrefs - maxnames - minnames - maxbibnames - minbibnames - maxcitenames - mincitenames - maxsortnames - minsortnames - maxitems - minitems - maxalphanames - minalphanames - maxparens - dateeraauto - - - alphaothers - sortalphaothers - presort - indexing - citetracker - ibidtracker - idemtracker - opcittracker - loccittracker - uniquelist - uniquename - familyinits - giveninits - prefixinits - suffixinits - useafterword - useannotator - useauthor - usebookauthor - usecommentator - useeditor - useeditora - useeditorb - useeditorc - useforeword - useholder - useintroduction - usenamea - usenameb - usenamec - usetranslator - useshortauthor - useshorteditor - usesupervisor - terseinits - abbreviate - dateabbrev - clearlang - labelnumber - labelalpha - labeltitle - labeltitleyear - labeldateparts - nohashothers - nosortothers - noroman - singletitle - uniquetitle - uniquebaretitle - uniquework - uniqueprimaryauthor - useprefix - skipbib - skipbiblist - skiplab - dataonly - skiplos - labelyear - bibtexcaseprotection - labelalphatemplate - translit - sortexclusion - sortinclusion - extradatecontext - labelnamespec - labeltitlespec - labeldatespec - maxnames - minnames - maxbibnames - minbibnames - maxcitenames - mincitenames - maxsortnames - minsortnames - maxitems - minitems - maxalphanames - minalphanames - - - noinherit - nametemplates - labelalphanametemplatename - uniquenametemplatename - sortingnamekeytemplatename - presort - indexing - citetracker - ibidtracker - idemtracker - opcittracker - loccittracker - uniquelist - uniquename - familyinits - giveninits - prefixinits - suffixinits - useafterword - useannotator - useauthor - usebookauthor - usecommentator - useeditor - useeditora - useeditorb - useeditorc - useforeword - useholder - useintroduction - usenamea - usenameb - usenamec - usetranslator - useshortauthor - useshorteditor - usesupervisor - terseinits - abbreviate - dateabbrev - clearlang - labelnumber - labelalpha - labeltitle - labeltitleyear - labeldateparts - nohashothers - nosortothers - noroman - singletitle - uniquetitle - uniquebaretitle - uniquework - uniqueprimaryauthor - useprefix - skipbib - skipbiblist - skiplab - dataonly - skiplos - bibtexcaseprotection - maxnames - minnames - maxbibnames - minbibnames - maxcitenames - mincitenames - maxsortnames - minsortnames - maxitems - minitems - maxalphanames - minalphanames - - - nametemplates - labelalphanametemplatename - uniquenametemplatename - sortingnamekeytemplatename - uniquelist - uniquename - familyinits - giveninits - prefixinits - suffixinits - terseinits - nohashothers - nosortothers - useprefix - - - nametemplates - labelalphanametemplatename - uniquenametemplatename - sortingnamekeytemplatename - uniquename - familyinits - giveninits - prefixinits - suffixinits - terseinits - useprefix - - - - - - - - - - - - - - - - - - - patent - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - prefix - family - - - - - shorthand - label - labelname - labelname - - - year - - - - - - labelyear - year - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - prefix - family - given - - - - - prefix - family - - - given - - - suffix - - - prefix - - - mm - - - - sf,sm,sn,pf,pm,pn,pp - family,given,prefix,suffix - boolean,integer,string,xml - default,transliteration,transcription,translation - - - article - artwork - audio - bibnote - book - bookinbook - booklet - collection - commentary - customa - customb - customc - customd - custome - customf - dataset - inbook - incollection - inproceedings - inreference - image - jurisdiction - legal - legislation - letter - manual - misc - movie - music - mvcollection - mvreference - mvproceedings - mvbook - online - patent - performance - periodical - proceedings - reference - report - review - set - software - standard - suppbook - suppcollection - suppperiodical - thesis - unpublished - video - xdata - - - sortyear - volume - volumes - abstract - addendum - annotation - booksubtitle - booktitle - booktitleaddon - chapter - edition - eid - entrysubtype - eprintclass - eprinttype - eventtitle - eventtitleaddon - gender - howpublished - indexsorttitle - indextitle - isan - isbn - ismn - isrn - issn - issue - issuesubtitle - issuetitle - issuetitleaddon - iswc - journalsubtitle - journaltitle - journaltitleaddon - label - langid - langidopts - library - mainsubtitle - maintitle - maintitleaddon - nameaddon - note - number - origtitle - pagetotal - part - relatedstring - relatedtype - reprinttitle - series - shorthandintro - subtitle - title - titleaddon - usera - userb - userc - userd - usere - userf - venue - version - shorthand - shortjournal - shortseries - shorttitle - sorttitle - sortshorthand - sortkey - presort - institution - lista - listb - listc - listd - liste - listf - location - organization - origlocation - origpublisher - publisher - afterword - annotator - author - bookauthor - commentator - editor - editora - editorb - editorc - foreword - holder - introduction - namea - nameb - namec - translator - shortauthor - shorteditor - sortname - authortype - editoratype - editorbtype - editorctype - editortype - bookpagination - nameatype - namebtype - namectype - pagination - pubstate - type - language - origlanguage - crossref - xref - date - endyear - year - month - day - hour - minute - second - timezone - yeardivision - endmonth - endday - endhour - endminute - endsecond - endtimezone - endyeardivision - eventdate - eventendyear - eventyear - eventmonth - eventday - eventhour - eventminute - eventsecond - eventtimezone - eventyeardivision - eventendmonth - eventendday - eventendhour - eventendminute - eventendsecond - eventendtimezone - eventendyeardivision - origdate - origendyear - origyear - origmonth - origday - orighour - origminute - origsecond - origtimezone - origyeardivision - origendmonth - origendday - origendhour - origendminute - origendsecond - origendtimezone - origendyeardivision - urldate - urlendyear - urlyear - urlmonth - urlday - urlhour - urlminute - urlsecond - urltimezone - urlyeardivision - urlendmonth - urlendday - urlendhour - urlendminute - urlendsecond - urlendtimezone - urlendyeardivision - doi - eprint - file - verba - verbb - verbc - url - xdata - ids - entryset - related - keywords - options - relatedoptions - pages - execute - supervisor - dateaddon - - - abstract - annotation - authortype - bookpagination - crossref - day - doi - eprint - eprintclass - eprinttype - endday - endhour - endminute - endmonth - endsecond - endtimezone - endyear - endyeardivision - entryset - entrysubtype - execute - file - gender - hour - ids - indextitle - indexsorttitle - isan - ismn - iswc - keywords - label - langid - langidopts - library - lista - listb - listc - listd - liste - listf - minute - month - namea - nameb - namec - nameatype - namebtype - namectype - nameaddon - options - origday - origendday - origendhour - origendminute - origendmonth - origendsecond - origendtimezone - origendyear - origendyeardivision - orighour - origminute - origmonth - origsecond - origtimezone - origyear - origyeardivision - origlocation - origpublisher - origtitle - pagination - presort - related - relatedoptions - relatedstring - relatedtype - second - shortauthor - shorteditor - shorthand - shorthandintro - shortjournal - shortseries - shorttitle - sortkey - sortname - sortshorthand - sorttitle - sortyear - timezone - url - urlday - urlendday - urlendhour - urlendminute - urlendmonth - urlendsecond - urlendtimezone - urlendyear - urlhour - urlminute - urlmonth - urlsecond - urltimezone - urlyear - usera - userb - userc - userd - usere - userf - verba - verbb - verbc - xdata - xref - year - yeardivision - - - set - entryset - - - article - addendum - annotator - author - commentator - editor - editora - editorb - editorc - editortype - editoratype - editorbtype - editorctype - eid - issn - issue - issuetitle - issuesubtitle - issuetitleaddon - journalsubtitle - journaltitle - journaltitleaddon - language - note - number - origlanguage - pages - pubstate - series - subtitle - title - titleaddon - translator - version - volume - - - bibnote - note - - - book - author - addendum - afterword - annotator - chapter - commentator - edition - editor - editora - editorb - editorc - editortype - editoratype - editorbtype - editorctype - eid - foreword - introduction - isbn - language - location - maintitle - maintitleaddon - mainsubtitle - note - number - origlanguage - pages - pagetotal - part - publisher - pubstate - series - subtitle - title - titleaddon - translator - volume - volumes - - - mvbook - addendum - afterword - annotator - author - commentator - edition - editor - editora - editorb - editorc - editortype - editoratype - editorbtype - editorctype - foreword - introduction - isbn - language - location - note - number - origlanguage - pagetotal - publisher - pubstate - series - subtitle - title - titleaddon - translator - volume - volumes - - - inbook - bookinbook - suppbook - addendum - afterword - annotator - author - booktitle - bookauthor - booksubtitle - booktitleaddon - chapter - commentator - edition - editor - editora - editorb - editorc - editortype - editoratype - editorbtype - editorctype - eid - foreword - introduction - isbn - language - location - mainsubtitle - maintitle - maintitleaddon - note - number - origlanguage - part - publisher - pages - pubstate - series - subtitle - title - titleaddon - translator - volume - volumes - - - booklet - addendum - author - chapter - editor - editortype - eid - howpublished - language - location - note - pages - pagetotal - pubstate - subtitle - title - titleaddon - type - - - collection - reference - addendum - afterword - annotator - chapter - commentator - edition - editor - editora - editorb - editorc - editortype - editoratype - editorbtype - editorctype - eid - foreword - introduction - isbn - language - location - mainsubtitle - maintitle - maintitleaddon - note - number - origlanguage - pages - pagetotal - part - publisher - pubstate - series - subtitle - title - titleaddon - translator - volume - volumes - - - mvcollection - mvreference - addendum - afterword - annotator - author - commentator - edition - editor - editora - editorb - editorc - editortype - editoratype - editorbtype - editorctype - foreword - introduction - isbn - language - location - note - number - origlanguage - publisher - pubstate - subtitle - title - titleaddon - translator - volume - volumes - - - incollection - suppcollection - inreference - addendum - afterword - annotator - author - booksubtitle - booktitle - booktitleaddon - chapter - commentator - edition - editor - editora - editorb - editorc - editortype - editoratype - editorbtype - editorctype - eid - foreword - introduction - isbn - language - location - mainsubtitle - maintitle - maintitleaddon - note - number - origlanguage - pages - part - publisher - pubstate - series - subtitle - title - titleaddon - translator - volume - volumes - - - dataset - addendum - author - edition - editor - editortype - language - location - note - number - organization - publisher - pubstate - series - subtitle - title - titleaddon - type - version - - - manual - addendum - author - chapter - edition - editor - editortype - eid - isbn - language - location - note - number - organization - pages - pagetotal - publisher - pubstate - series - subtitle - title - titleaddon - type - version - - - misc - software - addendum - author - editor - editortype - howpublished - language - location - note - organization - pubstate - subtitle - title - titleaddon - type - version - - - online - addendum - author - editor - editortype - language - note - organization - pubstate - subtitle - title - titleaddon - version - - - patent - addendum - author - holder - location - note - number - pubstate - subtitle - title - titleaddon - type - version - - - periodical - addendum - editor - editora - editorb - editorc - editortype - editoratype - editorbtype - editorctype - issn - issue - issuesubtitle - issuetitle - issuetitleaddon - language - note - number - pubstate - series - subtitle - title - titleaddon - volume - yeardivision - - - mvproceedings - addendum - editor - editortype - eventday - eventendday - eventendhour - eventendminute - eventendmonth - eventendsecond - eventendtimezone - eventendyear - eventendyeardivision - eventhour - eventminute - eventmonth - eventsecond - eventtimezone - eventyear - eventyeardivision - eventtitle - eventtitleaddon - isbn - language - location - note - number - organization - pagetotal - publisher - pubstate - series - subtitle - title - titleaddon - venue - volumes - - - proceedings - addendum - chapter - editor - editortype - eid - eventday - eventendday - eventendhour - eventendminute - eventendmonth - eventendsecond - eventendtimezone - eventendyear - eventendyeardivision - eventhour - eventminute - eventmonth - eventsecond - eventtimezone - eventyear - eventyeardivision - eventtitle - eventtitleaddon - isbn - language - location - mainsubtitle - maintitle - maintitleaddon - note - number - organization - pages - pagetotal - part - publisher - pubstate - series - subtitle - title - titleaddon - venue - volume - volumes - - - inproceedings - addendum - author - booksubtitle - booktitle - booktitleaddon - chapter - editor - editortype - eid - eventday - eventendday - eventendhour - eventendminute - eventendmonth - eventendsecond - eventendtimezone - eventendyear - eventendyeardivision - eventhour - eventminute - eventmonth - eventsecond - eventtimezone - eventyear - eventyeardivision - eventtitle - eventtitleaddon - isbn - language - location - mainsubtitle - maintitle - maintitleaddon - note - number - organization - pages - part - publisher - pubstate - series - subtitle - title - titleaddon - venue - volume - volumes - - - report - addendum - author - chapter - eid - institution - isrn - language - location - note - number - pages - pagetotal - pubstate - subtitle - title - titleaddon - type - version - - - thesis - addendum - author - chapter - eid - institution - language - location - note - pages - pagetotal - pubstate - subtitle - title - titleaddon - type - - - unpublished - addendum - author - eventday - eventendday - eventendhour - eventendminute - eventendmonth - eventendsecond - eventendtimezone - eventendyear - eventendyeardivision - eventhour - eventminute - eventmonth - eventsecond - eventtimezone - eventyear - eventyeardivision - eventtitle - eventtitleaddon - howpublished - language - location - note - pubstate - subtitle - title - titleaddon - type - venue - - - thesis - supervisor - - - dateaddon - - - abstract - addendum - afterword - annotator - author - bookauthor - booksubtitle - booktitle - booktitleaddon - chapter - commentator - editor - editora - editorb - editorc - foreword - holder - institution - introduction - issuesubtitle - issuetitle - issuetitleaddon - journalsubtitle - journaltitle - journaltitleaddon - location - mainsubtitle - maintitle - maintitleaddon - nameaddon - note - organization - origlanguage - origlocation - origpublisher - origtitle - part - publisher - relatedstring - series - shortauthor - shorteditor - shorthand - shortjournal - shortseries - shorttitle - sortname - sortshorthand - sorttitle - subtitle - title - titleaddon - translator - venue - - - article - book - inbook - bookinbook - suppbook - booklet - collection - incollection - suppcollection - manual - misc - mvbook - mvcollection - online - patent - periodical - suppperiodical - proceedings - inproceedings - reference - inreference - report - set - thesis - unpublished - - - date - year - - - - - set - - entryset - - - - article - - author - journaltitle - title - - - - book - mvbook - - author - title - - - - inbook - bookinbook - suppbook - - author - title - booktitle - - - - booklet - - - author - editor - - title - - - - collection - reference - mvcollection - mvreference - - editor - title - - - - incollection - suppcollection - inreference - - author - editor - title - booktitle - - - - dataset - - title - - - - manual - - title - - - - misc - software - - title - - - - online - - title - - url - doi - eprint - - - - - patent - - author - title - number - - - - periodical - - editor - title - - - - proceedings - mvproceedings - - title - - - - inproceedings - - author - title - booktitle - - - - report - - author - title - type - institution - - - - thesis - - author - title - type - institution - - - - unpublished - - author - title - - - - - isbn - - - issn - - - ismn - - - gender - - - - - - - sources.bib - - diff --git a/timerep.bcf-SAVE-ERROR b/timerep.bcf-SAVE-ERROR deleted file mode 100644 index d36ea3a..0000000 --- a/timerep.bcf-SAVE-ERROR +++ /dev/null @@ -1,2384 +0,0 @@ - - - - - - output_encoding - utf8 - - - input_encoding - utf8 - - - debug - 0 - - - mincrossrefs - 2 - - - minxrefs - 2 - - - sortcase - 1 - - - sortupper - 1 - - - - - - - alphaothers - + - - - extradatecontext - labelname - labeltitle - - - labelalpha - 0 - - - labelnamespec - shortauthor - author - shorteditor - editor - translator - - - labeltitle - 0 - - - labeltitlespec - shorttitle - title - maintitle - - - labeltitleyear - 0 - - - labeldateparts - 0 - - - labeldatespec - origdate - date - year - dateaddon - eventdate - nodate - - - julian - 0 - - - gregorianstart - 1582-10-15 - - - maxalphanames - 3 - - - maxbibnames - 99 - - - maxcitenames - 99 - - - maxsortnames - 99 - - - maxitems - 3 - - - minalphanames - 1 - - - minbibnames - 1 - - - mincitenames - 1 - - - minsortnames - 1 - - - minitems - 1 - - - nohashothers - 0 - - - noroman - 0 - - - nosortothers - 0 - - - pluralothers - 0 - - - singletitle - 0 - - - skipbib - 0 - - - skipbiblist - 0 - - - skiplab - 0 - - - sortalphaothers - + - - - sortlocale - english - - - sortingtemplatename - none - - - sortsets - 0 - - - uniquelist - false - - - uniquename - false - - - uniqueprimaryauthor - 0 - - - uniquetitle - 0 - - - uniquebaretitle - 0 - - - uniquework - 0 - - - useprefix - 0 - - - useafterword - 1 - - - useannotator - 1 - - - useauthor - 1 - - - usebookauthor - 1 - - - usecommentator - 1 - - - useeditor - 1 - - - useeditora - 1 - - - useeditorb - 1 - - - useeditorc - 1 - - - useforeword - 1 - - - useholder - 1 - - - useintroduction - 1 - - - usenamea - 1 - - - usenameb - 1 - - - usenamec - 1 - - - usetranslator - 0 - - - useshortauthor - 1 - - - useshorteditor - 1 - - - usesupervisor - 1 - - - - - - extradatecontext - labelname - labeltitle - - - labelalpha - 0 - - - labelnamespec - holder - shortauthor - author - shorteditor - editor - translator - - - labeltitle - 0 - - - labeltitlespec - shorttitle - title - maintitle - - - labeltitleyear - 0 - - - labeldateparts - 0 - - - labeldatespec - origdate - date - year - dateaddon - eventdate - nodate - - - maxalphanames - 3 - - - maxbibnames - 99 - - - maxcitenames - 99 - - - maxsortnames - 99 - - - maxitems - 3 - - - minalphanames - 1 - - - minbibnames - 1 - - - mincitenames - 1 - - - minsortnames - 1 - - - minitems - 1 - - - nohashothers - 0 - - - noroman - 0 - - - nosortothers - 0 - - - singletitle - 0 - - - skipbib - 0 - - - skipbiblist - 0 - - - skiplab - 0 - - - uniquelist - false - - - uniquename - false - - - uniqueprimaryauthor - 0 - - - uniquetitle - 0 - - - uniquebaretitle - 0 - - - uniquework - 0 - - - useprefix - 0 - - - useafterword - 1 - - - useannotator - 1 - - - useauthor - 1 - - - usebookauthor - 1 - - - usecommentator - 1 - - - useeditor - 1 - - - useeditora - 1 - - - useeditorb - 1 - - - useeditorc - 1 - - - useforeword - 1 - - - useholder - 1 - - - useintroduction - 1 - - - usenamea - 1 - - - usenameb - 1 - - - usenamec - 1 - - - usetranslator - 0 - - - useshortauthor - 1 - - - useshorteditor - 1 - - - usesupervisor - 1 - - - - - datamodel - labelalphanametemplate - labelalphatemplate - inheritance - translit - uniquenametemplate - sortingnamekeytemplate - sortingtemplate - extradatespec - extradatecontext - labelnamespec - labeltitlespec - labeldatespec - controlversion - alphaothers - sortalphaothers - presort - texencoding - bibencoding - sortingtemplatename - sortlocale - language - autolang - langhook - indexing - hyperref - backrefsetstyle - block - pagetracker - citecounter - citetracker - ibidtracker - idemtracker - opcittracker - loccittracker - labeldate - labeltime - dateera - date - time - eventdate - eventtime - origdate - origtime - urldate - urltime - alldatesusetime - alldates - alltimes - gregorianstart - autocite - notetype - uniquelist - uniquename - refsection - refsegment - citereset - sortlos - babel - datelabel - backrefstyle - arxiv - familyinits - giveninits - prefixinits - suffixinits - useafterword - useannotator - useauthor - usebookauthor - usecommentator - useeditor - useeditora - useeditorb - useeditorc - useforeword - useholder - useintroduction - usenamea - usenameb - usenamec - usetranslator - useshortauthor - useshorteditor - usesupervisor - debug - loadfiles - safeinputenc - sortcase - sortupper - terseinits - abbreviate - dateabbrev - clearlang - sortcites - sortsets - backref - backreffloats - trackfloats - parentracker - labeldateusetime - datecirca - dateuncertain - dateusetime - eventdateusetime - origdateusetime - urldateusetime - julian - datezeros - timezeros - timezones - seconds - autopunct - punctfont - labelnumber - labelalpha - labeltitle - labeltitleyear - labeldateparts - pluralothers - nohashothers - nosortothers - noroman - singletitle - uniquetitle - uniquebaretitle - uniquework - uniqueprimaryauthor - defernumbers - locallabelwidth - bibwarn - useprefix - skipbib - skipbiblist - skiplab - dataonly - defernums - firstinits - sortfirstinits - sortgiveninits - labelyear - spacecolon - pagetotal - shortnumeration - thesisinfoinnotes - url - isbn - doi - eprint - articlepubinfo - currentlang - noenddot - bibtexcaseprotection - mincrossrefs - minxrefs - maxnames - minnames - maxbibnames - minbibnames - maxcitenames - mincitenames - maxsortnames - minsortnames - maxitems - minitems - maxalphanames - minalphanames - maxparens - dateeraauto - - - alphaothers - sortalphaothers - presort - indexing - citetracker - ibidtracker - idemtracker - opcittracker - loccittracker - uniquelist - uniquename - familyinits - giveninits - prefixinits - suffixinits - useafterword - useannotator - useauthor - usebookauthor - usecommentator - useeditor - useeditora - useeditorb - useeditorc - useforeword - useholder - useintroduction - usenamea - usenameb - usenamec - usetranslator - useshortauthor - useshorteditor - usesupervisor - terseinits - abbreviate - dateabbrev - clearlang - labelnumber - labelalpha - labeltitle - labeltitleyear - labeldateparts - nohashothers - nosortothers - noroman - singletitle - uniquetitle - uniquebaretitle - uniquework - uniqueprimaryauthor - useprefix - skipbib - skipbiblist - skiplab - dataonly - skiplos - labelyear - bibtexcaseprotection - labelalphatemplate - translit - sortexclusion - sortinclusion - extradatecontext - labelnamespec - labeltitlespec - labeldatespec - maxnames - minnames - maxbibnames - minbibnames - maxcitenames - mincitenames - maxsortnames - minsortnames - maxitems - minitems - maxalphanames - minalphanames - - - noinherit - nametemplates - labelalphanametemplatename - uniquenametemplatename - sortingnamekeytemplatename - presort - indexing - citetracker - ibidtracker - idemtracker - opcittracker - loccittracker - uniquelist - uniquename - familyinits - giveninits - prefixinits - suffixinits - useafterword - useannotator - useauthor - usebookauthor - usecommentator - useeditor - useeditora - useeditorb - useeditorc - useforeword - useholder - useintroduction - usenamea - usenameb - usenamec - usetranslator - useshortauthor - useshorteditor - usesupervisor - terseinits - abbreviate - dateabbrev - clearlang - labelnumber - labelalpha - labeltitle - labeltitleyear - labeldateparts - nohashothers - nosortothers - noroman - singletitle - uniquetitle - uniquebaretitle - uniquework - uniqueprimaryauthor - useprefix - skipbib - skipbiblist - skiplab - dataonly - skiplos - bibtexcaseprotection - maxnames - minnames - maxbibnames - minbibnames - maxcitenames - mincitenames - maxsortnames - minsortnames - maxitems - minitems - maxalphanames - minalphanames - - - nametemplates - labelalphanametemplatename - uniquenametemplatename - sortingnamekeytemplatename - uniquelist - uniquename - familyinits - giveninits - prefixinits - suffixinits - terseinits - nohashothers - nosortothers - useprefix - - - nametemplates - labelalphanametemplatename - uniquenametemplatename - sortingnamekeytemplatename - uniquename - familyinits - giveninits - prefixinits - suffixinits - terseinits - useprefix - - - - - - - - - - - - - - - - - - - patent - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - prefix - family - - - - - shorthand - label - labelname - labelname - - - year - - - - - - labelyear - year - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - prefix - family - given - - - - - prefix - family - - - given - - - suffix - - - prefix - - - mm - - - - sf,sm,sn,pf,pm,pn,pp - family,given,prefix,suffix - boolean,integer,string,xml - default,transliteration,transcription,translation - - - article - artwork - audio - bibnote - book - bookinbook - booklet - collection - commentary - customa - customb - customc - customd - custome - customf - dataset - inbook - incollection - inproceedings - inreference - image - jurisdiction - legal - legislation - letter - manual - misc - movie - music - mvcollection - mvreference - mvproceedings - mvbook - online - patent - performance - periodical - proceedings - reference - report - review - set - software - standard - suppbook - suppcollection - suppperiodical - thesis - unpublished - video - xdata - - - sortyear - volume - volumes - abstract - addendum - annotation - booksubtitle - booktitle - booktitleaddon - chapter - edition - eid - entrysubtype - eprintclass - eprinttype - eventtitle - eventtitleaddon - gender - howpublished - indexsorttitle - indextitle - isan - isbn - ismn - isrn - issn - issue - issuesubtitle - issuetitle - issuetitleaddon - iswc - journalsubtitle - journaltitle - journaltitleaddon - label - langid - langidopts - library - mainsubtitle - maintitle - maintitleaddon - nameaddon - note - number - origtitle - pagetotal - part - relatedstring - relatedtype - reprinttitle - series - shorthandintro - subtitle - title - titleaddon - usera - userb - userc - userd - usere - userf - venue - version - shorthand - shortjournal - shortseries - shorttitle - sorttitle - sortshorthand - sortkey - presort - institution - lista - listb - listc - listd - liste - listf - location - organization - origlocation - origpublisher - publisher - afterword - annotator - author - bookauthor - commentator - editor - editora - editorb - editorc - foreword - holder - introduction - namea - nameb - namec - translator - shortauthor - shorteditor - sortname - authortype - editoratype - editorbtype - editorctype - editortype - bookpagination - nameatype - namebtype - namectype - pagination - pubstate - type - language - origlanguage - crossref - xref - date - endyear - year - month - day - hour - minute - second - timezone - yeardivision - endmonth - endday - endhour - endminute - endsecond - endtimezone - endyeardivision - eventdate - eventendyear - eventyear - eventmonth - eventday - eventhour - eventminute - eventsecond - eventtimezone - eventyeardivision - eventendmonth - eventendday - eventendhour - eventendminute - eventendsecond - eventendtimezone - eventendyeardivision - origdate - origendyear - origyear - origmonth - origday - orighour - origminute - origsecond - origtimezone - origyeardivision - origendmonth - origendday - origendhour - origendminute - origendsecond - origendtimezone - origendyeardivision - urldate - urlendyear - urlyear - urlmonth - urlday - urlhour - urlminute - urlsecond - urltimezone - urlyeardivision - urlendmonth - urlendday - urlendhour - urlendminute - urlendsecond - urlendtimezone - urlendyeardivision - doi - eprint - file - verba - verbb - verbc - url - xdata - ids - entryset - related - keywords - options - relatedoptions - pages - execute - supervisor - dateaddon - - - abstract - annotation - authortype - bookpagination - crossref - day - doi - eprint - eprintclass - eprinttype - endday - endhour - endminute - endmonth - endsecond - endtimezone - endyear - endyeardivision - entryset - entrysubtype - execute - file - gender - hour - ids - indextitle - indexsorttitle - isan - ismn - iswc - keywords - label - langid - langidopts - library - lista - listb - listc - listd - liste - listf - minute - month - namea - nameb - namec - nameatype - namebtype - namectype - nameaddon - options - origday - origendday - origendhour - origendminute - origendmonth - origendsecond - origendtimezone - origendyear - origendyeardivision - orighour - origminute - origmonth - origsecond - origtimezone - origyear - origyeardivision - origlocation - origpublisher - origtitle - pagination - presort - related - relatedoptions - relatedstring - relatedtype - second - shortauthor - shorteditor - shorthand - shorthandintro - shortjournal - shortseries - shorttitle - sortkey - sortname - sortshorthand - sorttitle - sortyear - timezone - url - urlday - urlendday - urlendhour - urlendminute - urlendmonth - urlendsecond - urlendtimezone - urlendyear - urlhour - urlminute - urlmonth - urlsecond - urltimezone - urlyear - usera - userb - userc - userd - usere - userf - verba - verbb - verbc - xdata - xref - year - yeardivision - - - set - entryset - - - article - addendum - annotator - author - commentator - editor - editora - editorb - editorc - editortype - editoratype - editorbtype - editorctype - eid - issn - issue - issuetitle - issuesubtitle - issuetitleaddon - journalsubtitle - journaltitle - journaltitleaddon - language - note - number - origlanguage - pages - pubstate - series - subtitle - title - titleaddon - translator - version - volume - - - bibnote - note - - - book - author - addendum - afterword - annotator - chapter - commentator - edition - editor - editora - editorb - editorc - editortype - editoratype - editorbtype - editorctype - eid - foreword - introduction - isbn - language - location - maintitle - maintitleaddon - mainsubtitle - note - number - origlanguage - pages - pagetotal - part - publisher - pubstate - series - subtitle - title - titleaddon - translator - volume - volumes - - - mvbook - addendum - afterword - annotator - author - commentator - edition - editor - editora - editorb - editorc - editortype - editoratype - editorbtype - editorctype - foreword - introduction - isbn - language - location - note - number - origlanguage - pagetotal - publisher - pubstate - series - subtitle - title - titleaddon - translator - volume - volumes - - - inbook - bookinbook - suppbook - addendum - afterword - annotator - author - booktitle - bookauthor - booksubtitle - booktitleaddon - chapter - commentator - edition - editor - editora - editorb - editorc - editortype - editoratype - editorbtype - editorctype - eid - foreword - introduction - isbn - language - location - mainsubtitle - maintitle - maintitleaddon - note - number - origlanguage - part - publisher - pages - pubstate - series - subtitle - title - titleaddon - translator - volume - volumes - - - booklet - addendum - author - chapter - editor - editortype - eid - howpublished - language - location - note - pages - pagetotal - pubstate - subtitle - title - titleaddon - type - - - collection - reference - addendum - afterword - annotator - chapter - commentator - edition - editor - editora - editorb - editorc - editortype - editoratype - editorbtype - editorctype - eid - foreword - introduction - isbn - language - location - mainsubtitle - maintitle - maintitleaddon - note - number - origlanguage - pages - pagetotal - part - publisher - pubstate - series - subtitle - title - titleaddon - translator - volume - volumes - - - mvcollection - mvreference - addendum - afterword - annotator - author - commentator - edition - editor - editora - editorb - editorc - editortype - editoratype - editorbtype - editorctype - foreword - introduction - isbn - language - location - note - number - origlanguage - publisher - pubstate - subtitle - title - titleaddon - translator - volume - volumes - - - incollection - suppcollection - inreference - addendum - afterword - annotator - author - booksubtitle - booktitle - booktitleaddon - chapter - commentator - edition - editor - editora - editorb - editorc - editortype - editoratype - editorbtype - editorctype - eid - foreword - introduction - isbn - language - location - mainsubtitle - maintitle - maintitleaddon - note - number - origlanguage - pages - part - publisher - pubstate - series - subtitle - title - titleaddon - translator - volume - volumes - - - dataset - addendum - author - edition - editor - editortype - language - location - note - number - organization - publisher - pubstate - series - subtitle - title - titleaddon - type - version - - - manual - addendum - author - chapter - edition - editor - editortype - eid - isbn - language - location - note - number - organization - pages - pagetotal - publisher - pubstate - series - subtitle - title - titleaddon - type - version - - - misc - software - addendum - author - editor - editortype - howpublished - language - location - note - organization - pubstate - subtitle - title - titleaddon - type - version - - - online - addendum - author - editor - editortype - language - note - organization - pubstate - subtitle - title - titleaddon - version - - - patent - addendum - author - holder - location - note - number - pubstate - subtitle - title - titleaddon - type - version - - - periodical - addendum - editor - editora - editorb - editorc - editortype - editoratype - editorbtype - editorctype - issn - issue - issuesubtitle - issuetitle - issuetitleaddon - language - note - number - pubstate - series - subtitle - title - titleaddon - volume - yeardivision - - - mvproceedings - addendum - editor - editortype - eventday - eventendday - eventendhour - eventendminute - eventendmonth - eventendsecond - eventendtimezone - eventendyear - eventendyeardivision - eventhour - eventminute - eventmonth - eventsecond - eventtimezone - eventyear - eventyeardivision - eventtitle - eventtitleaddon - isbn - language - location - note - number - organization - pagetotal - publisher - pubstate - series - subtitle - title - titleaddon - venue - volumes - - - proceedings - addendum - chapter - editor - editortype - eid - eventday - eventendday - eventendhour - eventendminute - eventendmonth - eventendsecond - eventendtimezone - eventendyear - eventendyeardivision - eventhour - eventminute - eventmonth - eventsecond - eventtimezone - eventyear - eventyeardivision - eventtitle - eventtitleaddon - isbn - language - location - mainsubtitle - maintitle - maintitleaddon - note - number - organization - pages - pagetotal - part - publisher - pubstate - series - subtitle - title - titleaddon - venue - volume - volumes - - - inproceedings - addendum - author - booksubtitle - booktitle - booktitleaddon - chapter - editor - editortype - eid - eventday - eventendday - eventendhour - eventendminute - eventendmonth - eventendsecond - eventendtimezone - eventendyear - eventendyeardivision - eventhour - eventminute - eventmonth - eventsecond - eventtimezone - eventyear - eventyeardivision - eventtitle - eventtitleaddon - isbn - language - location - mainsubtitle - maintitle - maintitleaddon - note - number - organization - pages - part - publisher - pubstate - series - subtitle - title - titleaddon - venue - volume - volumes - - - report - addendum - author - chapter - eid - institution - isrn - language - location - note - number - pages - pagetotal - pubstate - subtitle - title - titleaddon - type - version - - - thesis - addendum - author - chapter - eid - institution - language - location - note - pages - pagetotal - pubstate - subtitle - title - titleaddon - type - - - unpublished - addendum - author - eventday - eventendday - eventendhour - eventendminute - eventendmonth - eventendsecond - eventendtimezone - eventendyear - eventendyeardivision - eventhour - eventminute - eventmonth - eventsecond - eventtimezone - eventyear - eventyeardivision - eventtitle - eventtitleaddon - howpublished - language - location - note - pubstate - subtitle - title - titleaddon - type - venue - - - thesis - supervisor - - - dateaddon - - - abstract - addendum - afterword - annotator - author - bookauthor - booksubtitle - booktitle - booktitleaddon - chapter - commentator - editor - editora - editorb - editorc - foreword - holder - institution - introduction - issuesubtitle - issuetitle - issuetitleaddon - journalsubtitle - journaltitle - journaltitleaddon - location - mainsubtitle - maintitle - maintitleaddon - nameaddon - note - organization - origlanguage - origlocation - origpublisher - origtitle - part - publisher - relatedstring - series - shortauthor - shorteditor - shorthand - shortjournal - shortseries - shorttitle - sortname - sortshorthand - sorttitle - subtitle - title - titleaddon - translator - venue - - - article - book - inbook - bookinbook - suppbook - booklet - collection - incollection - suppcollection - manual - misc - mvbook - mvcollection - online - patent - periodical - suppperiodical - proceedings - inproceedings - reference - inreference - report - set - thesis - unpublished - - - date - year - - - - - set - - entryset - - - - article - - author - journaltitle - title - - - - book - mvbook - - author - title - - - - inbook - bookinbook - suppbook - - author - title - booktitle - - - - booklet - - - author - editor - - title - - - - collection - reference - mvcollection - mvreference - - editor - title - - - - incollection - suppcollection - inreference - - author - editor - title - booktitle - - - - dataset - - title - - - - manual - - title - - - - misc - software - - title - - - - online - - title - - url - doi - eprint - - - - - patent - - author - title - number - - - - periodical - - editor - title - - - - proceedings - mvproceedings - - title - - - - inproceedings - - author - title - booktitle - - - - report - - author - title - type - institution - - - - thesis - - author - title - type - institution - - - - unpublished - - author - title - - - - - isbn - - - issn - - - ismn - - - gender - - - - - - - sources.bib - - -- cgit v1.2.3 From 0ec722995614e4cfe24dcf1102e2726ad0bbe759 Mon Sep 17 00:00:00 2001 From: WBoerenkamps Date: Mon, 9 Sep 2024 12:34:18 +0200 Subject: added some research into sfml and sdl2 --- research.tex | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 52 insertions(+), 5 deletions(-) diff --git a/research.tex b/research.tex index 3938cf1..691c55a 100644 --- a/research.tex +++ b/research.tex @@ -45,10 +45,59 @@ To assign properties and functions to entities, components are used. Entt is an example of an ECS. \subsection{Conclusion} + \section{3rd Party Tools} + \subsection{Introduction} + Developing a game engine from scratch requires a significant amount of time, as many different features are necessary. + Fortunately, some of these features have already been developed and can be reused in the form of frameworks and 3rd party tools/libraries. The decision to use 3rd party libraries, and the selection of which ones to use, directly influences the development process of the game engine. In this section, several 3rd party frameworks and tools available for use are described. -\section{3rd party tools} - \subsection{Introduction} - \subsection{Findings} + \subsection{Findings} + \subsubsection{Media Frameworks} + A game engine must have the ability to handle user input, render graphics, and process audio. Several large frameworks are available that provide these features and are already widely used by other game engines. + The two most popular and best-supported options are SDL2 and SFML. + + \emph{SDL2} + + According to its official website, SDL2 (Simple DirectMedia Layer) "is a cross-platform development library designed to provide low-level access to audio, keyboard, mouse, joystick, and graphics hardware via OpenGL and Direct3D. It is used by video playback software, emulators, and popular games, including Valve's award-winning catalog and many Humble Bundle games." + SDL2 is written in the C programming language, and therefore, structs and functions are used instead of objects and methods. + + The advantages of SDL2 are: + \begin{itemize} + \item Controller support is provided. + \item 2D and 3D rendering are supported. + \item Broad multiplatform support is offered, including older consoles such as the Wii. + \item Low-level control is available. + \item A large community ensures wide usage. + \item Extended libraries can be used to add functionalities, such as SDL\_Mixer for sound. + \end{itemize} + + The disadvantages of SDL2 are: + \begin{itemize} + \item A limited built-in 2D renderer is provided. + \item Extended libraries require setup. + \end{itemize} + + \emph{SFML} + + SFML (Simple and Fast Multimedia Library) is a simple framework consisting of five modules: audio, graphics, network, system, and window. This framework, written in C++, was designed to simplify game development. + + The advantages of SFML are: + \begin{itemize} + \item Object-oriented design is provided since it is written in C++. + \item A built-in 2D renderer is available for ease of use. + \item A built-in audio system is included. + \item Cross-platform support is available for Linux, Windows, and macOS. + \item Networking capabilities are provided for multiplayer or networked applications. + \end{itemize} + + The disadvantages of SFML are: + \begin{itemize} + \item The 2D rendering engine may experience performance issues in large-scale games. + \item The community is smaller compared to SDL2. + \item No native 3D support is provided. + \item Not all image formats are supported. + \end{itemize} + \subsubsection{Audio} + for audio some options could be: FMOD, Wwise, or iirKlang \subsection{Conclusion} \section{Gameloop/resource manager} \subsection{Introduction} @@ -60,8 +109,6 @@ \subsection{Conclusion} \section{Event manager} \subsection{Introduction} - The event manager is responsible for handling input. The system is notified when an input or event occurs. - The layers can subscribe to these events and respond to them. A method for querying the state of an input or event, such as the mouse position, should also be provided by the engine. \subsection{Findings} \subsection{Conclusion} \section{Memory/debugging} -- cgit v1.2.3 From 43e2b33c16459899ff9351d1d620b50ba221b51c Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Mon, 9 Sep 2024 14:06:24 +0200 Subject: update time.txt --- time.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/time.txt b/time.txt index ebd4d3b..8a3f063 100644 --- a/time.txt +++ b/time.txt @@ -11,6 +11,7 @@ loek: 2024-09-05 15m repository scaffolding :: additional latex contributing gui loek: 2024-09-05 1h40m project meeting loek: 2024-09-05 1h24m time report script loek: 2024-09-06 55m time report script +loek: 2024-09-09 30m feedback :: niels code style guide max: 2024-09-02 1h project meeting :: project kickoff max: 2024-09-02 45m project meeting -- cgit v1.2.3 From eecaf177ea63fe1da21644427f1388428744205d Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Mon, 9 Sep 2024 14:49:23 +0200 Subject: add glossary + format LaTeX code --- .vscode/settings.json | 4 + contributing.md | 3 +- glossary.bib | 30 +++++ latexmkrc | 45 ++++++++ projdoc.cls | 42 +++++-- research.tex | 299 +++++++++++++++++++++++++++++++------------------- 6 files changed, 301 insertions(+), 122 deletions(-) create mode 100644 glossary.bib diff --git a/.vscode/settings.json b/.vscode/settings.json index 72f0e6b..25effcc 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,4 +1,8 @@ { + "editor.wordWrap": "wordWrapColumn", + "editor.wrappingIndent": "same", + "editor.wordWrapColumn": 85, + "files.trimTrailingWhitespace": true, "latex-workshop.latex.recipe.default": "latexmk", "latex-workshop.latex.tools": [ { diff --git a/contributing.md b/contributing.md index 770d02e..dd51532 100644 --- a/contributing.md +++ b/contributing.md @@ -15,7 +15,8 @@ other document. - Images should be placed in the img/ folder - Labels and bibliography keys should only consist of characters from the following set: `[a-z0-9:-]` (lower-case, numbers, colon, dash). -- Quotes are opened with the tilde (`) +- Quotes are opened with a backtick (`) +- Only environments indent the LaTeX source code # Banned practices diff --git a/glossary.bib b/glossary.bib new file mode 100644 index 0000000..4d02e4a --- /dev/null +++ b/glossary.bib @@ -0,0 +1,30 @@ +@abbreviation{ecs, + short = {ECS}, + long = {Entity-Component System}, +} + +@abbreviation{hid, + short = {HID}, + long = {Human Interface Device}, +} + +@abbreviation{sdl2, + short = {SDL2}, + long = {Simple DirectMedia Layer}, +} + +@abbreviation{sfml, + short = {SFML}, + long = {Simple and Fast Multimedia Library}, +} + +@entry{opengl, + name = {OpenGL}, + description = {Open-source graphics library}, +} + +@entry{d3d, + name = {Direct3D}, + description = {Graphics library developed by \hbox{Microsoft}}, +} + diff --git a/latexmkrc b/latexmkrc index ad6c178..66ed0d1 100644 --- a/latexmkrc +++ b/latexmkrc @@ -2,3 +2,48 @@ $pdflatex = "xelatex %O %S"; $pdf_mode = 1; $dvi_mode = 0; $postscript_mode = 0; + +# https://tex.stackexchange.com/questions/400325/latexmkrc-for-bib2gls +add_cus_dep('glo', 'gls', 0, 'run_makeglossaries'); +add_cus_dep('acn', 'acr', 0, 'run_makeglossaries'); +add_cus_dep('aux', 'glstex', 0, 'run_bib2gls'); + +sub run_makeglossaries { + if ( $silent ) { + system "makeglossaries -q '$_[0]'"; + } else { + system "makeglossaries '$_[0]'"; + }; +} + +sub run_bib2gls { + if ( $silent ) { + my $ret = system "bib2gls --silent --group '$_[0]'"; + } else { + my $ret = system "bib2gls --group '$_[0]'"; + }; + my ($base, $path) = fileparse( $_[0] ); + if ($path && -e "$base.glstex") { + rename "$base.glstex", "$path$base.glstex"; + } + # Analyze log file. + local *LOG; + $LOG = "$_[0].glg"; + if (!$ret && -e $LOG) { + open LOG, "<$LOG"; + while () { + if (/^Reading (.*\.bib)\s$/) { + rdb_ensure_file( $rule, $1 ); + } + } + close LOG; + } + return $ret; +} + +push @file_not_found, '^Package .* No file `([^\\\']*)\\\''; +push @generated_exts, 'glo', 'gls', 'glg'; +push @generated_exts, 'acn', 'acr', 'alg'; +$clean_ext .= ' %R.ist %R.xdy'; +$clean_ext .= ' bbl run.xml'; + diff --git a/projdoc.cls b/projdoc.cls index c6abaca..503f049 100644 --- a/projdoc.cls +++ b/projdoc.cls @@ -14,6 +14,18 @@ \PassOptionsToPackage{nosort}{cleveref} \PassOptionsToPackage{nameinlink}{cleveref} \PassOptionsToPackage{obeyspaces}{url} +\PassOptionsToPackage{toc=false}{glossaries} +\PassOptionsToPackage{record}{glossaries-extra} +\PassOptionsToPackage{ + backend=biber, + bibencoding=utf8, + style=iso-numeric, + % Technically, Avans University of Applied Sciences requires that we always use APA + % style references, but this often results in ugly citations when working with + % technical or online resources. At the end of the day, the bibliography is there + % to prove we didn't plagiarize or make shit up, so ISO 690 is *probably* fine. + autocite=plain, +}{biblatex} % frequently used packages \RequirePackage{geometry} @@ -38,9 +50,13 @@ \RequirePackage{cleveref} \RequirePackage{adjustbox} \RequirePackage{xparse} +\RequirePackage{biblatex} +\RequirePackage{glossaries} +\RequirePackage{glossaries-extra} \RequirePackage{ifdraft} \RequirePackage{enumitem} \RequirePackage{subcaption} +\RequirePackage{multicol} % font style \setmainfont{TeX Gyre Schola} @@ -171,18 +187,14 @@ \makeatother % bibliography -\usepackage[ - backend=biber, - bibencoding=utf8, - style=iso-numeric, - % Technically, Avans University of Applied Sciences requires that we always use APA - % style references, but this often results in ugly citations when working with - % technical or online resources. At the end of the day, the bibliography is there - % to prove we didn't plagiarize or make shit up, so ISO 690 is *probably* fine. - autocite=plain, -]{biblatex} \addbibresource{sources.bib} +% glossary +\GlsXtrLoadResources[ + src={./glossary.bib}, + selection={recorded and deps and see}, +] + % default document header/trailer \makeatletter \def\projdoc@header{ @@ -196,8 +208,16 @@ \newbool{projdoc@cited} \apptocmd{\abx@aux@cite}{\global\booltrue{projdoc@cited}}{}{} \def\projdoc@trailer{ - % end with bibliography (if citations used) + % bibliography (if citations used) \ifbool{projdoc@cited}{\printbibliography}{}% + % glossary + \ifcsundef{printunsrtglossary}{}{% + \section*{Glossary}% + \begin{multicols}{2}% + \renewcommand{\glossarysection}[2][]{}% + \printunsrtglossary% + \end{multicols}% + }% } \AtBeginDocument{\projdoc@header} \AtEndDocument{\projdoc@trailer} diff --git a/research.tex b/research.tex index 691c55a..ca2afed 100644 --- a/research.tex +++ b/research.tex @@ -5,124 +5,203 @@ \begin{document} \tablestables +\newpage + \section{Introduction} + \section{Game engine} - \subsection{Introduction} - To build a game engine, it must first be understood how it operates. - The functionalities it requires and how these functionalities work together must be determined. - In this section, the general functioning of a game engine and the different parts required are described. - \subsection{Findings} - A game engine is not the game itself but a platform with which games are built. It should provide the functionalities with which the game is constructed. - The purpose of a game engine is not to create data out of nothing. Instead, data is read, and the correlating features and effects are generated. - However, the engine is also used to create these files, referred to as "assets." The game engine must be able to accept a certain format of these assets—whether levels, sprites, or textures—and convert them into usable data. - \subsubsection{Layers} - A game engine is composed of multiple layers, each with its own functions. These layers are divided into the following categories: - \begin{itemize} - \item Resource manager: Responsible for what happens when the engine is launched, including loading data formats. - \item Application: Manages the run loop, time, code execution, and events (e.g., input events). - \item Window/HID (Human Interface Devices): Handles input and events. - \item Renderer: Responsible for drawing the necessary objects on the screen, usually once per frame. - \item Debugging support: Provides testing for the engine, such as logging or performance profiling. - \item Scripting layer: Runs scripts, such as Lua or Python. - \item Memory systems: Handles and monitors memory usage. - \item Entity-Component System (ECS): Provides a modular way to create game objects, add physics, and define how the engine interacts with objects. - \item Physics: Adds specific physics to objects. - \item Audio: Processes audio. - \item AI: Provides artificial inteligent behavior. - \end{itemize} - - \subsubsection{ECS} - A game engine must have the ability to keep track and update several game objects. To do this most game engines employ an ECS model which uses modulair components to give entities properties and features. - The need for an entity component system arises because multiple game objects are required to create a scene in a game. These game objects exist within the scene and perform actions, such as a UI display for a score. - This game object does not need to be rendered; it could be a script running in the background. - It could also be a player sprite that is controlled. - These entities need to be aware of other entities, for example, during collisions. - For this to function, a scene is required to host all game objects. - Within this scene, the game objects must be stored efficiently, and entities must be provided with the required behavior, such as audio, position, or physics. - To create diverse entities with specific functions: - A scene can contain many different kinds of entities, each with different properties and functions. - But no matter how different each entity is, it remains an entity. - To assign properties and functions to entities, components are used. - Entt is an example of an ECS. - \subsection{Conclusion} - \section{3rd Party Tools} - \subsection{Introduction} - Developing a game engine from scratch requires a significant amount of time, as many different features are necessary. - Fortunately, some of these features have already been developed and can be reused in the form of frameworks and 3rd party tools/libraries. The decision to use 3rd party libraries, and the selection of which ones to use, directly influences the development process of the game engine. In this section, several 3rd party frameworks and tools available for use are described. - - \subsection{Findings} - \subsubsection{Media Frameworks} - A game engine must have the ability to handle user input, render graphics, and process audio. Several large frameworks are available that provide these features and are already widely used by other game engines. - The two most popular and best-supported options are SDL2 and SFML. - - \emph{SDL2} - - According to its official website, SDL2 (Simple DirectMedia Layer) "is a cross-platform development library designed to provide low-level access to audio, keyboard, mouse, joystick, and graphics hardware via OpenGL and Direct3D. It is used by video playback software, emulators, and popular games, including Valve's award-winning catalog and many Humble Bundle games." - SDL2 is written in the C programming language, and therefore, structs and functions are used instead of objects and methods. - - The advantages of SDL2 are: - \begin{itemize} - \item Controller support is provided. - \item 2D and 3D rendering are supported. - \item Broad multiplatform support is offered, including older consoles such as the Wii. - \item Low-level control is available. - \item A large community ensures wide usage. - \item Extended libraries can be used to add functionalities, such as SDL\_Mixer for sound. - \end{itemize} - - The disadvantages of SDL2 are: - \begin{itemize} - \item A limited built-in 2D renderer is provided. - \item Extended libraries require setup. - \end{itemize} - - \emph{SFML} - - SFML (Simple and Fast Multimedia Library) is a simple framework consisting of five modules: audio, graphics, network, system, and window. This framework, written in C++, was designed to simplify game development. - - The advantages of SFML are: - \begin{itemize} - \item Object-oriented design is provided since it is written in C++. - \item A built-in 2D renderer is available for ease of use. - \item A built-in audio system is included. - \item Cross-platform support is available for Linux, Windows, and macOS. - \item Networking capabilities are provided for multiplayer or networked applications. - \end{itemize} - - The disadvantages of SFML are: - \begin{itemize} - \item The 2D rendering engine may experience performance issues in large-scale games. - \item The community is smaller compared to SDL2. - \item No native 3D support is provided. - \item Not all image formats are supported. - \end{itemize} - \subsubsection{Audio} - for audio some options could be: FMOD, Wwise, or iirKlang - \subsection{Conclusion} + +\subsection{Introduction} + +To build a game engine, it must first be understood how it operates. The +functionalities it requires and how these functionalities work together must be +determined. In this section, the general functioning of a game engine and the +different parts required are described. + +\subsection{Findings} + +A game engine is not the game itself but a platform with which games are built. It +should provide the functionalities with which the game is constructed. The purpose of +a game engine is not to create data out of nothing. Instead, data is read, and the +correlating features and effects are generated. However, the engine is also used to +create these files, referred to as ``assets.'' The game engine must be able to accept +a certain format of these assets---whether levels, sprites, or textures---and convert +them into usable data. + +\subsubsection{Layers} + +A game engine is composed of multiple layers, each with its own functions. These +layers are divided into the following categories:\noparbreak +\begin{description} + \item[Resource manager] Responsible for what happens when the engine is launched, + including loading data formats. + \item[Application] Manages the run loop, time, code execution, and events + (e.g.~input events). + \item[Window/\glspl{hid}] Handles input and events. + \item[Renderer] Responsible for drawing the necessary objects on the screen, + usually once per frame. + \item[Debugging support] Provides testing for the engine, such as logging or + performance profiling. + \item[Scripting layer] Runs scripts, such as Lua or Python. + \item[Memory systems] Handles and monitors memory usage. + \item[\gls{ecs}] Provides a modular way to create game objects, add physics, and + define how the engine interacts with objects. + \item[Physics] Adds specific physics to objects. + \item[Audio] Processes audio. + \item[AI] Provides artificial inteligent behavior. +\end{description} + +\subsubsection{ECS} + +A game engine must have the ability to keep track and update several game objects. To +do this most game engines employ an \gls{ecs} model which uses modulair components to +give entities properties and features. The need for an entity component system arises +because multiple game objects are required to create a scene in a game. These game +objects exist within the scene and perform actions, such as a UI display for a score. +This game object does not need to be rendered; it could be a script running in the +background. It could also be a player sprite that is controlled. These entities need +to be aware of other entities, for example, during collisions. For this to function, +a scene is required to host all game objects. Within this scene, the game objects +must be stored efficiently, and entities must be provided with the required behavior, +such as audio, position, or physics. To create diverse entities with specific +functions: A scene can contain many different kinds of entities, each with different +properties and functions. But no matter how different each entity is, it remains an +entity. To assign properties and functions to entities, components are used. Entt is +an example of an \gls{ecs}. +% TODO: ref?entt + +\subsection{Conclusion} + +\section{Third-party Tools} + +\subsection{Introduction} + +Developing a game engine from scratch requires a significant amount of time, as many +different features are necessary. Fortunately, some of these features have already +been developed and can be reused in the form of frameworks and third-party +tools/libraries. The decision to use third-party libraries, and the selection of +which ones to use, directly influences the development process of the game engine. In +this section, several third-party frameworks and tools available for use are +described. + +\subsection{Findings} + +\subsubsection{Media Frameworks} + +A game engine must have the ability to handle user input, render graphics, and +process audio. Several large frameworks are available that provide these features and +are already widely used by other game engines. The two most popular and +best-supported options are \gls{sdl2} and \gls{sfml}. + +\paragraph{SDL2} + +% TODO: ref?sdl2 +According to its official website, \gls{sdl2} is \emph{``a cross-platform development +library designed to provide low-level access to audio, keyboard, mouse, joystick, and +graphics hardware via \gls{opengl} and \gls{d3d}. It is used by video playback +software, emulators, and popular games, including Valve's award-winning catalog and +many Humble Bundle games.''} \gls{sdl2} is written in the C programming language, and +therefore, structs and functions are used instead of objects and methods. + +The advantages of \gls{sdl2} are:\noparbreak +\begin{itemize} + \item Controller support is provided. + \item 2D and 3D rendering are supported. + \item Broad multiplatform support is offered, including older consoles such as the + Wii. + \item Low-level control is available. + \item A large community ensures wide usage. + \item Extended libraries can be used to add functionalities, such as SDL\_Mixer for + sound. +\end{itemize} + +The disadvantages of \gls{sdl2} are:\noparbreak +\begin{itemize} + \item A limited built-in 2D renderer is provided. + \item Extended libraries require setup. +\end{itemize} + +\paragraph{SFML} + +\gls{sfml} is a simple framework consisting of five modules: audio, graphics, +network, system, and window. This framework, written in C++, was designed to simplify +game development. + +The advantages of \gls{sfml} are: +\begin{itemize} + \item Object-oriented design is provided since it is written in C++. + \item A built-in 2D renderer is available for ease of use. + \item A built-in audio system is included. + \item Cross-platform support is available for Linux, Windows, and macOS. + \item Networking capabilities are provided for multiplayer or networked + applications. +\end{itemize} + +The disadvantages of \gls{sfml} are: +\begin{itemize} + \item The 2D rendering engine may experience performance issues in large-scale + games. + \item The community is smaller compared to \gls{sdl2}. + \item No native 3D support is provided. + \item Not all image formats are supported. +\end{itemize} + +\subsubsection{Audio} + +for audio some options could be: FMOD, Wwise, or iirKlang + +\subsection{Conclusion} + \section{Gameloop/resource manager} - \subsection{Introduction} - \subsection{Findings} - \subsection{Conclusion} + +\subsection{Introduction} + +\subsection{Findings} + +\subsection{Conclusion} + \section{Rendering} - \subsection{Introduction} - \subsection{Findings} - \subsection{Conclusion} + +\subsection{Introduction} + +\subsection{Findings} + +\subsection{Conclusion} + \section{Event manager} - \subsection{Introduction} - \subsection{Findings} - \subsection{Conclusion} + +\subsection{Introduction} + +\subsection{Findings} + +\subsection{Conclusion} + \section{Memory/debugging} - \subsection{Introduction} - \subsection{Findings} - \subsection{Conclusion} + +\subsection{Introduction} + +\subsection{Findings} + +\subsection{Conclusion} + \section{Physics/scripting} - \subsection{Introduction} - \subsection{Findings} - \subsection{Conclusion} + +\subsection{Introduction} + +\subsection{Findings} + +\subsection{Conclusion} + \section{Conclusion} + \section{Gameobjects/components} - \subsection{Introduction} - \subsection{Findings} - \subsection{Conclusion} + +\subsection{Introduction} + +\subsection{Findings} + +\subsection{Conclusion} + \section{Conclusion} + \end{document} -- cgit v1.2.3 From 997649dc54801d31b14a8e8aa78394ab8f089c7f Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Mon, 9 Sep 2024 14:50:04 +0200 Subject: update time.txt --- time.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/time.txt b/time.txt index 8a3f063..5d4cc0a 100644 --- a/time.txt +++ b/time.txt @@ -12,6 +12,7 @@ loek: 2024-09-05 1h40m project meeting loek: 2024-09-05 1h24m time report script loek: 2024-09-06 55m time report script loek: 2024-09-09 30m feedback :: niels code style guide +loek: 2024-09-09 45m review :: wouter research PR#5 max: 2024-09-02 1h project meeting :: project kickoff max: 2024-09-02 45m project meeting -- cgit v1.2.3 From ec881fd9ce58f09e0be598e11c5f5820d8431eda Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Mon, 9 Sep 2024 15:19:51 +0200 Subject: flesh out document style guide --- contributing.md | 54 ++++++++++++++++++++++++++++++++++++++++++------------ style.md | 25 ++++++++++++++++++++++++- time.txt | 1 + 3 files changed, 67 insertions(+), 13 deletions(-) diff --git a/contributing.md b/contributing.md index dd51532..c11c834 100644 --- a/contributing.md +++ b/contributing.md @@ -10,13 +10,17 @@ other document. - Indent using tabs - Wrap long lines at column 80 -- Diacritical marks should be represented in ASCII using LaTeX syntax instead - of using UTF-8 (i.e. `fa\c{c}ade` instead of `façade`) +- ASCII only (LaTeX syntax should be used instead of UTF-8, i.e. `fa\c{c}ade` + instead of `façade`, `---` instead of `—`) - Images should be placed in the img/ folder - Labels and bibliography keys should only consist of characters from the following set: `[a-z0-9:-]` (lower-case, numbers, colon, dash). -- Quotes are opened with a backtick (`) +- Both single and double quotes are opened using backtick(s) + (`) and closed using single quote(s) (`'`), i.e. + ``like this'' or `this' - Only environments indent the LaTeX source code +- Insert a non-breaking space (`~`) after (Latin) abbreviations such as "i.e." + or "e.g.". Never place a comma after either of these. # Banned practices @@ -28,7 +32,7 @@ other document. command should be used instead. - **Using `\href`** - Add the source in sources.bib and cite this source instead. + Add the source in [sources.bib](#sources) and cite this source instead. - **Using `\textbf` or `\textit` to emphasize** Use `\emph`, single quotes or an em dash (`---`) instead. @@ -52,21 +56,47 @@ Please use prefixes to 'namespace' `\label`s: |Sections|`sec:`| |List items (i.e. `enumerate`/`itemize`)|`item:`| +These items can be referenced using the `\cref` command. + ## Sources Bibliography entries work with a similar label system (usually called *keys*). Since these exist in a registry separate from `\label` entries, these do not -need to be prefixed. +need to be prefixed. All sources are stored in [sources.bib](./sources.bib). +There is a very helpful [cheat sheet][biblatex-cheat-sheet] online that +showcases different entry types and their fields. -For consistency, the following format is preferred: `authority:topic`. The -`authority` part refers to a company, website or author, and `topic` refers to -a title, chip model number, etc. depending on the type of document being +For consistency, the following format for keys is preferred: `authority:topic`. +The `authority` part refers to a company, website or author, and `topic` refers +to a title, chip model number, etc. depending on the type of document being referenced. - +## Glossary + +Glossary entries are stored in [glossary.bib](./glossary.bib). This file has +the same structure as the bibliography, but with different key types: + +|type|usage| +|-|-| +|`@abbreviation`|Abbreviations (long version inserted on first occurrence)| +|`@acronym`|Acronyms (long version only in glossary)| +|`@entry`|Generic entries / words| + +The keys in the glossary do not have to be prefixed, and should be short as +they should be inserted frequently. Glossary entries can be used with the +following commands: + +|command|usage| +|-|-| +|`\gls{}`|regular| +|`\glspl{}`|plural| +|`\Gls{}`|capitalized (at start of sentence)| +|`\Glspl{}`|capitalized plural| + +> [!NOTE] +> Glossary entries should not be inserted in figure captions or section +> headings! [crepe-engine-contrib]: https://github.com/lonkaars/crepe/blob/master/contributing.md +[biblatex-cheat-sheet]: https://tug.ctan.org/info/biblatex-cheatsheet/biblatex-cheatsheet.pdf diff --git a/style.md b/style.md index bbddddf..c518e7c 100644 --- a/style.md +++ b/style.md @@ -1,3 +1,9 @@ +This document contains requirements for all project documentation. Specific +LaTeX commands and LaTeX source style requirements are detailed in +[contributing.md](./contributing.md), and [example.tex](./example.tex) contains +a number of frequently used snippets that may be used as a cheat-sheet style +reference. + # Fonts The documents use the following fonts. All of these are free and open source, @@ -23,7 +29,9 @@ workshop and VimTeX. # Spelling -All documentation is written in U.S. English +- All documentation is written in U.S. English +- Section headers are in sentence case (i.e. only the first word and proper + nouns are capitalized) # Grammar @@ -51,3 +59,18 @@ converted to PDF (e.g. using `svg2pdf` on linux). Raster images should only be used when the source is already in a raster format (e.g. for photos) or when otherwise impractical. +# References + +- When a library or piece of software is introduced in a document, reference + the project homepage using the bibliography. +- Direct quotations or paraphased text must be cited. +- Acronyms, abbreviations and jargon reference the glossary. +- All figures and tables must be referenced in the body text. Don't write + paragraphs that 'lead up' to figures, as this forces LaTeX to not break the + page between the paragraph and figure. + +# Document structure + +- Use `\section`, `\subsection`, `\subsubsection` and `\paragraph` to insert + headings. + diff --git a/time.txt b/time.txt index 5d4cc0a..086197a 100644 --- a/time.txt +++ b/time.txt @@ -13,6 +13,7 @@ loek: 2024-09-05 1h24m time report script loek: 2024-09-06 55m time report script loek: 2024-09-09 30m feedback :: niels code style guide loek: 2024-09-09 45m review :: wouter research PR#5 +loek: 2024-09-09 25m documentation style guide max: 2024-09-02 1h project meeting :: project kickoff max: 2024-09-02 45m project meeting -- cgit v1.2.3 From e34bef0a738c710e8c09894f6d9bc66abda4d3b2 Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Tue, 10 Sep 2024 12:10:21 +0200 Subject: update readme + time.txt --- readme.md | 15 ++++++++++++++- time.txt | 3 +++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index e8b3784..1375c5e 100644 --- a/readme.md +++ b/readme.md @@ -10,9 +10,22 @@ Please see [style.md](./style.md) for writing style and - A `latexmkrc` file is provided for copmilation with `latexmk`. The documents should also compile under [Visual Studio Code][vscode] using the [LaTeX Workshop extension][latexworkshop], as well as [VimTeX][vimtex]. +- A [makefile](./makefile) is used to compile other files (e.g. plantuml + diagrams, [time report](#time-report)) - These documents use fonts loaded using `fontspec`, please see [style.md](./style.md) for download links. -- A `makefile` is provided for compiling other files (e.g. plantuml diagrams) + +## Time report + +The time report document includes generated LaTeX code which can be compiled +from [time.txt](./time.txt) using [time2tex.py](./time2tex.py). The +[makefile](./makefile) includes a rule that does this, so `make timerep.pdf` +should be used to compile this document specifically. + +## Requirements + +TODO: how to store + cross-reference requirements w/o extra latex compilation +runs [vscode]: https://code.visualstudio.com [latexworkshop]: https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop diff --git a/time.txt b/time.txt index 086197a..db345f3 100644 --- a/time.txt +++ b/time.txt @@ -14,6 +14,9 @@ loek: 2024-09-06 55m time report script loek: 2024-09-09 30m feedback :: niels code style guide loek: 2024-09-09 45m review :: wouter research PR#5 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 max: 2024-09-02 1h project meeting :: project kickoff max: 2024-09-02 45m project meeting -- cgit v1.2.3