Added documentation about the world.

This commit is contained in:
Ryan "Lofenyy" Medeiros 2023-07-03 01:50:32 -06:00
parent 100ebe15e8
commit 74359dee4d
5 changed files with 63 additions and 18 deletions

29
Assets/Botan Map.svg Normal file
View File

@ -0,0 +1,29 @@
<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" />
<line y1="100" x1="70" x2="125" y2="100" stroke="black" />
<line y1="100" x1="125" x2="125" y2="150" stroke="black" />
<circle cx="50" cy="50" r="2" stroke="black" fill="red" />
<text x="50" y="45" fill="black" font-size="5">Cumin City</text>
<circle cx="50" cy="150" r="2" stroke="black" fill="red" />
<text x="50" y="155" fill="black" font-size="5">Cardamom City</text>
<circle cx="19" cy="100" r="2" stroke="black" fill="red" />
<text x="24" y="100" fill="black" font-size="5">Vanilla City</text>
<circle cx="70" cy="110" r="2" stroke="black" fill="red" />
<text x="75" y="110" fill="black" font-size="5">Bay City</text>
<circle cx="70" cy="90" r="2" stroke="black" fill="red" />
<text x="75" y="90" fill="black" font-size="5">Rosemary City</text>
<line x1="65" y1="92" x2="70" y2="98" stroke="black" />
<line x1="75" y1="92" x2="70" y2="98" stroke="black" />
<circle cx="125" cy="150" r="2" stroke="black" fill="red" />
<text x="125" y="157" fill="black" font-size="5">Coffee City</text>
<line x1="120" y1="152" x2="130" y2="152" stroke="black" />
</svg>

After

Width:  |  Height:  |  Size: 1.2 KiB

View File

@ -215,7 +215,7 @@ The main concept of the game revolves around the idea of people carrying powerfu
\section{Cities and Towns}
For every city except Coffee City, the following should be present and accessible.
For every city except the first, the following should be present and accessible.
\begin{itemize}
\item Heal Center per city.
@ -226,8 +226,19 @@ For every city except Coffee City, the following should be present and accessibl
\item Amenity quest.
\end{itemize}
\chapter{Finished Design}
The region of our map is called Botan, and consists of the following elements.
\begin{figure}
\centering
\includegraphics[scale=1.75]{../Build/Botan Map.png}
\end{figure}
\subsection{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.
\begin{itemize}
\item Heal Center
\item Storyline fetch quest
@ -237,8 +248,12 @@ For every city except Coffee City, the following should be present and accessibl
\subsection{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}
Bay city is a city surrounded by dense forestry. It's inspired by Violet City.
\begin{itemize}
\item Heal Center
\item Item center
@ -250,20 +265,36 @@ For every city except Coffee City, the following should be present and accessibl
\subsection{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}
A city located next to the volcanic Mt. Cardamom. It's vey ashy from a previous eruption. Inspired by Sootopolis City.
\subsection{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}
The windy Vanilla City is the powerhouse of the region, with its many wind turbines. Inspired by Goldenrod City.
\subsection{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}
The port city of Cumin has an excellent, thriving economy. It's inspired by Mossdeep City.
\subsection{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}
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

View File

@ -1,17 +0,0 @@
\chapter{Engine Design}
\section{Controls}
The controls used in this engine are based solely on the original Gameboy controls for simplicity and compatibility reasons, particularly with the Pinephone. Support for controllers is planned, but can currently be achieved through keybinding. Keyboard controls include the arrow keys, along with the \texttt{Z} and \texttt{X} buttons, as the primary and secondary buttons respectively. Instead of arrow keys, users of exotic keyboards such as on the Pinephone may use the \texttt{IJKL} keys instead of the arrow keys.
\section{Maps}
The best way to understand how maps work in this engine, is to look at the source code, as found in \texttt{engineMaps.h} and \texttt{engineMaps.c} respectively. Maps are stored in a struct array, and each map contains five types of tiles. Every tile has an \texttt{X} and \texttt{Y} coordinate, as well as a \texttt{T} and \texttt{C} attribute, which record the printable character representing the tile, and color code, respectively. See the five types of tiles in the \texttt{Map Editor} chapter in this book. Each tile then contains additional attributes, along with its type.
\subsection{Tile Types and Attributes}
It should be noted that all of these tiles contain an \texttt{active} attribute, that notes whether or not the tile is in use. This is only done in memory, and is to simplify memory management. These states \textit{should not} be saved to external files. For information on color codes, see the \texttt{Color Codes} section of this book.
\subsubsection{Basic Tiles}
Basic tiles are the funamental building blocks of any level. They'll certainly be used the most. They're used for anything that one cannot use another tile type for. They're usede for things such as walls and walkable tiles. These include one-way walls.

View File

@ -1,4 +1,5 @@
\documentclass[final]{book}
\usepackage{graphicx}
\begin{document}
\title{LibreWands}
\author{Ryan "Lofenyy" Medeiros}

View File

@ -30,6 +30,7 @@ uninstall-pdf:
rm -r $(DESTDIR)/usr/share/doc/librewands/
pdf:
cd Build/;inkscape "../Assets/Botan Map.svg" --export-width=1920 --export-filename="Botan Map.png"
cd Build/;pdflatex ../Documentation/LibreWands.tex
clean: