xavi
/
LibreWands
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added copyright info.

This commit is contained in:
Ryan "Lofenyy" Medeiros 2023-07-08 01:17:49 -06:00
parent 0e9eca5812
commit 86d281d2b1
28 changed files with 320 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Assets/Art/Botan Map.svg → Assets/Art/Botan_Map.svg
View File

@ -1,3 +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/.
-->
<svg width="1200" height="1400">
<rect y="0%" x="0%" width="100%" height="100%" fill="white" stroke="black" />
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 2.2 KiB

After

Width:  |  Height:  |  Size: 2.9 KiB

10
Assets/Art/Botan Map Old.svg → Assets/Art/Botan_Map_Old.svg
View File

@ -1,3 +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/.
-->
<svg width="150" height="200">
<rect y="0%" x="0%" width="100%" height="100%" fill="white" stroke="black" />
<rect y="25%" x="12.5%" width="34%" height="100" fill="white" stroke="black" />
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.2 KiB

After

Width:  |  Height:  |  Size: 1.9 KiB

10
Assets/Art/Controller.svg
View File

@ -1,3 +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/.
-->
<svg width="1000" height="500">
<rect y="0%" x="0%" width="100%" height="100%" fill="white" />
<path d="M 500 150 q 150 -300 300 -300" stroke="black" stroke-width="15" fill="none" />

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.5 KiB

After

Width:  |  Height:  |  Size: 2.2 KiB

10
Documentation/Articles/Ability Encyclopedia.tex → Documentation/Articles/AbilityEncyclopedia.tex
View File

@ -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}

10
Documentation/Articles/Acquiring.tex
View File

@ -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.

7
Documentation/Articles/Concept Art.tex
View File

@ -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}

17
Documentation/Articles/ConceptArt.tex Normal file
View File

@ -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}

10
Documentation/Articles/Controls.tex
View File

@ -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}

10
Documentation/Articles/Credits.tex
View File

@ -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}

10
Documentation/Articles/Engine Design.tex → Documentation/Articles/EngineDesign.tex
View File

@ -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.

10
Documentation/Articles/Game Design.tex → Documentation/Articles/GameDesign.tex
View File

@ -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.

39
Documentation/Articles/Gameplay Introduction.tex
View File

@ -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}

49
Documentation/Articles/GameplayIntroduction.tex Normal file
View File

@ -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}

10
Documentation/Articles/Introduction.tex
View File

@ -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!

10
Documentation/Articles/Item Encyclopedia.tex → Documentation/Articles/ItemEncyclopedia.tex
View File

@ -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}

10
Documentation/Articles/Map Editing.tex → Documentation/Articles/MapEditing.tex
View File

@ -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.

10
Documentation/Articles/Monster Encyclopedia.tex → Documentation/Articles/MonsterEncyclopedia.tex
View File

@ -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}

10
Documentation/Articles/Move Encyclopedia.tex → Documentation/Articles/MoveEncyclopedia.tex
View File

@ -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}

10
Documentation/Articles/Packaging Guide.tex → Documentation/Articles/PackagingGuide.tex
View File

@ -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.

10
Documentation/Articles/Support.tex
View File

@ -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.

10
Documentation/Articles/Work Timeline.tex → Documentation/Articles/WorkTimeline.tex
View File

@ -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}

10
Documentation/Articles/World Encyclopedia.tex → Documentation/Articles/WorldEncyclopedia.tex
View File

@ -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}

34
Documentation/LibreWands.tex
View File

@ -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}

24
Documentation/ideas
View File

@ -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

10
Documentation/macros.tex
View File

@ -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]

13
Source/engineSound.c
View File

@ -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/.

4
Tools/copyright-checker.sh
View File

@ -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."

27
Tools/documentation-readability.sh Executable file
View File

@ -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"