From 86d281d2b1100a998f5b7579b2858f0d3f8fc26a Mon Sep 17 00:00:00 2001 From: "Ryan \"Lofenyy\" Medeiros" Date: Sat, 8 Jul 2023 01:17:49 -0600 Subject: [PATCH] Added copyright info. --- Assets/Art/{Botan Map.svg => Botan_Map.svg} | 10 ++++ .../{Botan Map Old.svg => Botan_Map_Old.svg} | 10 ++++ Assets/Art/Controller.svg | 10 ++++ ...cyclopedia.tex => AbilityEncyclopedia.tex} | 10 ++++ Documentation/Articles/Acquiring.tex | 10 ++++ Documentation/Articles/Concept Art.tex | 7 --- Documentation/Articles/ConceptArt.tex | 17 +++++++ Documentation/Articles/Controls.tex | 10 ++++ Documentation/Articles/Credits.tex | 10 ++++ .../{Engine Design.tex => EngineDesign.tex} | 10 ++++ .../{Game Design.tex => GameDesign.tex} | 10 ++++ .../Articles/Gameplay Introduction.tex | 39 --------------- .../Articles/GameplayIntroduction.tex | 49 +++++++++++++++++++ Documentation/Articles/Introduction.tex | 10 ++++ ... Encyclopedia.tex => ItemEncyclopedia.tex} | 10 ++++ .../{Map Editing.tex => MapEditing.tex} | 10 ++++ ...cyclopedia.tex => MonsterEncyclopedia.tex} | 10 ++++ ... Encyclopedia.tex => MoveEncyclopedia.tex} | 10 ++++ ...Packaging Guide.tex => PackagingGuide.tex} | 10 ++++ Documentation/Articles/Support.tex | 10 ++++ .../{Work Timeline.tex => WorkTimeline.tex} | 10 ++++ ...Encyclopedia.tex => WorldEncyclopedia.tex} | 10 ++++ Documentation/LibreWands.tex | 34 ++++++++----- Documentation/ideas | 24 --------- Documentation/macros.tex | 10 ++++ Source/engineSound.c | 13 +++++ Tools/copyright-checker.sh | 4 +- Tools/documentation-readability.sh | 27 ++++++++++ 28 files changed, 320 insertions(+), 84 deletions(-) rename Assets/Art/{Botan Map.svg => Botan_Map.svg} (77%) rename Assets/Art/{Botan Map Old.svg => Botan_Map_Old.svg} (65%) rename Documentation/Articles/{Ability Encyclopedia.tex => AbilityEncyclopedia.tex} (90%) delete mode 100644 Documentation/Articles/Concept Art.tex create mode 100644 Documentation/Articles/ConceptArt.tex rename Documentation/Articles/{Engine Design.tex => EngineDesign.tex} (89%) rename Documentation/Articles/{Game Design.tex => GameDesign.tex} (58%) delete mode 100644 Documentation/Articles/Gameplay Introduction.tex create mode 100644 Documentation/Articles/GameplayIntroduction.tex rename Documentation/Articles/{Item Encyclopedia.tex => ItemEncyclopedia.tex} (92%) rename Documentation/Articles/{Map Editing.tex => MapEditing.tex} (69%) rename Documentation/Articles/{Monster Encyclopedia.tex => MonsterEncyclopedia.tex} (96%) rename Documentation/Articles/{Move Encyclopedia.tex => MoveEncyclopedia.tex} (87%) rename Documentation/Articles/{Packaging Guide.tex => PackagingGuide.tex} (75%) rename Documentation/Articles/{Work Timeline.tex => WorkTimeline.tex} (65%) rename Documentation/Articles/{World Encyclopedia.tex => WorldEncyclopedia.tex} (94%) delete mode 100644 Documentation/ideas create mode 100755 Tools/documentation-readability.sh diff --git a/Assets/Art/Botan Map.svg b/Assets/Art/Botan_Map.svg similarity index 77% rename from Assets/Art/Botan Map.svg rename to Assets/Art/Botan_Map.svg index e0b24a2..98dd3cc 100644 --- a/Assets/Art/Botan Map.svg +++ b/Assets/Art/Botan_Map.svg @@ -1,3 +1,13 @@ + + diff --git a/Assets/Art/Botan Map Old.svg b/Assets/Art/Botan_Map_Old.svg similarity index 65% rename from Assets/Art/Botan Map Old.svg rename to Assets/Art/Botan_Map_Old.svg index df277cc..cab700a 100644 --- a/Assets/Art/Botan Map Old.svg +++ b/Assets/Art/Botan_Map_Old.svg @@ -1,3 +1,13 @@ + + diff --git a/Assets/Art/Controller.svg b/Assets/Art/Controller.svg index 4c7b77d..ebb05d7 100644 --- a/Assets/Art/Controller.svg +++ b/Assets/Art/Controller.svg @@ -1,3 +1,13 @@ + + diff --git a/Documentation/Articles/Ability Encyclopedia.tex b/Documentation/Articles/AbilityEncyclopedia.tex similarity index 90% rename from Documentation/Articles/Ability Encyclopedia.tex rename to Documentation/Articles/AbilityEncyclopedia.tex index b5baae2..2b04851 100644 --- a/Documentation/Articles/Ability Encyclopedia.tex +++ b/Documentation/Articles/AbilityEncyclopedia.tex @@ -1,3 +1,13 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + \chapter{Ability Encyclopedia} \section{Light} \MonAbility{Gills}{Light} diff --git a/Documentation/Articles/Acquiring.tex b/Documentation/Articles/Acquiring.tex index d37da87..53af074 100644 --- a/Documentation/Articles/Acquiring.tex +++ b/Documentation/Articles/Acquiring.tex @@ -1,3 +1,13 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + \chapter{Acquiring This Game} This game requires about 700MiB of disk space. At least 64 MiB of free random access memory is recommended. diff --git a/Documentation/Articles/Concept Art.tex b/Documentation/Articles/Concept Art.tex deleted file mode 100644 index 1e74954..0000000 --- a/Documentation/Articles/Concept Art.tex +++ /dev/null @@ -1,7 +0,0 @@ -\chapter{Concept Art} - -\begin{figure} -\centering -\includegraphics[scale=1.75]{../Build/Art/Botan Map.png} \\ -The Region of Botan. July 4th 2023. -\end{figure} diff --git a/Documentation/Articles/ConceptArt.tex b/Documentation/Articles/ConceptArt.tex new file mode 100644 index 0000000..1a5b4b6 --- /dev/null +++ b/Documentation/Articles/ConceptArt.tex @@ -0,0 +1,17 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + +\chapter{Concept Art} + +\begin{figure} +\centering +\includegraphics[scale=1.75]{../Build/Art/Botan Map.png} \\ +The Region of Botan. July 4th 2023. +\end{figure} diff --git a/Documentation/Articles/Controls.tex b/Documentation/Articles/Controls.tex index 1c1f6f7..33c6aae 100644 --- a/Documentation/Articles/Controls.tex +++ b/Documentation/Articles/Controls.tex @@ -1,3 +1,13 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + \chapter{Controls} \begin{figure} diff --git a/Documentation/Articles/Credits.tex b/Documentation/Articles/Credits.tex index 2049c08..78b299d 100644 --- a/Documentation/Articles/Credits.tex +++ b/Documentation/Articles/Credits.tex @@ -1 +1,11 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + \chapter{Credits} diff --git a/Documentation/Articles/Engine Design.tex b/Documentation/Articles/EngineDesign.tex similarity index 89% rename from Documentation/Articles/Engine Design.tex rename to Documentation/Articles/EngineDesign.tex index a0cbd36..8c1ba24 100644 --- a/Documentation/Articles/Engine Design.tex +++ b/Documentation/Articles/EngineDesign.tex @@ -1,3 +1,13 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + \chapter{Engine Design} To initialize the game engine, fist run \texttt{initEngine()}. This sets up the graphics, at the very least. diff --git a/Documentation/Articles/Game Design.tex b/Documentation/Articles/GameDesign.tex similarity index 58% rename from Documentation/Articles/Game Design.tex rename to Documentation/Articles/GameDesign.tex index efbdaa8..ec64838 100644 --- a/Documentation/Articles/Game Design.tex +++ b/Documentation/Articles/GameDesign.tex @@ -1,3 +1,13 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + \chapter{Game Design} The information in this chapter are merely suggestions. I've designed the engine to allow for as much creative freedom as possible. Feel free to break the rules, if it creates a more fun and/or interesting gaming experience. diff --git a/Documentation/Articles/Gameplay Introduction.tex b/Documentation/Articles/Gameplay Introduction.tex deleted file mode 100644 index d47a9e4..0000000 --- a/Documentation/Articles/Gameplay Introduction.tex +++ /dev/null @@ -1,39 +0,0 @@ -\chapter{Gameplay Introduction} -\begin{figure} -\centering -\includegraphics[scale=0.4]{../Build/Art/commons.wikimedia.org_wiki_File:Regular_truncation_10_1000.png}\\ -Monster Types -\end{figure} - -\section{Impossible Monster Types} -\begin{description} -\item[Light Ice] -\item[Light Radio] - -\item[Water Grass] -\item[Water Dark] - -\item[Earth Electric] -\item[Earth Ice] - -\item[Fire Grass] -\item[Fire Flying] - -\item[Radio Light] -\item[Radio Electric] - -\item[Dark Flying] -\item[Dark Water] - -\item[Ice Light] -\item[Ice Earth] - -\item[Grass Water] -\item[Grass Fire] - -\item[Electric Earth] -\item[Electric Radio] - -\item[Flying Fire] -\item[Flying Dark] -\end{description} diff --git a/Documentation/Articles/GameplayIntroduction.tex b/Documentation/Articles/GameplayIntroduction.tex new file mode 100644 index 0000000..398566b --- /dev/null +++ b/Documentation/Articles/GameplayIntroduction.tex @@ -0,0 +1,49 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + +\chapter{Gameplay Introduction} +\begin{figure} +\centering +\includegraphics[scale=0.4]{../Build/Art/commons.wikimedia.org_wiki_File:Regular_truncation_10_1000.png}\\ +Monster Types +\end{figure} + +\section{Impossible Monster Types} +\begin{description} +\item[Light Ice] +\item[Light Radio] + +\item[Water Grass] +\item[Water Dark] + +\item[Earth Electric] +\item[Earth Ice] + +\item[Fire Grass] +\item[Fire Flying] + +\item[Radio Light] +\item[Radio Electric] + +\item[Dark Flying] +\item[Dark Water] + +\item[Ice Light] +\item[Ice Earth] + +\item[Grass Water] +\item[Grass Fire] + +\item[Electric Earth] +\item[Electric Radio] + +\item[Flying Fire] +\item[Flying Dark] +\end{description} diff --git a/Documentation/Articles/Introduction.tex b/Documentation/Articles/Introduction.tex index 174346c..9ace12a 100644 --- a/Documentation/Articles/Introduction.tex +++ b/Documentation/Articles/Introduction.tex @@ -1,3 +1,13 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + \chapter{Introduction} Welcome to the world of monsters. Many of these creatures have been tamed to protect people. Others, of the human and feral variety, are extremely dangerous. As you'd know, living in the town of Coffee, being invaded by The Botan Company has been no fun at all. They're a ruthless gang being controlled by a foreign power, and they appear to want something. They're too powerful to be stopped. That is, unless you have something to do about it. Perhaps if you travelled across the region of Botan and became a master monster coach, you could prove to be a force to be reckoned with. Currently, while there is a resistance effort, no one appears to be tough enough to take on their monsters in battle. The current monster champion of the region is fighting them off hard, but they cannot do it alone. Perhaps you can choose to train hard and help them, or you may do nothing about the invasion. Either way, good luck and have fun! diff --git a/Documentation/Articles/Item Encyclopedia.tex b/Documentation/Articles/ItemEncyclopedia.tex similarity index 92% rename from Documentation/Articles/Item Encyclopedia.tex rename to Documentation/Articles/ItemEncyclopedia.tex index 16973b8..24e3c0b 100644 --- a/Documentation/Articles/Item Encyclopedia.tex +++ b/Documentation/Articles/ItemEncyclopedia.tex @@ -1,3 +1,13 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + \chapter{Item Encyclopedia} \section{Monster Balls} diff --git a/Documentation/Articles/Map Editing.tex b/Documentation/Articles/MapEditing.tex similarity index 69% rename from Documentation/Articles/Map Editing.tex rename to Documentation/Articles/MapEditing.tex index 9e3d040..4094143 100644 --- a/Documentation/Articles/Map Editing.tex +++ b/Documentation/Articles/MapEditing.tex @@ -1,3 +1,13 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + \chapter{Map Editor} If these instructions are insufficient, a lot of information can be gathered from the \texttt{Maps} section of the \texttt{Engine Design} chapter of this book. If you do find the information in this section to be lacking, please create an issue in the bug tracker of this project, or contact the developer using the information in the project \texttt{ReadMe} file. diff --git a/Documentation/Articles/Monster Encyclopedia.tex b/Documentation/Articles/MonsterEncyclopedia.tex similarity index 96% rename from Documentation/Articles/Monster Encyclopedia.tex rename to Documentation/Articles/MonsterEncyclopedia.tex index 8905cea..e0e9f5c 100644 --- a/Documentation/Articles/Monster Encyclopedia.tex +++ b/Documentation/Articles/MonsterEncyclopedia.tex @@ -1,3 +1,13 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + \chapter{Monster Encyclopedia} \section{Plant Monsters} diff --git a/Documentation/Articles/Move Encyclopedia.tex b/Documentation/Articles/MoveEncyclopedia.tex similarity index 87% rename from Documentation/Articles/Move Encyclopedia.tex rename to Documentation/Articles/MoveEncyclopedia.tex index 7dfb778..13d9a32 100644 --- a/Documentation/Articles/Move Encyclopedia.tex +++ b/Documentation/Articles/MoveEncyclopedia.tex @@ -1,3 +1,13 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + \chapter{Move Encyclopedia} \section{Plant} diff --git a/Documentation/Articles/Packaging Guide.tex b/Documentation/Articles/PackagingGuide.tex similarity index 75% rename from Documentation/Articles/Packaging Guide.tex rename to Documentation/Articles/PackagingGuide.tex index 1fc6b3a..1b56c90 100644 --- a/Documentation/Articles/Packaging Guide.tex +++ b/Documentation/Articles/PackagingGuide.tex @@ -1,3 +1,13 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + \chapter{Packaging Guide} The priority levels listed here are merely suggestions. If you're able to help with packaging for any system, it's highly appreciated. diff --git a/Documentation/Articles/Support.tex b/Documentation/Articles/Support.tex index 812d8a9..195f2bc 100644 --- a/Documentation/Articles/Support.tex +++ b/Documentation/Articles/Support.tex @@ -1,3 +1,13 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + \chapter{Support} If you need support, or you find any issues at all with any aspect of this software, feel free to send an issue report to \texttt{Gitea.com} at \texttt{/lofenyy/LibreWands}. I greatly appreciate any and all contributions to improving my game, no matter how minor. diff --git a/Documentation/Articles/Work Timeline.tex b/Documentation/Articles/WorkTimeline.tex similarity index 65% rename from Documentation/Articles/Work Timeline.tex rename to Documentation/Articles/WorkTimeline.tex index 2bed3b2..2cd9bdb 100644 --- a/Documentation/Articles/Work Timeline.tex +++ b/Documentation/Articles/WorkTimeline.tex @@ -1,3 +1,13 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + \chapter{Work Timeline} \section{Development cycles} \subsection{Monthly} diff --git a/Documentation/Articles/World Encyclopedia.tex b/Documentation/Articles/WorldEncyclopedia.tex similarity index 94% rename from Documentation/Articles/World Encyclopedia.tex rename to Documentation/Articles/WorldEncyclopedia.tex index 3debf2a..471f041 100644 --- a/Documentation/Articles/World Encyclopedia.tex +++ b/Documentation/Articles/WorldEncyclopedia.tex @@ -1,3 +1,13 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + \chapter{World Regions Encyclopedia} \begin{center} diff --git a/Documentation/LibreWands.tex b/Documentation/LibreWands.tex index 6fc11ea..1ab2337 100644 --- a/Documentation/LibreWands.tex +++ b/Documentation/LibreWands.tex @@ -1,3 +1,13 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + \documentclass{book} \usepackage{graphicx} \usepackage{multicol} @@ -21,23 +31,23 @@ Copyright © 2023 Ryan "Lofenyy" Medeiros. \input{../Documentation/Articles/Acquiring.tex} \input{../Documentation/Articles/Controls.tex} \input{../Documentation/Articles/Introduction.tex} -\input{../Documentation/Articles/Gameplay Introduction.tex} -\input{../Documentation/Articles/World Encyclopedia.tex} -\input{../Documentation/Articles/Monster Encyclopedia.tex} -\input{../Documentation/Articles/Ability Encyclopedia.tex} -\input{../Documentation/Articles/Move Encyclopedia.tex} -\input{../Documentation/Articles/Item Encyclopedia.tex} -\input{../Documentation/Articles/Concept Art.tex} +\input{../Documentation/Articles/GameplayIntroduction.tex} +\input{../Documentation/Articles/WorldEncyclopedia.tex} +\input{../Documentation/Articles/MonsterEncyclopedia.tex} +\input{../Documentation/Articles/AbilityEncyclopedia.tex} +\input{../Documentation/Articles/MoveEncyclopedia.tex} +\input{../Documentation/Articles/ItemEncyclopedia.tex} +\input{../Documentation/Articles/ConceptArt.tex} \input{../Documentation/Articles/Support.tex} \input{../Documentation/Articles/Credits.tex} \part{LibreWands Contributor Manual} -\input{../Documentation/Articles/Packaging Guide.tex} -\input{../Documentation/Articles/Work Timeline.tex} -\input{../Documentation/Articles/Game Design.tex} -\input{../Documentation/Articles/Map Editing.tex} +\input{../Documentation/Articles/PackagingGuide.tex} +\input{../Documentation/Articles/WorkTimeline.tex} +\input{../Documentation/Articles/GameDesign.tex} +\input{../Documentation/Articles/MapEditing.tex} \part{The Fool Engine Documentation} -\input{../Documentation/Articles/Engine Design.tex} +\input{../Documentation/Articles/EngineDesign.tex} \end{document} diff --git a/Documentation/ideas b/Documentation/ideas deleted file mode 100644 index 9d7bcc7..0000000 --- a/Documentation/ideas +++ /dev/null @@ -1,24 +0,0 @@ -* Name -* Number (if applicable) -* Illustration -* Description -* Lore -* History -* Geography -* Demographics -* Economy -* Arts and Culture -* Government -* Places -* height -* width -* weight -* area -* ability 1 -* ability 2 -* moves -* Evolutions -* Type(s) -* Price -* Value - diff --git a/Documentation/macros.tex b/Documentation/macros.tex index 0cf76f5..bc07759 100644 --- a/Documentation/macros.tex +++ b/Documentation/macros.tex @@ -1,3 +1,13 @@ +% Copyright © 2023 Ryan "Lofenyy" Medeiros. +% +% This file is part of LibreWands. +% +% LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. +% +% LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +% +% You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + \newcounter{MonItem} % - name, weight, price, value, description, history, culture \newcommand{\MonItem}[6] diff --git a/Source/engineSound.c b/Source/engineSound.c index e69de29..cc12c63 100644 --- a/Source/engineSound.c +++ b/Source/engineSound.c @@ -0,0 +1,13 @@ +// This file is part of LibreWands. + +// LibreWands is free software: you can redistribute it and/or modify it under the terms of the +// GNU General Public License as published by the Free Software Foundation, either version 3 of +// the License, or (at your option) any later version. + +// LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; +// without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See +// the GNU General Public License for more details. + +// You should have received a copy of the GNU General Public License along with LibreWands. If +// not, see https://www.gnu.org/licenses/. + diff --git a/Tools/copyright-checker.sh b/Tools/copyright-checker.sh index f9b5b90..ee7659f 100755 --- a/Tools/copyright-checker.sh +++ b/Tools/copyright-checker.sh @@ -4,11 +4,11 @@ # LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. -# You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. +# You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. # --- # Checks for files with missing copyright information -find ../ -type f -not -path '../Build/*' -not -path '../.git/*' -not -name 'LICENSE' -not -name 'Debian_Control' | xargs grep -LE "This file is part of LibreWands." +find ./ -type f -not -path './Build/*' -not -path './.git/*' -not -name 'LICENSE' -not -name 'Debian_Control' | xargs grep -LE "This file is part of LibreWands." diff --git a/Tools/documentation-readability.sh b/Tools/documentation-readability.sh new file mode 100755 index 0000000..ec95e9a --- /dev/null +++ b/Tools/documentation-readability.sh @@ -0,0 +1,27 @@ +#/bin/bash + +# This file is part of LibreWands. + +# LibreWands is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. + +# LibreWands is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + +# You should have received a copy of the GNU General Public License along with LibreWands. If not, see https://www.gnu.org/licenses/. + +# --- + +# Calculates the readability of our documentation. +# A score of [60-70] is preferred. + +Words=$(cat ./Documentation/Articles/* | grep -vE "^[\{}]" | wc -w) +Sents=$(cat ./Documentation/Articles/* | tr . "\\n" | grep -vE "^[\{}]" | grep -vE "$^" | grep -vE "^ $" | wc -l) +Sylls=$(cat ./Documentation/Articles/* | grep -vE "^[\{}]" | tr ' ' "\\n" | grep -vE "e$" | grep -ioE "[aeiouy]" | wc -l) + +AWPS=$(echo "($Words / $Sents)" | bc -l) +AWPY=$(echo "($Sylls / $Words)" | bc -l) +Flsh=$(echo "206.835 - (1.015 * $AWPS) - (84.6 * $AWPY)" | bc -l) + +echo "$Words words in documentation per $Sents sentences. ($AWPS)" +echo "$Sylls syllables in documentation per $Words words. ($AWPY)" +echo "Readability score: $Flsh" +