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

Sorted out documentation order.

This commit is contained in:
Ryan "Lofenyy" Medeiros 2023-07-03 22:06:01 -06:00
parent e358d04a08
commit 3dd78a7303
15 changed files with 79 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Documentation/Articles/Acquiring.tex Normal file
View File

@ -0,0 +1,16 @@
\chapter{Acquiring This Game}
\section{GNU/Linux}
\subsection{GuixSD Based}
\subsection{Debian/Ubuntu Based}
\subsection{Arch Based}
\section{Other}
If you feel comfortable compiling software yourself, it is possible to install this game using utilities you likely already have installed.
\texttt{make}
\texttt{make pdf}
\texttt{make install}
\texttt{make install-pdf}
\texttt{make uninstall}

48
Documentation/Articles/Botan Encyclopedia.tex
View File

@ -1,23 +1,4 @@
\chapter{World 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.
The main concept of the game revolves around the idea of people carrying powerful monsters with them as they travel. They may choose to battle these monsters. The objective of this game is to collect all magic wands, which can be obtained from monster champions. To collect them all, is to become the best monster coach in the region. We focus mainly on early modern Southern European culture, including tarot cards, classical elements, rennaissance and baroque culture.
\section{Cities and Towns}
For every city except the first, the following should be present and accessible.
\begin{itemize}
\item Heal Center per city.
\item Item center per city.
\item Wand Center per city.
\item Storyline quest.
\item Dungeon quest.
\item Amenity quest.
\end{itemize}
\chapter{Finished Design}
\chapter{Botan Encyclopedia}
The region of our map is called Botan, and consists of the following elements.
@ -26,7 +7,7 @@ The region of our map is called Botan, and consists of the following elements.
\includegraphics[scale=1.75]{../Build/Botan Map.png}
\end{figure}
\subsection{Coffee City}
\section{Coffee City}
Coffee City is a mining city located in the far Southwest. It's very sandy, dirty and when it rains, muddy. Nothing really grows out here. Inspired by Eterna City and Jak III.
@ -37,11 +18,11 @@ Coffee City is a mining city located in the far Southwest. It's very sandy, dirt
\item friends house
\end{itemize}
\subsection{Route 5}
\section{Route 5}
Route 5 doesn't have a name besides this. It connects Coffee City to Bay City. It's muddy, and swampy. Inspired by Unova Route 8.
\subsection{Bay City}
\section{Bay City}
Bay city is a city surrounded by dense forestry. It's inspired by Violet City.
@ -54,41 +35,36 @@ Bay city is a city surrounded by dense forestry. It's inspired by Violet City.
\item Town Map Quest
\end{itemize}
\subsection{Bay Forest}
\section{Bay Forest}
Bay Forest connects Bay City to Cardamom City. Highly dense and cryptic. Trees become ash as one approaches the Cardamom city. Inspired by Eterna Forerst.
\subsection{Cardamom City}
\section{Cardamom City}
A city located next to the volcanic Mt. Cardamom. It's vey ashy from a previous eruption. Inspired by Sootopolis City.
\subsection{Mt. Cardamom}
\section{Mt. Cardamom}
A cryptic and dark cave system that connects Cardamom City to the much cleaner air of Vanilla City. Inspired by Mt. Moon.
\subsection{Vanilla City}
\section{Vanilla City}
The windy Vanilla City is the powerhouse of the region, with its many wind turbines. Inspired by Goldenrod City.
\subsection{Route 2}
\section{Route 2}
Route 2 doesn't have a name. It connects Vanilla City to Cumin City. It is inspired by RSE Route 119.
\subsection{Cumin City}
\section{Cumin City}
The port city of Cumin has an excellent, thriving economy. It's inspired by Mossdeep City.
\subsection{Rosemary Garden}
\section{Rosemary Garden}
Rosemary Garden connects Cumin City to Rosemary City. It's a massive garden created by and taken care of by the Rosemary monestary. Inspired by Kalos Route 4.
\subsection{Rosemary City}
\section{Rosemary City}
Home of the Rosemary Monestary. A very bittersweet, hard to describe city. It has a small town feel overall despite having the amenities of a proper city. Should carry an almost nostalgic feel. Inspired by Lavender Town.
\section{Planned Features}
Shiny Monsters
Legendary Monsters
Monster encyclopedia

1
Documentation/Articles/Concept Art.tex Normal file
View File

@ -0,0 +1 @@
\chapter{Concept Art}

1
Documentation/Articles/Controls.tex Normal file
View File

@ -0,0 +1 @@
\chapter{Controls}

1
Documentation/Articles/Credits.tex Normal file
View File

@ -0,0 +1 @@
\chapter{Credits}

14
Documentation/Articles/Development Cycle.tex
View File

@ -1,19 +1,5 @@
\chapter{Work Timeline}
\section{Development cycles}
\subsection{Monthly Themes}
\begin{description}
\item[Jun] Initial planning. Announce on Diode Zone, Venera Social, Lemmy and the Trisquel forums. Get a Fediverse Blog page in circulation. Finally, announce on r/linux.
\item[Jul] World Design, classic. Announce on r/worldbuilding.
\item[Aug] World Design, implementation. Announce on r/programming\_ideas.
\item[Sep] World Design, testing. Announce on r/betatests.
\item[Oct] Battle mechanics design and implementation. Announce on r/gamedesign.
\item[Nov] Battle mechanics implementation and testing. Announce on r/betatests.
\item[Dec] Polish and Publish. Announce on r/freesoftware.
\end{description}
Finally, ideally once the new year rolls around, we'll be finished. Announce this beautiful game on r/linux.
\subsection{Monthly}
Create a new kanban project. Don't forget to review all major files in the project.

19
Documentation/Articles/Game Design.tex
View File

@ -1 +1,20 @@
\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.
The main concept of the game revolves around the idea of people carrying powerful monsters with them as they travel. They may choose to battle these monsters. The objective of this game is to collect all magic wands, which can be obtained from monster champions. To collect them all, is to become the best monster coach in the region. We focus mainly on early modern Southern European culture, including tarot cards, classical elements, rennaissance and baroque culture.
\section{Cities and Towns}
For every city except the first, the following should be present and accessible.
\begin{itemize}
\item Heal Center per city.
\item Item center per city.
\item Wand Center per city.
\item Storyline quest.
\item Dungeon quest.
\item Amenity quest.
\end{itemize}

2
Documentation/Articles/Battle.tex → Documentation/Articles/Gameplay Introduction.tex
View File

@ -1,4 +1,4 @@
\chapter{Battle}
\chapter{Gameplay Introduction}
\section{Elemental Damage}

3
Documentation/Articles/Getting Started.tex Normal file
View File

@ -0,0 +1,3 @@
\chapter{Getting Started}

1
Documentation/Articles/LibreWands Game Manual.tex
View File

@ -1 +0,0 @@
\chapter{Game Manual}

1
Documentation/Articles/Monster Encyclopedia.tex
View File

@ -1 +1,2 @@
\chapter{Monster Encyclopedia}

18
Documentation/Articles/Packaging Guide.tex
View File

@ -2,7 +2,7 @@
The priority levels listed here are merely suggestions. If you're able to help with packaging for any system, it's highly appreciated.
\subsubsection{Highest Priority}{FSF-Endorsed Native Package Manager Systems}
\section{Highest Priority}{FSF-Endorsed Native Package Manager Systems}
\begin{description}
\item[GuixSD] A Guix recipe may be found in the \texttt{Packaging/} directory of this project. It needs to be modified to work correctly.
@ -11,19 +11,19 @@ The priority levels listed here are merely suggestions. If you're able to help w
\item[Dynebolic] Unable to contribute packages.
\end{description}
\subsubsection{Medium High Priority}{Libre Native Package Manager Systems}
\section{Medium High Priority}{Libre Native Package Manager Systems}
\begin{description}
\item[Debian] Debian packages may be built using tools found in \texttt{Packaging/}, but they do not meet the quality needed to enter the official Debian repositories. Instructions were followed from \texttt{Packaging/Intro} from the Debian Wiki.
\end{description}
\subsubsection{Low High Priority}{Native Package Manager Systems for FSF-Endorsed Distributions}
\section{Low High Priority}{Native Package Manager Systems for FSF-Endorsed Distributions}
\begin{description}
\item[Arch] See \texttt{title/Creating\_packages} and \texttt{title/Arch\_package\_guidelines} from the Arch Wiki.
\end{description}
\subsubsection{High Medium Priority}{FSF-Endorsed Distributions}
\section{High Medium Priority}{FSF-Endorsed Distributions}
\begin{description}
\item[Parabola]
@ -32,7 +32,7 @@ The priority levels listed here are merely suggestions. If you're able to help w
\item[Trisquel]
\end{description}
\subsubsection{Medium Priority}{Libre Software Distributions}
\section{Medium Priority}{Libre Software Distributions}
\begin{description}
\item[ReplicantOS]
@ -40,7 +40,7 @@ The priority levels listed here are merely suggestions. If you're able to help w
\item[ReactOS]
\end{description}
\subsubsection{Low Medium Priority}{Popular Proprietary Systems}
\section{Low Medium Priority}{Popular Proprietary Systems}
\begin{description}
\item[Android]
@ -49,7 +49,7 @@ The priority levels listed here are merely suggestions. If you're able to help w
\item[MacOS X]
\end{description}
\subsubsection{High Low Priority}{Native package manager systems}
\section{High Low Priority}{Native package manager systems}
\begin{description}
\item[Flatpak]
@ -64,7 +64,7 @@ The priority levels listed here are merely suggestions. If you're able to help w
\item[Haiku]
\end{description}
\subsubsection{Medium Low Priority}{Source Available Systems}
\section{Medium Low Priority}{Source Available Systems}
\begin{description}
\item[PostmarketOS]
@ -72,7 +72,7 @@ The priority levels listed here are merely suggestions. If you're able to help w
\item[TempleOS]
\end{description}
\subsubsection{Low Low Priority}{Unpopular Proprietary Systems}
\section{Low Low Priority}{Unpopular Proprietary Systems}
\begin{description}
\item[Unix]

1
Documentation/Articles/Story Introduction.tex Normal file
View File

@ -0,0 +1 @@
\chapter{Story Introduction}

1
Documentation/Articles/Support.tex Normal file
View File

@ -0,0 +1 @@
\chapter{Support}

20
Documentation/LibreWands.tex
View File

@ -18,16 +18,22 @@ Copyright © 2023 Ryan "Lofenyy" Medeiros.
\tableofcontents
\part{LibreWands User Manual}
\input{../Documentation/Articles/LibreWands Game Manual.tex}
\input{../Documentation/Articles/Packaging Guide.tex}
\part{LibreWands Contributor Manual}
\input{../Documentation/Articles/Development Cycle.tex}
\input{../Documentation/Articles/Game Design.tex}
\input{../Documentation/Articles/Battle.tex}
\input{../Documentation/Articles/Acquiring.tex}
\input{../Documentation/Articles/Getting Started.tex}
\input{../Documentation/Articles/Controls.tex}
\input{../Documentation/Articles/Story Introduction.tex}
\input{../Documentation/Articles/Gameplay Introduction.tex}
\input{../Documentation/Articles/Botan Encyclopedia.tex}
\input{../Documentation/Articles/Monster Encyclopedia.tex}
\input{../Documentation/Articles/Item Encyclopedia.tex}
\input{../Documentation/Articles/Concept Art.tex}
\input{../Documentation/Articles/Support.tex}
\input{../Documentation/Articles/Credits.tex}
\part{LibreWands Contributor Manual}
\input{../Documentation/Articles/Packaging Guide.tex}
\input{../Documentation/Articles/Development Cycle.tex}
\input{../Documentation/Articles/Game Design.tex}
\input{../Documentation/Articles/Map Editing.tex}
\part{The Fool Engine Documentation}