Updated README.md

Also added a new config file for developing over multiple machines.

.gitignore

@@ -0,0 +1,24 @@
+#Editor generated files
+*.sln
+*.vcproj
+*.suo
+*.ncb
+*.user
+
+#Directories
+Release/
+Debug/
+Out/
+release/
+debug/
+out/
+
+#Project generated files
+*.db
+*.o
+*.a
+*.exe
+
+#Shell files
+*.bat
+*.sh

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "bin"]
+	path = bin
+	url = https://github.com/Ratstail91/Tortuga.git

README.md

@@ -0,0 +1,55 @@
+## Outline
+
+Tortuga is a 2D MMORPG featuring permadeath, with an emphasis on multiplayer cooperation, exploration and customization. The game runs on customizable public and private servers.
+
+This game is inspired by classic 2D RPGs (Final Fantasy, The Legend of Zelda), as well as more modern sandboxes and MMOs (Minecraft, EVE Online). This project is currently independently created and funded, with the goal of creating a game that will engage the players and inspire a large community.
+
+## Releases
+
+* The most recent stable build for Windows can be found [here](https://dl.dropboxusercontent.com/u/46669050/Tortuga-win.rar).
+* The most recent stable build for Windows can be found [here](https://dl.dropboxusercontent.com/u/46669050/Tortuga-linux.tar).
+
+## Documentation
+
+* [Tortuga Wiki](https://github.com/Ratstail91/Tortuga/wiki) - Full documentation (incomplete)
+* [Tortuga Bug Tracker](https://github.com/Ratstail91/Tortuga/issues) - A list of all known bugs and issues
+
+## External Dependencies
+
+* [SDL 2.0](http://www.libsdl.org/) - Simple DirectMedia Layer API
+* [SDL_image 2.0](https://www.libsdl.org/projects/SDL_image/) - An SDL Extension for loading multiple image file formats
+* [SDL_net 2.0](http://www.libsdl.org/projects/SDL_net/) - SDL's networking extension
+* [SDL_ttf 2.0](https://www.libsdl.org/projects/SDL_ttf/) - An SDL extention for rendering fonts
+* [lua 5.2](http://www.lua.org/) - The lua programming language
+* [SQLite3](http://www.sqlite.org/) - A lightweight SQL database engine
+
+## Tools
+
+* [WinRAR](http://www.rarlab.com/) - A free archive tool; needed for Windows distribution
+* [tar](http://www.gnu.org/software/tar/manual/) - The GNU archive tool; needed for Linux distribution
+* [Dropbox](https://www.dropbox.com/) - For hosting and distribution
+
+## Using and Including
+
+* [Coolvetica Typeface](http://typodermicfonts.com/coolvetica/)
+
+## Copyright
+
+(Future versions (to be determined) may be released under a modified version of the [Uplink Developer's License](http://www.introversion.co.uk/uplink/developer/license.html).)
+
+The current version of Tortuga is released under the [zlib license](http://en.wikipedia.org/wiki/Zlib_License).  
+
+Copyright (c) 2013-2016 Kayne Ruse
+
+This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
+2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
+3. This notice may not be removed or altered from any source distribution.
+
+### Items not made by me
+
+* [Coolvetica Font](http://typodermicfonts.com/coolvetica/)
+* Creative Commons Artwork from [Artsader](http://www.moosader.com/artsader/)

api outline.md

@@ -1,57 +0,0 @@
---TODO: each function needs to check it's parameter count
---TODO: Set metatables
-
---RoomManager interface
-RoomMgr.GetRoom(index)
-RoomMgr.CreateRoom([{params}])
-RoomMgr.UnloadRoom(index)
-
-
---RoomData interface
-Room.GetPager()
-Room.GetGenerator()
-Room.OnCreate([{params}])
-Room.OnUnload()
-
-Room.Get{params}()
-
-
---RegionPager interface
-RegionPager.SetTile(x, y, z, v)
-RegionPager.GetTile(x, y, z)
-RegionPager.SetSolid(x, y, b)
-RegionPager.GetSolid(x, y)
-RegionPager.GetRegion(x, y)
-RegionPager.SetDirectory(directory)
-RegionPager.GetDirectory()
-RegionPager.LoadRegion(x, y)
-RegionPager.SaveRegion(x, y)
-RegionPager.CreateRegion(x, y[, {params}])
-RegionPager.UnloadRegion(x, y)
-
-
---Region interface
-Region.SetTile(x, y, z, v)
-Region.GetTile(x, y, z)
-Region.SetSolid(x, y, b)
-Region.GetSolid(x, y)
-Region.GetX()
-Region.GetY()
-Region.GetWidth()
-Region.GetHeight()
-Region.GetDepth()
-Region.OnLoad(directory)
-Region.OnSave(directory)
-Region.OnCreate([{params}])
-Region.OnUnload([directory])
-
-
---*Generator interface
-Generator.GetMapType()
-Generator.GetChunk(x, y)
-Generator.GetMapWidth()
-Generator.GetMapHeight()
-
-
---Chunk interface
-??

articles/On-Permadeath-Pain-And-Loss.md

@@ -1,19 +0,0 @@
-My game Tortuga will have permadeath; it's actually one of the first design decisions I made. How to implement it, however, is another decision all together.
-
-A while ago, before the implementation of hardcore mode, I was playing on a Minecraft server that boasted something close to permadeath: your account would be banned for 15 days, so long that it's almost unavoidable that you'd lose all of your hidden items. This was a brutal server; the further you went from spawn, the more dangerous it became, not less. If the natural hazards didn't kill you, another player would.
-
-I loved it.
-
-Although I haven't been back to that server since I died for the last time, the experience will stay with me forever. I'd played and died on that server a few times, each time I had to wait for my ban to clear. I never really lost much, since I never survived for very long. Even today, in a single player world, I'm likely to die on the first night.
-
-After playing for a while, I began to understand the mentality needed to survive there. Always fear other people, never take risks, and never hoard valuable items if they could be better spent keeping you alive. One day, the last day I played, I found a hole in the ground that someone was obviously using as a "hidden" base. I tried to get in, always careful not to trigger any traps. However, while I was trying to get in, the owner came home.
-
-I was suddenly attacked from behind, I barely had enough sense to dig down, since they were wearing enchanted diamond armour. I had no chance against them. I thought I was safe, digging 10, 20, 30 meters down, but no, they poured lava down the hole and plugged it up. I was a gonner, and I knew it. I was futilely digging and thrashing around in what was now my tomb, about to lose my life. I'd survived for so long, only to lose it all by not keeping a lookout.
-
-When the game over screen flashed up, I screamed. I screamed, and screamed, and screamed. For 5 minutes, my mind was blank, nothing but hatred and pain and loss. I'm sure you've seen the video of the angry German kid who died in WoW, but have you ever actually experienced that pain? Have you ever worked so hard, and lost it all?
-
-For days afterwards, that loss was all I could think about. Even now, that experience stays with me. What about that game, that server, invoked so much pain that I almost lost consciousness from screaming? Me of all people, who thought he was invincible?
-
-I've played games that have moved me, terrified me, made me fall in love and fight for the people that I care about. But never have I played a game that has made me feel pain and loss like that. I died that day. Me.
-
-Pain and loss are part of life, but not games. Permadeath seems like the obvious choice for creating a sense of loss for the player, but there are so few games with permadeath, and even fewer multiplayer games. Pain and loss can be conveyed in other ways, I'm sure anybody who's played Final Fantasy 7 knows that, and some games are especially well suited to delivering that message. However, for a player to feel like they are the one who's died, that is a challenge.

articles/collision-logic.md

@@ -1,125 +0,0 @@
-Abstract:
-
-The goal of this pseudocode is to create a collision system that brings several
-colliding bodies to a near-contact state (no space between the bodies, but not
-overlapping), while preserving the motion of said bodies. For simplicity, I've
-decided to use a square box (BoundingBox, or BBox for short) for the collidable
-bodies.
-
-Example:
-
-My current game has a tiled-map, where the tiles are arranged on a 2D grid. The
-tiles each have a flag indicating if they are solid (i.e. collidable) or not. I
-also have characters walking around on these tile maps, that must not intersect
-with solid tiles. For stylistic reasons, I want characters moving at an angle
-to "slide" along these walls, and continue along with their original velocity
-when they've circumvented the obstacles.
-
-I'd also like to keep the possibility of non-grid collisions using this logic
-open (for objects like trees, etc.) if the code allows it.
-
-Obviously, there are many in depth issues that I will need to  take into
-account when writing this logic, that have been glossed over or omitted in this
-article.
-
--------------------------
-
-```
-	velocity = motion + speed
-	if (collision(position + velocity)) then
-		if (collision(position + {velocity.x, 0})) then
-			velocity.x = 0
-		end
-		if (collision(position + {0, velocity.y})) then
-			velocity.y = 0
-		end
-	end
-	position = position + velocity
-```
-
-This code is a basic outline for a collision system that preserves the object's
-motion, but it still leaves several pixels of space between the bounding boxes.
-Notably, it also treats "collision" as an abstract concept, rather than as an
-event that could happen multiple times per frame.
-
--------------------------
-
-```
-	velocity = motion + speed
-	if (collisionSimple(BOXSET, position + velocity)) then
-		velocity.x = collisionX(BOXSET, velocity.x)
-		velocity.y = collisionY(BOXSET, velocity.y)
-	end
-	position = position + velocity
-```
-
-Here, collisions are still abstract, but "BOXSET" is defined externally
-(probably as a set of solid boxes, and their positions). This does require more
-in depth calculations, as well as three specialized utility functions, but the
-results might be what I'm looking for.
-
-If there are any collisions between the player object and the given box set,
-then collisionX() and collisionY() are called to calculate the new distance
-that the character will move.
-
--------------------------
-
-```
-	bool collisionSimple(BOXSET, newPos):
-		for_each box in BOXSET do
-			if (box.overlap(PLAYER.box + newPos)) then
-				return true
-			end
-		end
-		return false
-	end
-```
-
-collisionSimple() first runs through the BOXSET, checking if any of the given
-bounding boxes would collide with the player object's new position (just
-pretend PLAYER is accessible). In this case, non-tile bounding boxes can be
-included as part of BOXSET; they're treated just the same. The optimal outcome
-is that there are no collisions.
-
-A possible, but flawed, optimization that could be preformed here is to remove
-any elements from BOXSET that do not collide with newPos, and let the other
-utility functions operate only on what remains. However, if there are any
-collisions, than newPos is not the algorithm's final result, therefore any
-final result that the algorithm would calculate based on the remaining elements
-would not have been checked against the removed elements.
-
-Just something to note.
-
--------------------------
-
-```
-	var collisionX(BOXSET, velocityX):
-		var ret = velocityX
-
-		for_each box in BOXSET do
-			if (box.overlap(PLAYER.box + PLAYER.position + {velocityX,0})) then
-				if (velocityX > 0) then
-					ret = min(ret, box.west - PLAYER.position.x)
-				else
-					ret = max(ret, box.east - PLAYER.position.x)
-				end
-			end
-		end
-
-		return ret
-	end
-```
-
-Two things: 1. collisionX() and collisionY() should be identical except for the
-axis of operation and 2. if a player object is "sliding" along a wall (or
-stuck), then these functions will be called every frame.
-
-collisionX() and collisionY() check the sides of the elements in BOXSET, and if
-there's a box that the player would collide with, given the current distance to
-move, than the distance is reduced, based on if the character is moving left or
-right (or up or down).
-
-An unfortunate bug I can already see is that this logic doesn't check corners;
-it might be possible to get stuck on a corner of a wall, but if this becomes an
-issue in my implementation I will update this article with that information,
-and you can promptly ignore it.

client/base_scene.cpp

@@ -0,0 +1,105 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "base_scene.hpp"
+
+SDL_Renderer* BaseScene::rendererHandle = nullptr;
+
+BaseScene::BaseScene() {
+	//EMPTY
+}
+
+BaseScene::~BaseScene() {
+	//EMPTY
+}
+
+void BaseScene::RenderFrame(SDL_Renderer* renderer) {
+	//EMPTY
+}
+
+void BaseScene::SetRenderer(SDL_Renderer* r) {
+	rendererHandle = r;
+}
+
+SDL_Renderer* BaseScene::GetRenderer() {
+	return rendererHandle;
+}
+
+void BaseScene::SetSceneSignal(SceneSignal signal) {
+	sceneSignal = signal;
+}
+
+SceneSignal BaseScene::GetSceneSignal() {
+	return sceneSignal;
+}
+
+//-------------------------
+//frame phases
+//-------------------------
+
+void BaseScene::FrameStart() {
+	//EMPTY
+}
+
+void BaseScene::Update() {
+	//EMPTY
+}
+
+void BaseScene::FrameEnd() {
+	//EMPTY
+}
+
+//-------------------------
+//input events
+//-------------------------
+
+void BaseScene::QuitEvent() {
+	sceneSignal = SceneSignal::QUIT;
+}
+
+void BaseScene::MouseMotion(SDL_MouseMotionEvent const& event) {
+	//EMPTY
+}
+
+void BaseScene::MouseButtonDown(SDL_MouseButtonEvent const& event) {
+	//EMPTY
+}
+
+void BaseScene::MouseButtonUp(SDL_MouseButtonEvent const& event) {
+	//EMPTY
+}
+
+void BaseScene::MouseWheel(SDL_MouseWheelEvent const& event) {
+	//EMPTY
+}
+
+void BaseScene::KeyDown(SDL_KeyboardEvent const& event) {
+	//preference as a default
+	switch(event.keysym.sym) {
+		case SDLK_ESCAPE:
+			QuitEvent();
+		break;
+	}
+}
+
+void BaseScene::KeyUp(SDL_KeyboardEvent const& event) {
+	//EMPTY
+}

client/base_scene.hpp

@@ -0,0 +1,61 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "scene_signal.hpp"
+
+#include "SDL2/SDL.h"
+
+class BaseScene {
+public:
+	BaseScene();
+	virtual ~BaseScene();
+
+	virtual void RenderFrame(SDL_Renderer*);
+	static void SetRenderer(SDL_Renderer*);
+	SceneSignal GetSceneSignal();
+
+	//frame phases
+	virtual void FrameStart();
+	virtual void Update();
+	virtual void FrameEnd();
+
+	//input events
+	virtual void QuitEvent();
+	virtual void MouseMotion(SDL_MouseMotionEvent const& event);
+	virtual void MouseButtonDown(SDL_MouseButtonEvent const& event);
+	virtual void MouseButtonUp(SDL_MouseButtonEvent const& event);
+	virtual void MouseWheel(SDL_MouseWheelEvent const& event);
+	virtual void KeyDown(SDL_KeyboardEvent const& event);
+	virtual void KeyUp(SDL_KeyboardEvent const& event);
+
+	//TODO: (9) joystick and controller events
+
+protected:
+	//control
+	static SDL_Renderer* GetRenderer();
+	void SetSceneSignal(SceneSignal);
+
+private:
+	static SDL_Renderer* rendererHandle;
+	SceneSignal sceneSignal = SceneSignal::CONTINUE;
+};

client/channels.hpp

@@ -0,0 +1,26 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+enum Channels {
+	SERVER = 0
+};

client/client_application.cpp

@@ -0,0 +1,358 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "client_application.hpp"
+
+#include "serial_packet.hpp"
+#include "config_utility.hpp"
+
+//for handling platforms
+#include "SDL2/SDL_syswm.h"
+#include "SDL2/SDL_version.h"
+
+#include <chrono>
+#include <iostream>
+#include <sstream>
+#include <stdexcept>
+
+//-------------------------
+//Public access members
+//-------------------------
+
+void ClientApplication::Init(int argc, char* argv[]) {
+	std::cout << "Beginning " << argv[0] << std::endl;
+
+	//load the prerequisites
+	ConfigUtility& config = ConfigUtility::GetSingleton();
+	config.Load("rsc/config.cfg", false, argc, argv);
+
+	//-------------------------
+	//Initialize SDL
+	//-------------------------
+
+	if (SDL_Init(0)) {
+		std::ostringstream msg;
+		msg << "Failed to initialize SDL: " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+
+	//-------------------------
+	//create and check the window
+	//-------------------------
+
+	//get the config values
+	int w = config.Int("client.screen.w");
+	int h = config.Int("client.screen.h");
+	int f = config.Boolean("client.screen.f") ? SDL_WINDOW_FULLSCREEN : 0;
+
+	//BUG: fullscreen is disabled
+	f = 0;
+
+	//default sizes
+	w = w ? w : 800;
+	h = h ? h : 600;
+
+	window = SDL_CreateWindow(argv[0], SDL_WINDOWPOS_UNDEFINED, SDL_WINDOWPOS_UNDEFINED, w, h, f);
+
+	if (!window) {
+		std::ostringstream msg;
+		msg << "Failed to create the window: " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+
+	std::cout << "Initialized the window" << std::endl;
+
+	//-------------------------
+	//DEBUG: detecting platforms, versions & appropriate fonts
+	//-------------------------
+
+	SDL_SysWMinfo windowInfo;
+	SDL_VERSION(&windowInfo.version);
+	if (SDL_GetWindowWMInfo(window, &windowInfo)) {
+		//
+		std::string platform;
+		std::string fontPath;
+
+		//get the info
+		switch(windowInfo.subsystem) {
+			case SDL_SYSWM_WINDOWS:
+				platform = "Microsoft Windows";
+			break;
+
+			case SDL_SYSWM_X11:
+				platform = "X Window System";
+			break;
+
+			//NOTE: OS X is currently unsupported, but it could be
+			case SDL_SYSWM_COCOA:
+				platform = "Apple OS X";
+			break;
+
+			default:
+				platform = "an unsupported platform";
+		}
+
+		//final output
+		std::cout << "SDL Version ";
+		std::cout << (int)windowInfo.version.major << ".";
+		std::cout << (int)windowInfo.version.minor << ".";
+		std::cout << (int)windowInfo.version.patch << " on ";
+		std::cout << platform << std::endl;
+	}
+	else {
+		std::ostringstream msg;
+		msg << "Failed to retrieve window info: " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+
+	//-------------------------
+	//create and check the renderer
+	//-------------------------
+
+	renderer = SDL_CreateRenderer(window, -1, 0);
+
+	if (!renderer) {
+		std::ostringstream msg;
+		msg << "Failed to create the renderer: " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+
+	//screen scaling
+	SDL_SetHint(SDL_HINT_RENDER_SCALE_QUALITY, "best");
+	SDL_RenderSetLogicalSize(renderer, w, h);
+
+	//set the hook for the renderer
+	BaseScene::SetRenderer(renderer);
+
+	std::cout << "Initialized the renderer" << std::endl;
+
+	//-------------------------
+	//Initialize the APIs
+	//-------------------------
+
+	//initialize SDL_net
+	if (SDLNet_Init()) {
+		std::ostringstream msg;
+		msg << "Failed to initialize SDL_net 2.0: " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+	UDPNetworkUtility::GetSingleton().Open(0);
+
+	std::cout << "Initialized SDL_net 2.0" << std::endl;
+
+	//setting up SDL2_ttf
+	if (TTF_Init()) {
+		std::ostringstream msg;
+		msg << "Failed to initialize SDL_ttf 2.0: " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+
+	std::cout << "Initialized SDL_ttf 2.0" << std::endl;
+
+	//-------------------------
+	//debug output
+	//-------------------------
+
+#define DEBUG_INTERNAL_VAR(x) std::cout << "\t" << #x << ": " << x << std::endl;
+
+	std::cout << "Internal sizes:" << std::endl;
+
+	DEBUG_INTERNAL_VAR(NETWORK_VERSION);
+	DEBUG_INTERNAL_VAR(sizeof(Region::type_t));
+	DEBUG_INTERNAL_VAR(sizeof(Region));
+	DEBUG_INTERNAL_VAR(REGION_WIDTH);
+	DEBUG_INTERNAL_VAR(REGION_HEIGHT);
+	DEBUG_INTERNAL_VAR(REGION_DEPTH);
+	DEBUG_INTERNAL_VAR(REGION_TILE_FOOTPRINT);
+	DEBUG_INTERNAL_VAR(REGION_SOLID_FOOTPRINT);
+	DEBUG_INTERNAL_VAR(PACKET_STRING_SIZE);
+	DEBUG_INTERNAL_VAR(PACKET_BUFFER_SIZE);
+	DEBUG_INTERNAL_VAR(MAX_PACKET_SIZE);
+	DEBUG_INTERNAL_VAR(static_cast<int>(SerialPacketType::LAST));
+
+	//-------------------------
+	//finalize the startup
+	//-------------------------
+
+	std::cout << "Startup completed successfully" << std::endl;
+
+	//-------------------------
+	//debugging
+	//-------------------------
+
+	//...
+}
+
+void ClientApplication::Proc() {
+	//load the first scene
+	ProcessSceneSignal(SceneSignal::FIRST);
+
+	//fixed frame rate
+	typedef std::chrono::steady_clock Clock;
+
+	Clock::time_point simTime = Clock::now();
+	Clock::time_point realTime;
+	constexpr std::chrono::duration<int, std::milli> frameDelay(16); //~60FPS
+
+	//the game loop continues until the scenes signal QUIT
+	while(activeScene->GetSceneSignal() != SceneSignal::QUIT) {
+		//switch scenes if necessary
+		if(activeScene->GetSceneSignal() != SceneSignal::CONTINUE) {
+			ProcessSceneSignal(activeScene->GetSceneSignal());
+			continue;
+		}
+
+		//update the current time
+		realTime = Clock::now();
+
+		//simulate the game or give the machine a break
+		if (simTime < realTime) {
+			while(simTime < realTime) {
+				//call the user defined functions
+				activeScene->FrameStart();
+				ProcessEvents();
+				activeScene->Update();
+				activeScene->FrameEnd();
+
+				//step to the next frame
+				simTime += frameDelay;
+			}
+		}
+		else {
+			SDL_Delay(1);
+		}
+
+		SDL_RenderClear(renderer);
+		activeScene->RenderFrame(renderer);
+		SDL_RenderPresent(renderer);
+	}
+
+	//cleanup
+	ClearScene();
+}
+
+void ClientApplication::Quit() {
+	//clean up after the program
+	std::cout << "Shutting down" << std::endl;
+	UDPNetworkUtility::GetSingleton().Close();
+	TTF_Quit();
+	SDLNet_Quit();
+	BaseScene::SetRenderer(nullptr);
+	SDL_DestroyRenderer(renderer);
+	SDL_DestroyWindow(window);
+	SDL_Quit();
+	std::cout << "Clean exit" << std::endl;
+}
+
+//-------------------------
+//Scene management
+//-------------------------
+
+void ClientApplication::ProcessEvents() {
+	SDL_Event event;
+	while(SDL_PollEvent(&event)) {
+		switch(event.type) {
+			case SDL_QUIT:
+				activeScene->QuitEvent();
+			break;
+
+			case SDL_MOUSEMOTION:
+				activeScene->MouseMotion(event.motion);
+			break;
+
+			case SDL_MOUSEBUTTONDOWN:
+				activeScene->MouseButtonDown(event.button);
+			break;
+
+			case SDL_MOUSEBUTTONUP:
+				activeScene->MouseButtonUp(event.button);
+			break;
+
+			case SDL_MOUSEWHEEL:
+				activeScene->MouseWheel(event.wheel);
+			break;
+
+			case SDL_KEYDOWN:
+				activeScene->KeyDown(event.key);
+			break;
+
+			case SDL_KEYUP:
+				activeScene->KeyUp(event.key);
+			break;
+
+			//TODO: (9) joystick and controller events
+
+			//window events are handled internally
+			case SDL_WINDOWEVENT:
+				switch(event.window.event) {
+					case SDL_WINDOWEVENT_RESIZED:
+						SDL_RenderSetLogicalSize(renderer, event.window.data1, event.window.data2);
+					break;
+				}
+			break;
+		}
+	}
+}
+
+//Add the custom scene headers here
+#include "splash_screen.hpp"
+#include "main_menu.hpp"
+#include "options_menu.hpp"
+#include "lobby_menu.hpp"
+#include "world.hpp"
+#include "disconnected_screen.hpp"
+
+void ClientApplication::ProcessSceneSignal(SceneSignal signal) {
+	//BUG: #16 Resources are being reloaded between scenes
+	ClearScene();
+	switch(signal) {
+		//add scene creation calls here
+		case SceneSignal::FIRST:
+		case SceneSignal::SPLASHSCREEN:
+			activeScene = new SplashScreen(window);
+		break;
+		case SceneSignal::MAINMENU:
+			activeScene = new MainMenu();
+		break;
+		case SceneSignal::OPTIONSMENU:
+			activeScene = new OptionsMenu();
+		break;
+		case SceneSignal::LOBBYMENU:
+			activeScene = new LobbyMenu(&clientIndex, &accountIndex);
+		break;
+		case SceneSignal::WORLD:
+			activeScene = new World(&clientIndex, &accountIndex);
+		break;
+		case SceneSignal::DISCONNECTEDSCREEN:
+			activeScene = new DisconnectedScreen();
+		break;
+		default: {
+			std::ostringstream msg;
+			msg << "Failed to recognize the scene signal: " << signal;
+			throw(std::logic_error(msg.str()));
+		}
+	}
+}
+
+void ClientApplication::ClearScene() {
+	delete activeScene;
+	activeScene = nullptr;
+}

client/client_application.hpp

@@ -0,0 +1,59 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "base_scene.hpp"
+#include "scene_signal.hpp"
+#include "singleton.hpp"
+#include "udp_network_utility.hpp"
+
+#include "SDL2/SDL.h"
+#include "SDL2/SDL_net.h"
+#include "SDL2/SDL_ttf.h"
+
+class ClientApplication: public Singleton<ClientApplication> {
+public:
+	void Init(int argc, char* argv[]);
+	void Proc();
+	void Quit();
+
+private:
+	friend Singleton<ClientApplication>;
+
+	ClientApplication() = default;
+	~ClientApplication() = default;
+
+	//scene management
+	void ProcessEvents();
+	void ProcessSceneSignal(SceneSignal);
+	void ClearScene();
+
+	BaseScene* activeScene = nullptr;
+
+	//TODO: (9) build a "window" class?
+	SDL_Window* window = nullptr;
+	SDL_Renderer* renderer = nullptr;
+
+	//global scene parameters
+	int clientIndex = -1;
+	int accountIndex = -1;
+};

client/entities/base_character.cpp

@@ -0,0 +1,84 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "base_character.hpp"
+
+//TODO: (3) remove this
+#include "config_utility.hpp"
+
+//-------------------------
+//graphics
+//-------------------------
+
+void BaseCharacter::CorrectSprite() {
+	//NOTE: These must correspond to the sprite sheet in use
+	if (motion.y > 0) {
+		sprite.SetIndexY(0);
+	}
+	else if (motion.y < 0) {
+		sprite.SetIndexY(1);
+	}
+	else if (motion.x > 0) {
+		sprite.SetIndexY(3);
+	}
+	else if (motion.x < 0) {
+		sprite.SetIndexY(2);
+	}
+
+	//animation
+	if (motion != 0) {
+		sprite.SetDelay(0.1);
+	}
+	else {
+		sprite.SetDelay(0);
+		sprite.SetIndexX(0);
+	}
+}
+
+//-------------------------
+//metadata
+//-------------------------
+
+int BaseCharacter::SetOwner(int i) {
+	return owner = i;
+}
+
+int BaseCharacter::GetOwner() {
+	return owner;
+}
+
+std::string BaseCharacter::SetHandle(std::string s) {
+	return handle = s;
+}
+
+std::string BaseCharacter::GetHandle() const {
+	return handle;
+}
+
+std::string BaseCharacter::SetAvatar(SDL_Renderer* const renderer, std::string s) {
+	avatar = s;
+	sprite.Load(renderer, ConfigUtility::GetSingleton()["dir.sprites"] + avatar, CHARACTER_CELLS_X, CHARACTER_CELLS_Y);
+	return avatar;
+}
+
+std::string BaseCharacter::GetAvatar() const {
+	return avatar;
+}

client/entities/base_character.hpp

@@ -0,0 +1,52 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+//components
+#include "character_defines.hpp"
+#include "entity.hpp"
+
+//std namespace
+#include <string>
+
+class BaseCharacter: public Entity {
+public:
+	BaseCharacter() = default;
+	virtual ~BaseCharacter() = default;
+
+	//graphics
+	void CorrectSprite();
+
+	//metadata
+	int SetOwner(int i);
+	int GetOwner();
+	std::string SetHandle(std::string s);
+	std::string GetHandle() const;
+	std::string SetAvatar(SDL_Renderer* const, std::string s);
+	std::string GetAvatar() const;
+
+protected:
+	//metadata
+	int owner;
+	std::string handle;
+	std::string avatar;
+};

client/entities/base_creature.cpp

@@ -0,0 +1,46 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "base_creature.hpp"
+
+#include "config_utility.hpp"
+
+void BaseCreature::CorrectSprite() {
+	//TODO: (9) BaseCreature::CorrectSprite()
+}
+
+std::string BaseCreature::SetHandle(std::string s) {
+	return handle = s;
+}
+
+std::string BaseCreature::GetHandle() const {
+	return handle;
+}
+
+std::string BaseCreature::SetAvatar(SDL_Renderer* const renderer, std::string s) {
+	avatar = s;
+	sprite.Load(renderer, ConfigUtility::GetSingleton()["dir.sprites"] + avatar, 4, 1);
+	return avatar;
+}
+
+std::string BaseCreature::GetAvatar() const {
+	return avatar;
+}

client/entities/base_creature.hpp

@@ -0,0 +1,42 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "entity.hpp"
+
+class BaseCreature: public Entity {
+public:
+	BaseCreature() = default;
+	virtual ~BaseCreature() = default;
+
+	void CorrectSprite();
+
+	std::string SetHandle(std::string s);
+	std::string GetHandle() const;
+	std::string SetAvatar(SDL_Renderer* const, std::string s);
+	std::string GetAvatar() const;
+
+protected:
+	//metadata
+	std::string handle;
+	std::string avatar;
+};

client/entities/entity.cpp

@@ -0,0 +1,63 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "entity.hpp"
+
+void Entity::Update() {
+	origin += motion;
+	sprite.Update(0.016);
+}
+
+void Entity::DrawTo(SDL_Renderer* const renderer, int camX, int camY) {
+	sprite.DrawTo(renderer, origin.x - camX, origin.y - camY);
+}
+
+SpriteSheet* Entity::GetSprite() {
+	return &sprite;
+}
+
+//-------------------------
+//accessors & mutators
+//-------------------------
+
+Vector2 Entity::SetOrigin(Vector2 v) {
+	return origin = v;
+}
+
+Vector2 Entity::SetMotion(Vector2 v) {
+	return motion = v;
+}
+
+BoundingBox Entity::SetBounds(BoundingBox b) {
+	return bounds = b;
+}
+
+Vector2 Entity::GetOrigin() {
+	return origin;
+}
+
+Vector2 Entity::GetMotion() {
+	return motion;
+}
+
+BoundingBox Entity::GetBounds() {
+	return bounds;
+}

client/entities/entity.hpp

@@ -0,0 +1,54 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "bounding_box.hpp"
+#include "sprite_sheet.hpp"
+#include "vector2.hpp"
+
+//The base class for all objects in the world
+//TODO: (9) write a better hierarchy
+class Entity {
+public:
+	virtual void Update();
+	virtual void DrawTo(SDL_Renderer* const, int camX, int camY);
+
+	SpriteSheet* GetSprite();
+
+	//accessors & mutators
+	Vector2 SetOrigin(Vector2 v);
+	Vector2 SetMotion(Vector2 v);
+	BoundingBox SetBounds(BoundingBox b);
+
+	Vector2 GetOrigin();
+	Vector2 GetMotion();
+	BoundingBox GetBounds();
+
+protected:
+	Entity() = default;
+	virtual ~Entity() = default;
+
+	SpriteSheet sprite;
+	Vector2 origin;
+	Vector2 motion;
+	BoundingBox bounds;
+};

client/entities/local_character.cpp

@@ -0,0 +1,36 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "local_character.hpp"
+
+#include <iostream>
+
+bool LocalCharacter::ProcessCollisionGrid(std::list<BoundingBox> boxList) {
+	for(auto& box : boxList) {
+		if (box.CheckOverlap(origin + bounds)) {
+			//TODO: (9) write a better collision system
+			origin -= motion;
+			motion = {0, 0};
+			return true;
+		}
+	}
+	return false;
+}

client/entities/local_character.hpp

@@ -0,0 +1,39 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "base_character.hpp"
+#include "bounding_box.hpp"
+#include "vector2.hpp"
+
+#include <list>
+
+class LocalCharacter: public BaseCharacter {
+public:
+	LocalCharacter() = default;
+	virtual ~LocalCharacter() = default;
+
+	bool ProcessCollisionGrid(std::list<BoundingBox>);
+
+private:
+	//NOTE: NO MEMBERS
+};

client/entities/makefile

@@ -0,0 +1,32 @@
+#config
+INCLUDES+=. .. ../../common/gameplay ../../common/graphics ../../common/utilities
+LIBS+=
+CXXFLAGS+=-std=c++11 $(addprefix -I,$(INCLUDES))
+
+#source
+CXXSRC=$(wildcard *.cpp)
+
+#objects
+OBJDIR=obj
+OBJ+=$(addprefix $(OBJDIR)/,$(CXXSRC:.cpp=.o))
+
+#output
+OUTDIR=..
+OUT=$(addprefix $(OUTDIR)/,client.a)
+
+#targets
+all: $(OBJ) $(OUT)
+	ar -crs $(OUT) $(OBJ)
+
+$(OBJ): | $(OBJDIR)
+
+$(OUT): | $(OUTDIR)
+
+$(OBJDIR):
+	mkdir $(OBJDIR)
+
+$(OUTDIR):
+	mkdir $(OUTDIR)
+
+$(OBJDIR)/%.o: %.cpp
+	$(CXX) $(CXXFLAGS) -c -o $@ $<

client/fatal_error.cpp

@@ -0,0 +1,24 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "fatal_error.hpp"
+
+//DOCS: This empty file is used to force an object file

client/fatal_error.hpp

@@ -0,0 +1,31 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include <stdexcept>
+#include <string>
+
+class fatal_error: public std::runtime_error {
+public:
+	explicit fatal_error(const std::string& str): runtime_error(str) {}
+	explicit fatal_error(const char* cstr): runtime_error(cstr) {}
+};

client/main.cpp

@@ -0,0 +1,59 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "client_application.hpp"
+
+//singletons
+#include "config_utility.hpp"
+#include "udp_network_utility.hpp"
+
+#include <stdexcept>
+#include <iostream>
+
+using namespace std;
+
+int main(int argc, char* argv[]) {
+	try {
+		//create the singletons
+		ConfigUtility::CreateSingleton();
+		UDPNetworkUtility::CreateSingleton();
+
+		//call the client's routines
+		ClientApplication::CreateSingleton();
+		ClientApplication& app = ClientApplication::GetSingleton();
+
+		app.Init(argc, argv);
+		app.Proc();
+		app.Quit();
+
+		//control the position of the app's destructor
+		ClientApplication::DeleteSingleton();
+
+		//delete the singletons
+		ConfigUtility::DeleteSingleton();
+		UDPNetworkUtility::DeleteSingleton();
+	}
+	catch(exception& e) {
+		cerr << "Fatal exception thrown: " << e.what() << endl;
+		return 1;
+	}
+	return 0;
+}

client/makefile

@@ -0,0 +1,58 @@
+#include directories
+INCLUDES+=. entities scenes ../common/debugging ../common/gameplay ../common/graphics ../common/map ../common/network ../common/network/packet_types ../common/ui ../common/utilities
+
+#libraries
+#the order of the $(LIBS) is important, at least for MinGW
+LIBS+=client.a ../common/libcommon.a -lSDL2_net
+ifeq ($(OS),Windows_NT)
+	LIBS+=-lwsock32 -liphlpapi -lmingw32
+endif
+LIBS+=-lSDL2main -lSDL2 -lSDL2_image -lSDL2_ttf
+
+#flags
+CXXFLAGS+=-std=c++11 $(addprefix -I,$(INCLUDES))
+ifeq ($(shell uname), Linux)
+	#read data about the current install
+	CXXFLAGS+=$(shell sdl-config --cflags --static-libs)
+endif
+
+#source
+CXXSRC=$(wildcard *.cpp)
+
+#objects
+OBJDIR=obj
+OBJ+=$(addprefix $(OBJDIR)/,$(CXXSRC:.cpp=.o))
+
+#output
+OUTDIR=../out
+OUT=$(addprefix $(OUTDIR)/,client)
+
+#targets
+all: $(OBJ) $(OUT)
+	$(MAKE) -C entities
+	$(MAKE) -C scenes
+	$(CXX) $(CXXFLAGS) -o $(OUT) $(OBJ) $(LIBS)
+
+$(OBJ): | $(OBJDIR)
+
+$(OUT): | $(OUTDIR)
+
+$(OBJDIR):
+	mkdir $(OBJDIR)
+
+$(OUTDIR):
+	mkdir $(OUTDIR)
+
+$(OBJDIR)/%.o: %.cpp
+	$(CXX) $(CXXFLAGS) -c -o $@ $<
+
+clean:
+ifeq ($(OS),Windows_NT)
+	$(RM) *.o *.a *.exe
+else ifeq ($(shell uname), Linux)
+	find . -type f -name *.o -exec rm -f -r -v {} \;
+	find . -type f -name *.a -exec rm -f -r -v {} \;
+	rm -f -v out/client out/server
+endif
+
+rebuild: clean all

client/scene_signal.hpp

@@ -0,0 +1,37 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+enum SceneSignal {
+	//reserved members for internal use
+	QUIT = -1,
+	CONTINUE = 0,
+	FIRST = 1,
+
+	//custom scenes
+	SPLASHSCREEN,
+	MAINMENU,
+	OPTIONSMENU,
+	LOBBYMENU,
+	WORLD,
+	DISCONNECTEDSCREEN,
+};

client/scenes/disconnected_screen.cpp

@@ -0,0 +1,130 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "disconnected_screen.hpp"
+
+#include "channels.hpp"
+#include "config_utility.hpp"
+#include "udp_network_utility.hpp"
+
+#include <sstream>
+#include <stdexcept>
+
+//-------------------------
+//Public access members
+//-------------------------
+
+DisconnectedScreen::DisconnectedScreen() {
+	ConfigUtility& config = ConfigUtility::GetSingleton();
+
+	//setup the utility objects
+	//TODO: (1) resource tool, to prevent reloading like this
+	image.Load(GetRenderer(), config["dir.interface"] + "button_blue.png");
+	font = TTF_OpenFont(config["client.font"].c_str(), 12);
+
+	//check that the font loaded
+	if (!font) {
+		std::ostringstream msg;
+		msg << "Failed to load a font file; " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+
+	//setup the button
+	backButton.SetBackgroundTexture(GetRenderer(), image.GetTexture());
+	backButton.SetText(GetRenderer(), font, "Back", COLOR_WHITE);
+
+	//set the button positions
+	backButton.SetX(50);
+	backButton.SetY(50);
+
+	//set the disconnection message text
+	textLine.SetText(GetRenderer(), font, config["client.disconnectMessage"], {255, 255, 255, 255});
+
+	//full reset
+	UDPNetworkUtility::GetSingleton().Unbind(Channels::SERVER);
+
+	//auto return
+	startTick = std::chrono::steady_clock::now();
+}
+
+DisconnectedScreen::~DisconnectedScreen() {
+	TTF_CloseFont(font);
+}
+
+//-------------------------
+//Frame loop
+//-------------------------
+
+void DisconnectedScreen::FrameStart() {
+	//
+}
+
+void DisconnectedScreen::Update() {
+	if (std::chrono::steady_clock::now() - startTick > std::chrono::duration<int>(10)) {
+		SetSceneSignal(SceneSignal::MAINMENU);
+	}
+
+	//Eat incoming packets
+	while(UDPNetworkUtility::GetSingleton().Receive());
+}
+
+void DisconnectedScreen::FrameEnd() {
+	//
+}
+
+void DisconnectedScreen::RenderFrame(SDL_Renderer* renderer) {
+	backButton.DrawTo(renderer);
+	textLine.DrawTo(renderer, 50, 30);
+}
+
+//-------------------------
+//Event handlers
+//-------------------------
+
+void DisconnectedScreen::MouseMotion(SDL_MouseMotionEvent const& event) {
+	backButton.MouseMotion(event);
+}
+
+void DisconnectedScreen::MouseButtonDown(SDL_MouseButtonEvent const& event) {
+	backButton.MouseButtonDown(event);
+}
+
+void DisconnectedScreen::MouseButtonUp(SDL_MouseButtonEvent const& event) {
+	if (backButton.MouseButtonUp(event) == Button::State::RELEASED) {
+		SetSceneSignal(SceneSignal::MAINMENU);
+	}
+}
+
+void DisconnectedScreen::MouseWheel(SDL_MouseWheelEvent const& event) {
+	//
+}
+
+void DisconnectedScreen::KeyDown(SDL_KeyboardEvent const& event) {
+	switch(event.keysym.sym) {
+		case SDLK_ESCAPE:
+			SetSceneSignal(SceneSignal::MAINMENU);
+		break;
+	}
+}
+
+void DisconnectedScreen::KeyUp(SDL_KeyboardEvent const& event) {
+	//
+}

client/scenes/disconnected_screen.hpp

@@ -0,0 +1,63 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "base_scene.hpp"
+#include "button.hpp"
+#include "image.hpp"
+#include "text_line.hpp"
+
+#include "SDL2/SDL_ttf.h"
+
+#include <chrono>
+
+class DisconnectedScreen : public BaseScene {
+public:
+	//Public access members
+	DisconnectedScreen();
+	~DisconnectedScreen();
+
+	void RenderFrame(SDL_Renderer* renderer) override;
+
+protected:
+	//frame phases
+	void FrameStart() override;
+	void Update() override;
+	void FrameEnd() override;
+
+	//input events
+	void MouseMotion(SDL_MouseMotionEvent const& event) override;
+	void MouseButtonDown(SDL_MouseButtonEvent const& event) override;
+	void MouseButtonUp(SDL_MouseButtonEvent const& event) override;
+	void MouseWheel(SDL_MouseWheelEvent const& event) override;
+	void KeyDown(SDL_KeyboardEvent const& event) override;
+	void KeyUp(SDL_KeyboardEvent const& event) override;
+
+	//graphics
+	Image image;
+	TTF_Font* font = nullptr;
+	Button backButton;
+	TextLine textLine;
+
+	//auto return
+	std::chrono::steady_clock::time_point startTick;
+};

client/scenes/lobby_menu.cpp

@@ -0,0 +1,314 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "lobby_menu.hpp"
+
+#include "channels.hpp"
+
+#include <cstring>
+#include <stdexcept>
+#include <sstream>
+
+//-------------------------
+//Public access members
+//-------------------------
+
+LobbyMenu::LobbyMenu(int* const argClientIndex, int* const argAccountIndex):
+	clientIndex(*argClientIndex),
+	accountIndex(*argAccountIndex)
+{
+	//preemptive reset
+	clientIndex = -1;
+	accountIndex = -1;
+
+	//setup the utility objects
+	buttonImage.Load(GetRenderer(), config["dir.interface"] + "button_blue.png");
+	font = TTF_OpenFont(config["client.font"].c_str(), 12);
+
+	//check that the font loaded
+	if (!font) {
+		std::ostringstream msg;
+		msg << "Failed to load a font file; " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+
+	//setup the buttons
+	searchButton.SetBackgroundTexture(GetRenderer(), buttonImage.GetTexture());
+	searchButton.SetText(GetRenderer(), font, "Search", COLOR_WHITE);
+	joinButton.SetBackgroundTexture(GetRenderer(), buttonImage.GetTexture());
+	joinButton.SetText(GetRenderer(), font, "Join", COLOR_WHITE);
+	backButton.SetBackgroundTexture(GetRenderer(), buttonImage.GetTexture());
+	backButton.SetText(GetRenderer(), font, "Back", COLOR_WHITE);
+
+	//set the button positions (assumed)
+	searchButton.SetX(50);
+	searchButton.SetY(50);
+	joinButton.SetX(50);
+	joinButton.SetY(70);
+	backButton.SetX(50);
+	backButton.SetY(90);
+
+	//pseudo-list selection
+	boundingBox = {300, 50, 200, 12};
+
+	//hacked together a highlight box
+	highlightImage.Create(GetRenderer(), 300, 12, {49, 150, 5, 255});
+
+	//Eat incoming packets
+	while(network.Receive());
+
+	//Initial broadcast
+	SendBroadcastRequest();
+}
+
+LobbyMenu::~LobbyMenu() {
+	TTF_CloseFont(font);
+}
+
+//-------------------------
+//Frame loop
+//-------------------------
+
+void LobbyMenu::FrameStart() {
+	//
+}
+
+void LobbyMenu::Update() {
+	//suck in and process all waiting packets
+	SerialPacket* packetBuffer = reinterpret_cast<SerialPacket*>(new char[MAX_PACKET_SIZE]);
+	while(network.Receive(packetBuffer)) {
+		HandlePacket(packetBuffer);
+	}
+	delete reinterpret_cast<char*>(packetBuffer);
+}
+
+void LobbyMenu::FrameEnd() {
+	//
+}
+
+void LobbyMenu::RenderFrame(SDL_Renderer* renderer) {
+	//TODO: (2) I need a proper UI system for the entire client and the editor
+
+	//UI
+	searchButton.DrawTo(renderer);
+	joinButton.DrawTo(renderer);
+	backButton.DrawTo(renderer);
+
+	//TODO: (3) draw headers for the server list
+	//TODO: (3) ping/delay displayed in the server list
+	for (int i = 0; i < serverVector.size(); i++) {
+		//draw the selected server's highlight
+		if (selection == &serverVector[i]) {
+			highlightImage.DrawTo(renderer, boundingBox.x, boundingBox.y + boundingBox.h * i);
+		}
+
+		//draw the server's info
+		serverVector[i].nameImage.DrawTo(renderer, boundingBox.x, boundingBox.y + boundingBox.h * i);
+		serverVector[i].playerCountImage.DrawTo(renderer, boundingBox.x+276, boundingBox.y + boundingBox.h * i);
+	}
+}
+
+//-------------------------
+//Event handlers
+//-------------------------
+
+void LobbyMenu::MouseMotion(SDL_MouseMotionEvent const& event) {
+	searchButton.MouseMotion(event);
+	joinButton.MouseMotion(event);
+	backButton.MouseMotion(event);
+}
+
+void LobbyMenu::MouseButtonDown(SDL_MouseButtonEvent const& event) {
+	searchButton.MouseButtonDown(event);
+	joinButton.MouseButtonDown(event);
+	backButton.MouseButtonDown(event);
+}
+
+void LobbyMenu::MouseButtonUp(SDL_MouseButtonEvent const& event) {
+	if (searchButton.MouseButtonUp(event) == Button::State::RELEASED) {
+		SendBroadcastRequest();
+	}
+	if (joinButton.MouseButtonUp(event) == Button::State::RELEASED && selection && selection->compatible) {
+		SendJoinRequest();
+	}
+	if (backButton.MouseButtonUp(event) == Button::State::RELEASED) {
+		SetSceneSignal(SceneSignal::MAINMENU);
+	}
+
+	//has the user selected a server on the list?
+	BoundingBox tmpBox = boundingBox;
+	tmpBox.h *= serverVector.size(); //within the list bounds
+	if (tmpBox.CheckOverlap({event.x, event.y})) {
+		//NOTE: this memory trick requires a vector
+		selection = &serverVector[(event.y - boundingBox.y)/boundingBox.h];
+	}
+	else {
+		selection = nullptr;
+	}
+}
+
+void LobbyMenu::MouseWheel(SDL_MouseWheelEvent const& event) {
+	//
+}
+
+void LobbyMenu::KeyDown(SDL_KeyboardEvent const& event) {
+	switch(event.keysym.sym) {
+		case SDLK_ESCAPE:
+			SetSceneSignal(SceneSignal::MAINMENU);
+		break;
+	}
+}
+
+void LobbyMenu::KeyUp(SDL_KeyboardEvent const& event) {
+	//
+}
+
+//-------------------------
+//Network handlers
+//-------------------------
+
+void LobbyMenu::HandlePacket(SerialPacket* const argPacket) {
+		switch(argPacket->type) {
+			//responses
+		case SerialPacketType::BROADCAST_RESPONSE:
+			HandleBroadcastResponse(static_cast<ServerPacket*>(argPacket));
+		break;
+		case SerialPacketType::JOIN_RESPONSE:
+			HandleJoinResponse(static_cast<ClientPacket*>(argPacket));
+		break;
+		case SerialPacketType::LOGIN_RESPONSE:
+			HandleLoginResponse(static_cast<ClientPacket*>(argPacket));
+		break;
+
+		//rejections
+		case SerialPacketType::JOIN_REJECTION:
+			HandleJoinRejection(static_cast<TextPacket*>(argPacket));
+		break;
+		case SerialPacketType::LOGIN_REJECTION:
+			HandleLoginRejection(static_cast<TextPacket*>(argPacket));
+		break;
+
+		//handle errors
+		default: {
+			std::ostringstream msg;
+			msg << "Unknown SerialPacketType encountered in LobbyMenu: " << static_cast<int>(argPacket->type);
+			throw(std::runtime_error( msg.str() ));
+		}
+		break;
+	}
+}
+
+void LobbyMenu::HandleBroadcastResponse(ServerPacket* const argPacket) {
+	//extract the data
+	ServerInfo newServer;
+
+	newServer.address = argPacket->srcAddress;
+	newServer.name = argPacket->name;
+	newServer.playerCount = argPacket->playerCount;
+	newServer.version = argPacket->version;
+	newServer.compatible = newServer.version == NETWORK_VERSION;
+
+	//push
+	serverVector.push_back(newServer);
+
+	//BUGFIX: since TextLine lacks the memory management of Image, I'll wait until after the line is in the vector to handle these
+
+	//fancy colors
+	SDL_Color color;
+	if (newServer.compatible) {
+		color = {255, 255, 255, 255};
+	}
+	else {
+		color = {255, 0, 0, 255};
+	}
+
+	//fancy itoa
+	auto itoa_base10 = [](int i) -> std::string {
+		char str[20];
+		sprintf(str, "%d", i);
+		return std::string(str);
+	};
+
+	//text graphics
+	serverVector.back().nameImage.SetText(GetRenderer(), font, newServer.name, color);
+	serverVector.back().playerCountImage.SetText(GetRenderer(), font, itoa_base10(newServer.playerCount), color);
+}
+
+void LobbyMenu::HandleJoinResponse(ClientPacket* const argPacket) {
+	//save the server's data
+	clientIndex = argPacket->clientIndex;
+	network.Bind(argPacket->srcAddress, Channels::SERVER);
+
+	//request login data
+	SendLoginRequest();
+}
+
+void LobbyMenu::HandleLoginResponse(ClientPacket* const argPacket) {
+	if (argPacket->clientIndex != clientIndex) {
+		throw(std::runtime_error("Client index invalid during login"));
+	}
+	accountIndex = argPacket->accountIndex;
+	SetSceneSignal(SceneSignal::WORLD);
+}
+
+void LobbyMenu::HandleJoinRejection(TextPacket* const argPacket) {
+	//TODO: (9) LobbyMenu::HandleJoinRejection()
+}
+
+void LobbyMenu::HandleLoginRejection(TextPacket* const argPacket) {
+	//TODO: (9) LobbyMenu::HandleLoginRejection
+}
+
+//-------------------------
+//server control
+//-------------------------
+
+void LobbyMenu::SendBroadcastRequest() {
+	//broadcast to the network, or a specific server
+		ClientPacket packet;
+		packet.type = SerialPacketType::BROADCAST_REQUEST;
+		network.SendTo(config["server.host"].c_str(), config.Int("server.port"), &packet);
+
+		//reset the server list
+		serverVector.clear();
+		selection = nullptr;
+}
+
+void LobbyMenu::SendJoinRequest() {
+	//pack the packet
+		ClientPacket packet;
+		packet.type = SerialPacketType::JOIN_REQUEST;
+
+		//join the selected server
+		network.SendTo(selection->address, &packet);
+		selection = nullptr;
+}
+
+void LobbyMenu::SendLoginRequest() {
+	//NOTE: high cohesion
+	//TODO: (9) have a separate login screen
+	ClientPacket packet;
+	packet.type = SerialPacketType::LOGIN_REQUEST;
+	packet.clientIndex = clientIndex;
+	strncpy(packet.username, config["client.username"].c_str(), PACKET_STRING_SIZE+1);
+
+	network.SendTo(Channels::SERVER, &packet);
+}

client/scenes/lobby_menu.hpp

@@ -0,0 +1,110 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+//graphics & ui
+#include "image.hpp"
+#include "button.hpp"
+#include "bounding_box.hpp"
+#include "text_line.hpp"
+
+#include "SDL2/SDL_ttf.h"
+
+//utilities
+#include "config_utility.hpp"
+#include "udp_network_utility.hpp"
+#include "serial_packet.hpp"
+
+//client
+#include "base_scene.hpp"
+
+//STL
+#include <vector>
+
+class LobbyMenu : public BaseScene {
+public:
+	//Public access members
+	LobbyMenu(int* const argClientIndex, int* const argAccountIndex);
+	~LobbyMenu();
+
+	void RenderFrame(SDL_Renderer* renderer) override;
+
+protected:
+	//frame phases
+	void FrameStart() override;
+	void Update() override;
+	void FrameEnd() override;
+
+	//input events
+	void MouseMotion(SDL_MouseMotionEvent const& event) override;
+	void MouseButtonDown(SDL_MouseButtonEvent const& event) override;
+	void MouseButtonUp(SDL_MouseButtonEvent const& event) override;
+	void MouseWheel(SDL_MouseWheelEvent const& event) override;
+	void KeyDown(SDL_KeyboardEvent const& event) override;
+	void KeyUp(SDL_KeyboardEvent const& event) override;
+
+	//Network handlers
+	void HandlePacket(SerialPacket* const);
+	void HandleBroadcastResponse(ServerPacket* const);
+	void HandleJoinResponse(ClientPacket* const);
+	void HandleLoginResponse(ClientPacket* const);
+	void HandleJoinRejection(TextPacket* const);
+	void HandleLoginRejection(TextPacket* const);
+
+	//server control
+	void SendBroadcastRequest();
+	void SendJoinRequest();
+	void SendLoginRequest();
+
+	//shared parameters
+	ConfigUtility& config = ConfigUtility::GetSingleton();
+	UDPNetworkUtility& network = UDPNetworkUtility::GetSingleton();
+	int& clientIndex;
+	int& accountIndex;
+
+	//define the list object
+	struct ServerInfo {
+		//graphics
+		TextLine nameImage;
+		TextLine playerCountImage;
+
+		//networking
+		IPaddress address;
+		std::string name;
+		int playerCount;
+		int version;
+		bool compatible;
+	};
+
+	//members
+	Image buttonImage;
+	Image highlightImage;
+	TTF_Font* font = nullptr;
+	Button searchButton;
+	Button joinButton;
+	Button backButton;
+
+	std::vector<ServerInfo> serverVector;
+	ServerInfo* selection = nullptr;
+
+	BoundingBox boundingBox;
+};

client/scenes/main_menu.cpp

@@ -0,0 +1,146 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "main_menu.hpp"
+
+#include "config_utility.hpp"
+
+#include <sstream>
+#include <stdexcept>
+
+//-------------------------
+//Public access members
+//-------------------------
+
+MainMenu::MainMenu() {
+	ConfigUtility& config = ConfigUtility::GetSingleton();
+
+	//setup the utility objects
+	buttonImage.Load(GetRenderer(), config["dir.interface"] + "button_blue.png");
+	font = TTF_OpenFont(config["client.font"].c_str(), 12);
+
+	//check that the font loaded
+	if (!font) {
+		std::ostringstream msg;
+		msg << "Failed to load a font file; " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+
+	//setup the buttons
+	startButton.SetBackgroundTexture(GetRenderer(), buttonImage.GetTexture());
+	startButton.SetText(GetRenderer(), font, "Start", COLOR_WHITE);
+	optionsButton.SetBackgroundTexture(GetRenderer(), buttonImage.GetTexture());
+	optionsButton.SetText(GetRenderer(), font, "Options", COLOR_WHITE);
+	quitButton.SetBackgroundTexture(GetRenderer(), buttonImage.GetTexture());
+	quitButton.SetText(GetRenderer(), font, "Quit", COLOR_WHITE);
+
+	//set the button positions
+	startButton.SetX(50);
+	startButton.SetY(50 + 20 * 0);
+	optionsButton.SetX(50);
+	optionsButton.SetY(50 + 20 * 1);
+	quitButton.SetX(50);
+	quitButton.SetY(50 + 20 * 2);
+
+	//text box
+	textBox.PushLine(GetRenderer(), font, "Thanks for playing!", {255, 255, 255, 255});
+	textBox.PushLine(GetRenderer(), font, "You can get the latest version at: ", {255, 255, 255, 255});
+	textBox.PushLine(GetRenderer(), font, "krgamestudios.com", {255, 255, 255, 255}); //TODO: (9) click to open the website/update
+
+	//debug
+	//
+}
+
+MainMenu::~MainMenu() {
+	TTF_CloseFont(font);
+}
+
+//-------------------------
+//Frame loop
+//-------------------------
+
+void MainMenu::FrameStart() {
+	//
+}
+
+void MainMenu::Update() {
+	//
+}
+
+void MainMenu::FrameEnd() {
+	//
+}
+
+void MainMenu::RenderFrame(SDL_Renderer* renderer) {
+	startButton.DrawTo(renderer);
+	optionsButton.DrawTo(renderer);
+	quitButton.DrawTo(renderer);
+
+	int h = -1;
+	SDL_RenderGetLogicalSize(GetRenderer(), nullptr, &h);
+
+	textBox.DrawTo(renderer, 50, h-50, -12);
+}
+
+//-------------------------
+//Event handlers
+//-------------------------
+
+void MainMenu::MouseMotion(SDL_MouseMotionEvent const& event) {
+	startButton.MouseMotion(event);
+	optionsButton.MouseMotion(event);
+	quitButton.MouseMotion(event);
+}
+
+void MainMenu::MouseButtonDown(SDL_MouseButtonEvent const& event) {
+	startButton.MouseButtonDown(event);
+	optionsButton.MouseButtonDown(event);
+	quitButton.MouseButtonDown(event);
+}
+
+void MainMenu::MouseButtonUp(SDL_MouseButtonEvent const& event) {
+	//TODO: (2) Buttons should only register as "selected" when the left button is used
+	if (startButton.MouseButtonUp(event) == Button::State::RELEASED) {
+		SetSceneSignal(SceneSignal::LOBBYMENU);
+	}
+	if (optionsButton.MouseButtonUp(event) == Button::State::RELEASED) {
+		SetSceneSignal(SceneSignal::OPTIONSMENU);
+	}
+	if (quitButton.MouseButtonUp(event) == Button::State::RELEASED) {
+		QuitEvent();
+	}
+}
+
+void MainMenu::MouseWheel(SDL_MouseWheelEvent const& event) {
+	//
+}
+
+void MainMenu::KeyDown(SDL_KeyboardEvent const& event) {
+	//
+}
+
+void MainMenu::KeyUp(SDL_KeyboardEvent const& event) {
+	switch(event.keysym.sym) {
+		case SDLK_ESCAPE:
+			QuitEvent();
+		break;
+	}
+}

client/scenes/main_menu.hpp

@@ -0,0 +1,60 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "base_scene.hpp"
+#include "button.hpp"
+#include "image.hpp"
+#include "text_box.hpp"
+
+#include "SDL2/SDL_ttf.h"
+
+class MainMenu : public BaseScene {
+public:
+	//Public access members
+	MainMenu();
+	~MainMenu();
+
+	void RenderFrame(SDL_Renderer* renderer) override;
+
+protected:
+	//frame phases
+	void FrameStart() override;
+	void Update() override;
+	void FrameEnd() override;
+
+	//input events
+	void MouseMotion(SDL_MouseMotionEvent const& event) override;
+	void MouseButtonDown(SDL_MouseButtonEvent const& event) override;
+	void MouseButtonUp(SDL_MouseButtonEvent const& event) override;
+	void MouseWheel(SDL_MouseWheelEvent const& event) override;
+	void KeyDown(SDL_KeyboardEvent const& event) override;
+	void KeyUp(SDL_KeyboardEvent const& event) override;
+
+	//members
+	Image buttonImage;
+	TTF_Font* font = nullptr;
+	Button startButton;
+	Button optionsButton;
+	Button quitButton;
+	TextBox textBox;
+};

client/scenes/makefile

@@ -0,0 +1,32 @@
+#config
+INCLUDES+=. .. ../client_utilities ../entities ../../common/gameplay ../../common/graphics ../../common/map ../../common/network ../../common/network/packet_types ../../common/ui ../../common/utilities
+LIBS+=
+CXXFLAGS+=-std=c++11 $(addprefix -I,$(INCLUDES))
+
+#source
+CXXSRC=$(wildcard *.cpp)
+
+#objects
+OBJDIR=obj
+OBJ+=$(addprefix $(OBJDIR)/,$(CXXSRC:.cpp=.o))
+
+#output
+OUTDIR=..
+OUT=$(addprefix $(OUTDIR)/,client.a)
+
+#targets
+all: $(OBJ) $(OUT)
+	ar -crs $(OUT) $(OBJ)
+
+$(OBJ): | $(OBJDIR)
+
+$(OUT): | $(OUTDIR)
+
+$(OBJDIR):
+	mkdir $(OBJDIR)
+
+$(OUTDIR):
+	mkdir $(OUTDIR)
+
+$(OBJDIR)/%.o: %.cpp
+	$(CXX) $(CXXFLAGS) -c -o $@ $<

client/scenes/options_menu.cpp

@@ -0,0 +1,116 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "options_menu.hpp"
+
+#include "config_utility.hpp"
+
+#include <sstream>
+#include <stdexcept>
+
+//-------------------------
+//Public access members
+//-------------------------
+
+OptionsMenu::OptionsMenu() {
+	ConfigUtility& config = ConfigUtility::GetSingleton();
+
+	//setup the utility objects
+	buttonImage.Load(GetRenderer(), config["dir.interface"] + "button_blue.png");
+	font = TTF_OpenFont(config["client.font"].c_str(), 12);
+
+	//check that the font loaded
+	if (!font) {
+		std::ostringstream msg;
+		msg << "Failed to load a font file; " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+
+	//setup the button
+	backButton.SetBackgroundTexture(GetRenderer(), buttonImage.GetTexture());
+	backButton.SetText(GetRenderer(), font, "Back", COLOR_WHITE);
+
+	//set the button positions
+	backButton.SetX(50);
+	backButton.SetY(50);
+
+	//text line
+	textLine.SetText(GetRenderer(), font, "This code is fucking hard to refactor.", {255, 255, 255, 255});
+}
+
+OptionsMenu::~OptionsMenu() {
+	TTF_CloseFont(font);
+}
+
+//-------------------------
+//Frame loop
+//-------------------------
+
+void OptionsMenu::FrameStart() {
+	//
+}
+
+void OptionsMenu::Update() {
+	//
+}
+
+void OptionsMenu::FrameEnd() {
+	//
+}
+
+void OptionsMenu::RenderFrame(SDL_Renderer* renderer) {
+	backButton.DrawTo(renderer);
+	textLine.DrawTo(renderer, 50, 30);
+}
+
+//-------------------------
+//Event handlers
+//-------------------------
+
+void OptionsMenu::MouseMotion(SDL_MouseMotionEvent const& event) {
+	backButton.MouseMotion(event);
+}
+
+void OptionsMenu::MouseButtonDown(SDL_MouseButtonEvent const& event) {
+	backButton.MouseButtonDown(event);
+}
+
+void OptionsMenu::MouseButtonUp(SDL_MouseButtonEvent const& event) {
+	if (backButton.MouseButtonUp(event) == Button::State::RELEASED) {
+		SetSceneSignal(SceneSignal::MAINMENU);
+	}
+}
+
+void OptionsMenu::MouseWheel(SDL_MouseWheelEvent const& event) {
+	//
+}
+
+void OptionsMenu::KeyDown(SDL_KeyboardEvent const& event) {
+	switch(event.keysym.sym) {
+		case SDLK_ESCAPE:
+			SetSceneSignal(SceneSignal::MAINMENU);
+		break;
+	}
+}
+
+void OptionsMenu::KeyUp(SDL_KeyboardEvent const& event) {
+	//
+}

client/scenes/options_menu.hpp

@@ -0,0 +1,58 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "button.hpp"
+#include "image.hpp"
+#include "text_line.hpp"
+
+#include "base_scene.hpp"
+
+//NOTE: The options screen needs to be USED
+class OptionsMenu : public BaseScene {
+public:
+	//Public access members
+	OptionsMenu();
+	~OptionsMenu();
+
+	void RenderFrame(SDL_Renderer* renderer) override;
+
+private:
+	//frame phases
+	void FrameStart() override;
+	void Update() override;
+	void FrameEnd() override;
+
+	//input events
+	void MouseMotion(SDL_MouseMotionEvent const& event) override;
+	void MouseButtonDown(SDL_MouseButtonEvent const& event) override;
+	void MouseButtonUp(SDL_MouseButtonEvent const& event) override;
+	void MouseWheel(SDL_MouseWheelEvent const& event) override;
+	void KeyDown(SDL_KeyboardEvent const& event) override;
+	void KeyUp(SDL_KeyboardEvent const& event) override;
+
+	//members
+	Image buttonImage;
+	TTF_Font* font = nullptr;
+	Button backButton;
+	TextLine textLine;
+};

client/scenes/splash_screen.cpp

@@ -0,0 +1,61 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "splash_screen.hpp"
+
+#include "config_utility.hpp"
+
+//-------------------------
+//Public access members
+//-------------------------
+
+SplashScreen::SplashScreen(SDL_Window* w) {
+	//fit the screen to the logo
+	//NOTE: not using this window trick
+	window = w;
+	SDL_GetWindowSize(window, &windowWidth, &windowHeight);
+
+	logo.Load(GetRenderer(), ConfigUtility::GetSingleton()["dir.logos"] + "krstudios.png");
+
+	startTick = std::chrono::steady_clock::now();
+}
+
+SplashScreen::~SplashScreen() {
+	//
+}
+
+//-------------------------
+//Frame loop
+//-------------------------
+
+void SplashScreen::FrameStart() {
+	//TODO: (0) config flag to change the delay
+	if (std::chrono::steady_clock::now() - startTick > std::chrono::duration<int>(3)) {
+		SetSceneSignal(SceneSignal::MAINMENU);
+	}
+}
+
+void SplashScreen::RenderFrame(SDL_Renderer* renderer) {
+	//TODO: version information
+	int w = 0, h = 0;
+	SDL_RenderGetLogicalSize(renderer, &w, &h);
+	logo.DrawTo(renderer, (w - logo.GetClipW()) / 2, (h - logo.GetClipH()) / 2);
+}

client/scenes/splash_screen.hpp

@@ -0,0 +1,48 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "base_scene.hpp"
+#include "image.hpp"
+
+#include <chrono>
+
+class SplashScreen : public BaseScene {
+public:
+	//Public access members
+	SplashScreen(SDL_Window*);
+	~SplashScreen();
+
+	void RenderFrame(SDL_Renderer* renderer) override;
+
+private:
+	//Frame loop
+	void FrameStart() override;
+
+	//members
+	std::chrono::steady_clock::time_point startTick;
+	Image logo;
+
+	//screws with the window
+	SDL_Window* window = nullptr;
+	int windowWidth, windowHeight;
+};

client/scenes/world.cpp

@@ -0,0 +1,925 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "world.hpp"
+
+#include "channels.hpp"
+#include "ip_operators.hpp"
+#include "fatal_error.hpp"
+
+#include <algorithm>
+#include <chrono>
+#include <cmath>
+#include <cstring>
+#include <iostream>
+#include <sstream>
+#include <stdexcept>
+
+//-------------------------
+//static functions
+//-------------------------
+
+//TODO: (3) proper checksum
+static int regionChecksum(Region* const region) {
+	int sum = 0;
+	for(int i = 0; i < REGION_WIDTH; i++) {
+		for (int j = 0; j < REGION_HEIGHT; j++) {
+			for (int k = 0; k < REGION_DEPTH; k++) {
+				sum |= region->GetTile(i, j, k);
+			}
+		}
+	}
+	return sum;
+}
+
+//-------------------------
+//Public access members
+//-------------------------
+
+World::World(int* const argClientIndex,	int* const argAccountIndex):
+	clientIndex(*argClientIndex),
+	accountIndex(*argAccountIndex)
+{
+	//setup the utility objects
+	buttonImage.Load(GetRenderer(), config["dir.interface"] + "button_blue.png");
+	font = TTF_OpenFont(config["client.font"].c_str(), 12);
+
+	//check that the font loaded
+	if (!font) {
+		std::ostringstream msg;
+		msg << "Failed to load a font file; " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+
+	//setup the buttons
+	disconnectButton.SetBackgroundTexture(GetRenderer(), buttonImage.GetTexture());
+	disconnectButton.SetText(GetRenderer(), font, "Disconnect", COLOR_WHITE);
+	shutdownButton.SetBackgroundTexture(GetRenderer(), buttonImage.GetTexture());
+	shutdownButton.SetText(GetRenderer(), font, "Shutdown", COLOR_WHITE);
+
+	//set the button positions
+	disconnectButton.SetX(50);
+	disconnectButton.SetY(50);
+	shutdownButton.SetX(50);
+	shutdownButton.SetY(70);
+
+	//load the tilesheet
+	//TODO: (2) Tile size and tile sheet should be loaded elsewhere
+	tileSheet.Load(GetRenderer(), config["dir.tilesets"] + "overworld.png", 32, 32);
+
+	//Send the character data
+	CharacterPacket newPacket;
+	newPacket.type = SerialPacketType::CHARACTER_LOAD;
+	strncpy(newPacket.handle, config["client.handle"].c_str(), PACKET_STRING_SIZE);
+	strncpy(newPacket.avatar, config["client.avatar"].c_str(), PACKET_STRING_SIZE);
+	newPacket.accountIndex = accountIndex;
+	network.SendTo(Channels::SERVER, &newPacket);
+
+	//set the camera's values
+	SDL_RenderGetLogicalSize(GetRenderer(), &camera.width, &camera.height);
+
+	//debug
+	//
+}
+
+World::~World() {
+	//unload the local data
+	TTF_CloseFont(font);
+	characterMap.clear();
+	creatureMap.clear();
+}
+
+//-------------------------
+//Frame loop
+//-------------------------
+
+void World::FrameStart() {
+	//
+}
+
+void World::Update() {
+	//create and zero the buffer
+	SerialPacket* packetBuffer = reinterpret_cast<SerialPacket*>(new char[MAX_PACKET_SIZE]);
+	memset(packetBuffer, 0, MAX_PACKET_SIZE);
+
+	try {
+		//suck in and process all waiting packets
+		while(network.Receive(packetBuffer)) {
+			HandlePacket(packetBuffer);
+		}
+	}
+	catch(fatal_error& e) {
+		throw(e);
+	}
+	catch(std::exception& e) {
+		std::cerr << "HandlePacket Error: " << e.what() << std::endl;
+	}
+
+	//free the buffer
+	delete reinterpret_cast<char*>(packetBuffer);
+
+	//heartbeat system
+	CheckHeartBeat();
+
+	//update all entities
+	for (auto& it : characterMap) {
+		it.second.Update();
+	}
+	for (auto& it : creatureMap) {
+		it.second.Update();
+	}
+
+	try {
+		//update the map
+		UpdateMap();
+	}
+	catch(fatal_error& e) {
+		throw(e);
+	}
+	catch(std::exception& e) {
+		std::cerr << "UpdateMap Error: " << e.what() << std::endl;
+	}
+
+	//skip the rest without a local character
+	if (!localCharacter) {
+		return;
+	}
+
+	//get the collidable boxes
+	std::list<BoundingBox> boxList = GenerateCollisionGrid(localCharacter, tileSheet.GetTileW(), tileSheet.GetTileH());
+
+	//process the collisions
+	//BUG: Collisions not working
+	if (localCharacter->ProcessCollisionGrid(boxList)) {
+		localCharacter->CorrectSprite();
+		SendLocalCharacterMovement();
+	}
+
+	//update the camera
+	camera.x = localCharacter->GetOrigin().x - camera.marginX;
+	camera.y = localCharacter->GetOrigin().y - camera.marginY;
+}
+
+void World::FrameEnd() {
+	//
+}
+
+void World::RenderFrame(SDL_Renderer* renderer) {
+	//draw the map
+	for (std::list<Region>::iterator it = regionPager.GetContainer()->begin(); it != regionPager.GetContainer()->end(); it++) {
+		tileSheet.DrawRegionTo(renderer, &(*it), camera.x, camera.y);
+
+		//debugging
+//		std::ostringstream msg;
+//		msg << it->GetX() << ", " << it->GetY();
+//		font.DrawStringTo(msg.str(), screen, it->GetX() * tileSheet.GetImage()->GetClipW() - camera.x, it->GetY() * tileSheet.GetImage()->GetClipH() - camera.y);
+	}
+
+	//draw the entities
+	for (auto& it : characterMap) {
+		//BUG: #29 Characters (and other entities) are drawn out of order
+		it.second.DrawTo(renderer, camera.x, camera.y);
+	}
+	for (auto& it : creatureMap) {
+		it.second.DrawTo(renderer, camera.x, camera.y);
+	}
+
+	//draw UI
+	disconnectButton.DrawTo(renderer);
+	shutdownButton.DrawTo(renderer);
+
+	//FPS
+	fpsTextLine.DrawTo(renderer, 0, 0);
+	int fpsRet = fps.Calculate();
+	if (fpsRet != -1) {
+		std::ostringstream msg;
+		msg << "FPS: " << fpsRet;
+		fpsTextLine.SetText(renderer, font, msg.str(), {255, 255, 255, 255});
+	}
+}
+
+//-------------------------
+//Event handlers
+//-------------------------
+
+void World::QuitEvent() {
+	//two-step logout
+	SendDisconnectRequest();
+	SetSceneSignal(SceneSignal::QUIT);
+}
+
+void World::MouseMotion(SDL_MouseMotionEvent const& event) {
+	disconnectButton.MouseMotion(event);
+	shutdownButton.MouseMotion(event);
+}
+
+void World::MouseButtonDown(SDL_MouseButtonEvent const& event) {
+	disconnectButton.MouseButtonDown(event);
+	shutdownButton.MouseButtonDown(event);
+}
+
+void World::MouseButtonUp(SDL_MouseButtonEvent const& event) {
+	if (disconnectButton.MouseButtonUp(event) == Button::State::RELEASED) {
+		SendLogoutRequest();
+	}
+	if (shutdownButton.MouseButtonUp(event) == Button::State::RELEASED) {
+		SendAdminShutdownRequest();
+	}
+}
+
+void World::MouseWheel(SDL_MouseWheelEvent const& event) {
+	//
+}
+
+void World::KeyDown(SDL_KeyboardEvent const& event) {
+	//BUGFIX: SDL2 introduced key repeats, so I need to ignore it
+	if (event.repeat) {
+		return;
+	}
+
+	//hotkeys
+	switch(event.keysym.sym) {
+		case SDLK_ESCAPE:
+			//TODO: (3) the escape key should actually control menus and stuff
+			SendLogoutRequest();
+		return;
+	}
+
+	//character movement
+	if (!localCharacter) {
+		return;
+	}
+	Vector2 motion = localCharacter->GetMotion();
+	switch(event.keysym.sym) {
+		case SDLK_w:
+			motion.y -= CHARACTER_WALKING_SPEED;
+		break;
+		case SDLK_a:
+			motion.x -= CHARACTER_WALKING_SPEED;
+		break;
+		case SDLK_s:
+			motion.y += CHARACTER_WALKING_SPEED;
+		break;
+		case SDLK_d:
+			motion.x += CHARACTER_WALKING_SPEED;
+		break;
+		default:
+			//DOCS: prevents wrong keys screwing with character movement
+			return;
+	}
+	//handle diagonals
+	if (motion.x != 0 && motion.y != 0) {
+		motion *= CHARACTER_WALKING_MOD;
+	}
+	//set the info
+	localCharacter->SetMotion(motion);
+	localCharacter->CorrectSprite();
+	SendLocalCharacterMovement();
+}
+
+void World::KeyUp(SDL_KeyboardEvent const& event) {
+	//BUGFIX: SDL2 introduced key repeats, so I need to ignore it
+	if (event.repeat) {
+		return;
+	}
+
+	//character movement
+	if (!localCharacter) {
+		return;
+	}
+	Vector2 motion = localCharacter->GetMotion();
+	switch(event.keysym.sym) {
+		case SDLK_w:
+			motion.y = std::min(0.0, motion.y += CHARACTER_WALKING_SPEED);
+		break;
+		case SDLK_a:
+			motion.x = std::min(0.0, motion.x += CHARACTER_WALKING_SPEED);
+		break;
+		case SDLK_s:
+			motion.y = std::max(0.0, motion.y -= CHARACTER_WALKING_SPEED);
+		break;
+		case SDLK_d:
+			motion.x = std::max(0.0, motion.x -= CHARACTER_WALKING_SPEED);
+		break;
+		default:
+			//DOCS: prevents wrong keys screwing with character movement
+			return;
+	}
+	//BUGFIX: reset cardinal direction speed on key release
+	if (motion.x > 0) {
+		motion.x = CHARACTER_WALKING_SPEED;
+	}
+	else if (motion.x < 0) {
+		motion.x = -CHARACTER_WALKING_SPEED;
+	}
+	if (motion.y > 0) {
+		motion.y = CHARACTER_WALKING_SPEED;
+	}
+	else if (motion.y < 0) {
+		motion.y = -CHARACTER_WALKING_SPEED;
+	}
+	//handle diagonals
+	if (motion.x != 0 && motion.y != 0) {
+		motion *= CHARACTER_WALKING_MOD;
+	}
+	//set the info
+	localCharacter->SetMotion(motion);
+	localCharacter->CorrectSprite();
+	SendLocalCharacterMovement();
+}
+
+//-------------------------
+//Direct incoming traffic
+//-------------------------
+
+void World::HandlePacket(SerialPacket* const argPacket) {
+	switch(argPacket->type) {
+		//heartbeat system
+		case SerialPacketType::PING:
+			hPing(static_cast<ServerPacket*>(argPacket));
+		break;
+		case SerialPacketType::PONG:
+			hPong(static_cast<ServerPacket*>(argPacket));
+		break;
+
+		//game server connections
+		case SerialPacketType::LOGOUT_RESPONSE:
+			hLogoutResponse(static_cast<ClientPacket*>(argPacket));
+		break;
+		case SerialPacketType::DISCONNECT_RESPONSE:
+			hDisconnectResponse(static_cast<ClientPacket*>(argPacket));
+		break;
+		case SerialPacketType::ADMIN_DISCONNECT_FORCED:
+			hAdminDisconnectForced(static_cast<ClientPacket*>(argPacket));
+		break;
+
+		//map management
+		case SerialPacketType::REGION_CONTENT:
+			hRegionContent(static_cast<RegionPacket*>(argPacket));
+		break;
+
+		//character management
+		case SerialPacketType::CHARACTER_UPDATE:
+			hCharacterUpdate(static_cast<CharacterPacket*>(argPacket));
+		break;
+
+		case SerialPacketType::CHARACTER_CREATE:
+			hCharacterCreate(static_cast<CharacterPacket*>(argPacket));
+		break;
+		case SerialPacketType::CHARACTER_UNLOAD:
+			hCharacterUnload(static_cast<CharacterPacket*>(argPacket));
+		break;
+
+		case SerialPacketType::QUERY_CHARACTER_EXISTS:
+			hQueryCharacterExists(static_cast<CharacterPacket*>(argPacket));
+		break;
+
+		case SerialPacketType::CHARACTER_MOVEMENT:
+			hCharacterMovement(static_cast<CharacterPacket*>(argPacket));
+		break;
+
+		//creature management
+		case SerialPacketType::CREATURE_CREATE:
+			hCreatureCreate(static_cast<CreaturePacket*>(argPacket));
+		break;
+		case SerialPacketType::CREATURE_UNLOAD:
+			hCreatureUnload(static_cast<CreaturePacket*>(argPacket));
+		break;
+
+		case SerialPacketType::QUERY_CREATURE_EXISTS:
+			hQueryCreatureExists(static_cast<CreaturePacket*>(argPacket));
+		break;
+
+		case SerialPacketType::CREATURE_MOVEMENT:
+			hCreatureMovement(static_cast<CreaturePacket*>(argPacket));
+		break;
+
+		//chat
+		case SerialPacketType::TEXT_BROADCAST:
+			hTextBroadcast(static_cast<TextPacket*>(argPacket));
+		break;
+		case SerialPacketType::TEXT_SPEECH:
+			hTextSpeech(static_cast<TextPacket*>(argPacket));
+		break;
+		case SerialPacketType::TEXT_WHISPER:
+			hTextWhisper(static_cast<TextPacket*>(argPacket));
+		break;
+
+		//general rejection messages
+		case SerialPacketType::REGION_REJECTION:
+		case SerialPacketType::CHARACTER_REJECTION:
+		case SerialPacketType::QUERY_REJECTION:
+			throw(fatal_error(static_cast<TextPacket*>(argPacket)->text));
+		break;
+		case SerialPacketType::SHUTDOWN_REJECTION:
+			throw(std::runtime_error(static_cast<TextPacket*>(argPacket)->text));
+		break;
+
+		//errors
+		default: {
+			std::ostringstream msg;
+			msg << "Unknown SerialPacketType encountered in World: " << static_cast<int>(argPacket->type);
+			throw(std::runtime_error(msg.str()));
+		}
+		break;
+	}
+}
+
+//-------------------------
+//heartbeat system
+//-------------------------
+
+void World::hPing(ServerPacket* const argPacket) {
+	ServerPacket newPacket;
+	newPacket.type = SerialPacketType::PONG;
+	network.SendTo(argPacket->srcAddress, &newPacket);
+}
+
+void World::hPong(ServerPacket* const argPacket) {
+	if (*network.GetIPAddress(Channels::SERVER) != argPacket->srcAddress) {
+		throw(std::runtime_error("Heartbeat message received from an unknown source"));
+	}
+	attemptedBeats = 0;
+	lastBeat = Clock::now();
+}
+
+void World::CheckHeartBeat() {
+	//check the connection (heartbeat)
+	if (Clock::now() - lastBeat > std::chrono::seconds(3)) {
+		if (attemptedBeats > 2) {
+			//escape to the disconnect screen
+			SendDisconnectRequest();
+			SetSceneSignal(SceneSignal::DISCONNECTEDSCREEN);
+			ConfigUtility::GetSingleton()["client.disconnectMessage"] = "Error: Lost connection to the server";
+		}
+		else {
+			ServerPacket newPacket;
+			newPacket.type = SerialPacketType::PING;
+			network.SendTo(Channels::SERVER, &newPacket);
+
+			attemptedBeats++;
+			lastBeat = Clock::now();
+		}
+	}
+}
+
+//-------------------------
+//Connection control
+//-------------------------
+
+void World::SendLogoutRequest() {
+	ClientPacket newPacket;
+
+	//send a logout request
+	newPacket.type = SerialPacketType::LOGOUT_REQUEST;
+	newPacket.accountIndex = accountIndex;
+
+	network.SendTo(Channels::SERVER, &newPacket);
+}
+
+void World::SendDisconnectRequest() {
+	ClientPacket newPacket;
+
+	//send a disconnect request
+	newPacket.type = SerialPacketType::DISCONNECT_REQUEST;
+	newPacket.clientIndex = clientIndex;
+
+	network.SendTo(Channels::SERVER, &newPacket);
+}
+
+void World::SendAdminDisconnectForced() {
+	//TODO: (9) World::SendAdminDisconnectForced()
+}
+
+void World::SendAdminShutdownRequest() {
+	ClientPacket newPacket;
+
+	//send a shutdown request
+	newPacket.type = SerialPacketType::ADMIN_SHUTDOWN_REQUEST;
+	newPacket.accountIndex = accountIndex;
+
+	network.SendTo(Channels::SERVER, &newPacket);
+}
+
+void World::hLogoutResponse(ClientPacket* const argPacket) {
+	if (localCharacter) {
+		characterMap.erase(characterIndex);
+		localCharacter = nullptr;
+	}
+
+	accountIndex = -1;
+	characterIndex = -1;
+
+	//reset the camera
+	camera.marginX = camera.marginY = 0;
+
+	//because, why not? I guess...
+	SendDisconnectRequest();
+}
+
+void World::hDisconnectResponse(ClientPacket* const argPacket) {
+	hLogoutResponse(argPacket);//shortcut
+	SetSceneSignal(SceneSignal::DISCONNECTEDSCREEN);
+	ConfigUtility::GetSingleton()["client.disconnectMessage"] = "You have successfully logged out";
+}
+
+void World::hAdminDisconnectForced(ClientPacket* const argPacket) {
+	hDisconnectResponse(argPacket);//shortcut
+	SetSceneSignal(SceneSignal::DISCONNECTEDSCREEN);
+	ConfigUtility::GetSingleton()["client.disconnectMessage"] = "You have been forcibly disconnected by the server";
+}
+
+//-------------------------
+//map management
+//-------------------------
+
+void World::SendRegionRequest(int roomIndex, int x, int y) {
+	RegionPacket packet;
+
+	//pack the region's data
+	packet.type = SerialPacketType::REGION_REQUEST;
+	packet.roomIndex = roomIndex;
+	packet.x = x;
+	packet.y = y;
+
+	network.SendTo(Channels::SERVER, &packet);
+}
+
+void World::hRegionContent(RegionPacket* const argPacket) {
+	//checksum
+	if (regionChecksum(argPacket->region) == 0) {
+		std::ostringstream msg;
+		msg << "Received region checksum failed: " << argPacket->x << ", " << argPacket->y;
+		throw(std::runtime_error(msg.str()));
+	}
+
+	//replace existing regions
+	regionPager.UnloadIf([&](Region const& region) -> bool {
+		if (region.GetX() == argPacket->x && region.GetY() == argPacket->y) {
+			std::cout << "Region Overwrite: " << region.GetX() << ", " << region.GetY();
+			std::cout << "\t" << region.GetSolid(1,1) << "\t" << argPacket->region->GetSolid(1,1) << std::endl;
+			return true;
+		}
+		else {
+			return false;
+		}
+	});
+	regionPager.PushRegion(argPacket->region);
+
+	//clean up after the serial code
+	delete argPacket->region;
+	argPacket->region = nullptr;
+}
+
+void World::UpdateMap() {
+	if (roomIndex == -1) {
+		return;
+	}
+
+	//these represent the zone of regions that the client needs loaded, including the mandatory buffers (+1/-1)
+	int xStart = snapToBase(REGION_WIDTH, camera.x/tileSheet.GetTileW()) - REGION_WIDTH;
+	int xEnd = snapToBase(REGION_WIDTH, (camera.x+camera.width)/tileSheet.GetTileW()) + REGION_WIDTH;
+
+	int yStart = snapToBase(REGION_HEIGHT, camera.y/tileSheet.GetTileH()) - REGION_HEIGHT;
+	int yEnd = snapToBase(REGION_HEIGHT, (camera.y+camera.height)/tileSheet.GetTileH()) + REGION_HEIGHT;
+
+	//prune distant regions
+	regionPager.GetContainer()->remove_if([&](Region const& region) -> bool {
+		return region.GetX() < xStart || region.GetX() > xEnd || region.GetY() < yStart || region.GetY() > yEnd;
+	});
+
+	//request empty regions within this zone
+	for (int i = xStart; i <= xEnd; i += REGION_WIDTH) {
+		for (int j = yStart; j <= yEnd; j += REGION_HEIGHT) {
+			Region* region = regionPager.FindRegion(i, j);
+			if (!region) {
+				//request absent region
+				SendRegionRequest(roomIndex, i, j);
+			}
+			else if (regionChecksum(region) == 0) {
+				//checksum failed
+				regionPager.UnloadIf([region](Region const& ref) -> bool {
+					//remove the erroneous region
+					return region == &ref;
+				});
+				SendRegionRequest(roomIndex, i, j);
+				std::ostringstream msg;
+				msg << "Existing region checksum failed: " << roomIndex << ", " << i << ", " << j;
+				throw(std::runtime_error(msg.str()));
+			}
+		}
+	}
+}
+
+//-------------------------
+//character management
+//-------------------------
+
+//DOCS: preexisting characters will result in query responses
+//DOCS: new characters will result in create messages
+//DOCS: this client's character will exist in both (skipped)
+
+void World::hCharacterUpdate(CharacterPacket* const argPacket) {
+	//TODO: (1) Authentication
+	//NOTE: applies to the local character too
+
+	//check that this character exists
+	std::map<int, BaseCharacter>::iterator characterIt = characterMap.find(argPacket->characterIndex);
+	if (characterIt != characterMap.end()) {
+		//update the origin and motion, if there's a difference
+		if (characterIt->second.GetOrigin() != argPacket->origin) {
+			characterIt->second.SetOrigin(argPacket->origin);
+		}
+		if (characterIt->second.GetMotion() != argPacket->motion) {
+			characterIt->second.SetMotion(argPacket->motion);
+			characterIt->second.CorrectSprite(); //only correct the sprite if the motion changes
+		}
+	}
+}
+
+void World::hCharacterCreate(CharacterPacket* const argPacket) {
+	//prevent double message
+	if (characterMap.find(argPacket->characterIndex) != characterMap.end()) {
+		std::ostringstream msg;
+		msg << "Double character creation event; ";
+		msg << "Index: " << argPacket->characterIndex << "; ";
+		msg << "Handle: " << argPacket->handle;
+		throw(std::runtime_error(msg.str()));
+	}
+
+	//implicity create and retrieve the entity
+	BaseCharacter* character = &characterMap[argPacket->characterIndex];
+
+	//fill the character's info
+	character->SetHandle(argPacket->handle);
+	character->SetAvatar(GetRenderer(), argPacket->avatar);
+	character->SetOwner(argPacket->accountIndex);
+	character->SetOrigin(argPacket->origin);
+	character->SetMotion(argPacket->motion);
+	character->SetBounds(argPacket->bounds);
+
+	character->CorrectSprite();
+
+	//check for this player's character
+	if (character->GetOwner() == accountIndex) {
+		localCharacter = static_cast<LocalCharacter*>(character);
+
+		//focus the camera on this character's sprite
+		camera.marginX = (camera.width / 2 - localCharacter->GetSprite()->GetClipW() / 2);
+		camera.marginY = (camera.height/ 2 - localCharacter->GetSprite()->GetClipH() / 2);
+
+		//focus on this character's info
+		characterIndex = argPacket->characterIndex;
+		roomIndex = argPacket->roomIndex;
+
+		//query the world state (room)
+		CharacterPacket newPacket;
+		memset(&newPacket, 0, MAX_PACKET_SIZE);
+		newPacket.type = SerialPacketType::QUERY_CHARACTER_EXISTS;
+		newPacket.roomIndex = roomIndex;
+		network.SendTo(Channels::SERVER, &newPacket);
+		newPacket.type = SerialPacketType::QUERY_CREATURE_EXISTS;
+		network.SendTo(Channels::SERVER, &newPacket);
+	}
+
+	//debug
+	std::cout << "Character Create, total: " << characterMap.size() << std::endl;
+}
+
+void World::hCharacterUnload(CharacterPacket* const argPacket) {
+	//ignore if this character doesn't exist
+	std::map<int, BaseCharacter>::iterator characterIt = characterMap.find(argPacket->characterIndex);
+	if (characterIt == characterMap.end()) {
+		return;
+	}
+
+	//check for this player's character
+	if ((*characterIt).second.GetOwner() == accountIndex) {
+		localCharacter = nullptr;
+
+		//clear the camera
+		camera.marginX = 0;
+		camera.marginY = 0;
+
+		//clear the room
+		roomIndex = -1;
+		regionPager.UnloadAll();
+		characterMap.clear();
+		creatureMap.clear();
+	}
+	else {
+		//remove this character
+		characterMap.erase(characterIt);
+	}
+
+	//debug
+	std::cout << "Character Unload, total: " << characterMap.size() << std::endl;
+}
+
+void World::hQueryCharacterExists(CharacterPacket* const argPacket) {
+	//prevent a double message about this player's character
+	//TODO: why is this commented out?
+//	if (argPacket->accountIndex == accountIndex) {
+//		return;
+//	}
+
+	//ignore characters in a different room (sub-optimal)
+	if (argPacket->roomIndex != roomIndex) {
+		return;
+	}
+
+	//implicitly construct the character if it doesn't exist
+	BaseCharacter* character = &characterMap[argPacket->characterIndex];
+
+	//set/update the character's info
+	character->SetOrigin(argPacket->origin);
+	character->SetMotion(argPacket->motion);
+	character->SetBounds({CHARACTER_BOUNDS_X, CHARACTER_BOUNDS_Y, CHARACTER_BOUNDS_WIDTH, CHARACTER_BOUNDS_HEIGHT});
+	character->SetHandle(argPacket->handle);
+	character->SetAvatar(GetRenderer(), argPacket->avatar);
+	character->SetOwner(argPacket->accountIndex);
+	character->CorrectSprite();
+
+	//debug
+	std::cout << "Character Query, total: " << characterMap.size() << std::endl;
+}
+
+void World::hCharacterMovement(CharacterPacket* const argPacket) {
+	//TODO: (1) Authentication
+	if (argPacket->characterIndex == characterIndex) {
+		return;
+	}
+
+	//check that this character exists
+	std::map<int, BaseCharacter>::iterator characterIt = characterMap.find(argPacket->characterIndex);
+	if (characterIt != characterMap.end()) {
+		//set the origin and motion
+		characterIt->second.SetOrigin(argPacket->origin);
+		characterIt->second.SetMotion(argPacket->motion);
+		characterIt->second.CorrectSprite();
+	}
+}
+
+//-------------------------
+//creature management
+//-------------------------
+
+void World::hCreatureCreate(CreaturePacket* const argPacket) {
+	//check for logic errors
+	if (creatureMap.find(argPacket->creatureIndex) != creatureMap.end()) {
+		std::ostringstream msg;
+		msg << "Double creature creation event; ";
+		msg << "Index: " << argPacket->creatureIndex << "; ";
+		msg << "Handle: " << argPacket->handle;
+		throw(std::runtime_error(msg.str()));
+	}
+
+	//ignore creatures from other rooms
+	if (roomIndex != argPacket->roomIndex) {
+		//temporary error checking
+		std::ostringstream msg;
+		msg << "Creature from the wrong room received: ";
+		msg << "creatureIndex: " << argPacket->creatureIndex << ", roomIndex: " << argPacket->roomIndex;
+		throw(std::runtime_error(msg.str()));
+	}
+
+	//implicitly create the element
+	BaseCreature* creature = &creatureMap[argPacket->creatureIndex];
+
+	//fill the creature's info
+	creature->SetHandle(argPacket->handle);
+	creature->SetAvatar(GetRenderer(), argPacket->avatar);
+	creature->SetBounds(argPacket->bounds);
+	creature->SetOrigin(argPacket->origin);
+	creature->SetMotion(argPacket->motion);
+
+	//debug
+	std::cout << "Creature Create, total: " << creatureMap.size() << std::endl;
+}
+
+void World::hCreatureUnload(CreaturePacket* const argPacket) {
+	//ignore if this creature doesn't exist
+	std::map<int, BaseCreature>::iterator creatureIt = creatureMap.find(argPacket->creatureIndex);
+	if (creatureIt == creatureMap.end()) {
+		return;
+	}
+
+	//remove this creature
+	creatureMap.erase(creatureIt);
+
+	//debug
+	std::cout << "Creature Unload, total: " << creatureMap.size() << std::endl;
+}
+
+void World::hQueryCreatureExists(CreaturePacket* const argPacket) {
+	//ignore creatures in a different room (sub-optimal)
+	if (argPacket->roomIndex != roomIndex) {
+		return;
+	}
+
+	//implicitly create the element
+	BaseCreature* creature = &creatureMap[argPacket->creatureIndex];
+
+	//fill the creature's info
+	creature->SetHandle(argPacket->handle);
+	creature->SetAvatar(GetRenderer(), argPacket->avatar);
+	creature->SetBounds(argPacket->bounds);
+	creature->SetOrigin(argPacket->origin);
+	creature->SetMotion(argPacket->motion);
+
+	//debug
+	std::cout << "Creature Query, total: " << creatureMap.size() << std::endl;
+}
+
+void World::hCreatureMovement(CreaturePacket* const argPacket) {
+	//ignore if this creature doesn't exist
+	std::map<int, BaseCreature>::iterator creatureIt = creatureMap.find(argPacket->creatureIndex);
+	if (creatureIt == creatureMap.end()) {
+		return;
+	}
+
+	creatureIt->second.SetOrigin(argPacket->origin);
+	creatureIt->second.SetMotion(argPacket->motion);
+}
+
+//-------------------------
+//chat
+//-------------------------
+
+void World::hTextBroadcast(TextPacket* const argPacket) {
+	//TODO: (9) World::hTextBroadcast()
+}
+
+void World::hTextSpeech(TextPacket* const argPacket) {
+	//TODO: (9) World::hTextSpeech()
+}
+
+void World::hTextWhisper(TextPacket* const argPacket) {
+	//TODO: (9) World::hTextWhisper()
+}
+
+//-------------------------
+//player movement & collision
+//-------------------------
+
+void World::SendLocalCharacterMovement() {
+	CharacterPacket newPacket;
+	newPacket.type = SerialPacketType::CHARACTER_MOVEMENT;
+
+	newPacket.accountIndex = accountIndex;
+	newPacket.characterIndex = characterIndex;
+	newPacket.roomIndex = roomIndex;
+	newPacket.origin = localCharacter->GetOrigin();
+	newPacket.motion = localCharacter->GetMotion();
+
+	network.SendTo(Channels::SERVER, &newPacket);
+}
+
+std::list<BoundingBox> World::GenerateCollisionGrid(Entity* ptr, int tileWidth, int tileHeight) {
+	//prepare for collisions
+	BoundingBox wallBounds = {0, 0, tileWidth, tileHeight};
+	std::list<BoundingBox> boxList;
+
+	//NOTE: for loops were too dense to work with, so I've just used while loops
+
+	//outer loop
+	wallBounds.x = snapToBase((double)wallBounds.w, ptr->GetOrigin().x);
+	while(wallBounds.x < (ptr->GetOrigin() + ptr->GetBounds()).x + ptr->GetBounds().w) {
+		//inner loop
+		wallBounds.y = snapToBase((double)wallBounds.h, ptr->GetOrigin().y);
+		while(wallBounds.y < (ptr->GetOrigin() + ptr->GetBounds()).y + ptr->GetBounds().h) {
+			//check to see if this tile is solid (non-existant tiles are always false)
+
+			if (regionPager.GetSolid(wallBounds.x / wallBounds.w, wallBounds.y / wallBounds.h)) {
+				//push onto the box set
+				boxList.push_front(wallBounds);
+			}
+
+			//increment
+			wallBounds.y += wallBounds.h;
+		}
+
+		//increment
+		wallBounds.x += wallBounds.w;
+	}
+
+	return std::move(boxList);
+}

client/scenes/world.hpp

@@ -0,0 +1,166 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+//maps
+#include "region_pager_base.hpp"
+
+//utilities
+#include "udp_network_utility.hpp"
+#include "serial_packet.hpp"
+#include "config_utility.hpp"
+
+//graphics
+#include "image.hpp"
+#include "button.hpp"
+#include "tile_sheet.hpp"
+#include "text_line.hpp"
+
+//common
+#include "frame_rate.hpp"
+
+//client
+#include "base_scene.hpp"
+#include "base_creature.hpp"
+#include "local_character.hpp"
+
+#include "SDL2/SDL.h"
+#include "SDL2/SDL_net.h"
+#include "SDL2/SDL_ttf.h"
+
+//STL
+#include <map>
+
+#include <chrono>
+
+class World: public BaseScene {
+public:
+	//Public access members
+	World(int* const argClientIndex, int* const argAccountIndex);
+	~World();
+
+	void RenderFrame(SDL_Renderer* renderer) override;
+
+private:
+	//frame phases
+	void FrameStart() override;
+	void Update() override;
+	void FrameEnd() override;
+
+	//input events
+	void QuitEvent();
+	void MouseMotion(SDL_MouseMotionEvent const& event) override;
+	void MouseButtonDown(SDL_MouseButtonEvent const& event) override;
+	void MouseButtonUp(SDL_MouseButtonEvent const& event) override;
+	void MouseWheel(SDL_MouseWheelEvent const& event) override;
+	void KeyDown(SDL_KeyboardEvent const& event) override;
+	void KeyUp(SDL_KeyboardEvent const& event) override;
+
+	//handle incoming traffic
+	void HandlePacket(SerialPacket* const);
+
+	//heartbeat system
+	void hPing(ServerPacket* const);
+	void hPong(ServerPacket* const);
+
+	void CheckHeartBeat();
+
+	//basic connections
+	void SendLogoutRequest();
+	void SendDisconnectRequest();
+	void SendAdminDisconnectForced();
+	void SendAdminShutdownRequest();
+
+	void hLogoutResponse(ClientPacket* const);
+	void hDisconnectResponse(ClientPacket* const);
+	void hAdminDisconnectForced(ClientPacket* const);
+
+	//map management
+	void SendRegionRequest(int roomIndex, int x, int y);
+	void hRegionContent(RegionPacket* const);
+	void UpdateMap();
+
+	//character management
+	void hCharacterUpdate(CharacterPacket* const);
+	void hCharacterCreate(CharacterPacket* const);
+	void hCharacterUnload(CharacterPacket* const);
+	void hQueryCharacterExists(CharacterPacket* const);
+	void hCharacterMovement(CharacterPacket* const);
+
+	//creature management
+	void hCreatureCreate(CreaturePacket* const);
+	void hCreatureUnload(CreaturePacket* const);
+	void hQueryCreatureExists(CreaturePacket* const);
+	void hCreatureMovement(CreaturePacket* const);
+
+	//chat
+	//TODO: ui chat engine
+	void hTextBroadcast(TextPacket* const);
+	void hTextSpeech(TextPacket* const);
+	void hTextWhisper(TextPacket* const);
+
+	//general gameplay
+	void SendLocalCharacterMovement();
+	std::list<BoundingBox> GenerateCollisionGrid(Entity*, int tileWidth, int tileHeight);
+
+	//indexes
+	int& clientIndex;
+	int& accountIndex;
+	int characterIndex = -1;
+	int roomIndex = -1;
+
+	//graphics
+	TileSheet tileSheet;
+
+	//map
+	RegionPagerBase regionPager;
+
+	//UI
+	Image buttonImage;
+	TTF_Font* font = nullptr;
+	Button disconnectButton;
+	Button shutdownButton;
+	FrameRate fps;
+	TextLine fpsTextLine;
+
+	//the camera structure
+	struct {
+		int x = 0, y = 0;
+		int width = 0, height = 0;
+		int marginX = 0, marginY = 0;
+	} camera;
+
+	//entities
+	std::map<int, BaseCharacter> characterMap;
+	std::map<int, BaseCreature> creatureMap;
+	LocalCharacter* localCharacter = nullptr;
+
+	//heartbeat
+	//TODO: (2) Heartbeat needs it's own utility
+	typedef std::chrono::steady_clock Clock;
+	Clock::time_point lastBeat = Clock::now();
+	int attemptedBeats = 0;
+
+	//ugly references; I hate this
+	ConfigUtility& config = ConfigUtility::GetSingleton();
+	UDPNetworkUtility& network = UDPNetworkUtility::GetSingleton();
+};

common/debugging/makefile

@@ -0,0 +1,28 @@
+#config
+INCLUDES+=.
+LIBS+=
+CXXFLAGS+=-std=c++11 $(addprefix -I,$(INCLUDES))
+
+#source
+CXXSRC=$(wildcard *.cpp)
+
+#objects
+OBJDIR=obj
+OBJ+=$(addprefix $(OBJDIR)/,$(CXXSRC:.cpp=.o))
+
+#targets
+all: $(OBJ) $(OUT)
+	ar -crs $(OUT) $(OBJ)
+
+$(OBJ): | $(OBJDIR)
+
+$(OUT): | $(OUTDIR)
+
+$(OBJDIR):
+	mkdir $(OBJDIR)
+
+$(OUTDIR):
+	mkdir $(OUTDIR)
+
+$(OBJDIR)/%.o: %.cpp
+	$(CXX) $(CXXFLAGS) -c -o $@ $<

common/debugging/timer.cpp

@@ -0,0 +1,45 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "timer.hpp"
+
+Timer::Timer(): start(Timer::Clock::now()) {
+	//
+}
+
+Timer::Timer(std::string s): name(s), start(Timer::Clock::now()) {
+	//
+}
+
+void Timer::Start() {
+	start = Clock::now();
+}
+
+void Timer::Stop() {
+	timeSpan = Clock::now() - start;
+}
+
+std::ostream& operator<<(std::ostream& os, Timer& t) {
+	os << t.GetName() << ": ";
+	os << std::chrono::duration_cast<std::chrono::microseconds>(t.GetTime()).count();
+	os << "us";
+	return os;
+}

common/debugging/timer.hpp

@@ -0,0 +1,51 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include <chrono>
+#include <string>
+#include <ostream>
+
+class Timer {
+public:
+	typedef std::chrono::high_resolution_clock Clock;
+
+	Timer();
+	Timer(std::string s);
+	~Timer() = default;
+
+	void Start();
+	void Stop();
+
+	//accessors and mutators
+	Clock::duration GetTime() { return timeSpan; }
+
+	std::string SetName(std::string s) { return name = s; }
+	std::string GetName() { return name; }
+
+private:
+	std::string name;
+	Clock::time_point start;
+	Clock::duration timeSpan;
+};
+
+std::ostream& operator<<(std::ostream& os, Timer& t);

common/frameworks/network/makefile

@@ -0,0 +1,29 @@
+#config
+INCLUDES+=. packet_types ../gameplay ../map ../utilities
+LIBS+=
+CXXFLAGS+=-std=c++11 $(addprefix -I,$(INCLUDES))
+
+#source
+CXXSRC=$(wildcard *.cpp)
+
+#objects
+OBJDIR=obj
+OBJ+=$(addprefix $(OBJDIR)/,$(CXXSRC:.cpp=.o))
+
+#targets
+all: $(OBJ) $(OUT)
+	ar -crs $(OUT) $(OBJ)
+	$(MAKE) -C packet_types
+
+$(OBJ): | $(OBJDIR)
+
+$(OUT): | $(OUTDIR)
+
+$(OBJDIR):
+	mkdir $(OBJDIR)
+
+$(OUTDIR):
+	mkdir $(OUTDIR)
+
+$(OBJDIR)/%.o: %.cpp
+	$(CXX) $(CXXFLAGS) -c -o $@ $<

common/frameworks/scenes/application.cpp

@@ -0,0 +1,188 @@
+/* Copyright: (c) Kayne Ruse 2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "application.hpp"
+
+#include <chrono>
+#include <sstream>
+#include <stdexcept>
+
+void Application::Init(int argc, char* argv[]) {
+	//create and check the window
+	window = SDL_CreateWindow(
+		"Example Caption",
+		SDL_WINDOWPOS_UNDEFINED,
+		SDL_WINDOWPOS_UNDEFINED,
+		screenWidth,
+		screenHeight,
+		SDL_WINDOW_RESIZABLE);
+
+	if (!window) {
+		std::ostringstream msg;
+		msg << "Failed to create the window: " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+
+	//create and check the renderer
+	renderer = SDL_CreateRenderer(window, -1, 0);
+
+	if (!renderer) {
+		std::ostringstream msg;
+		msg << "Failed to create the renderer: " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+
+	//screen scaling
+	SDL_SetHint(SDL_HINT_RENDER_SCALE_QUALITY, "best");
+	SDL_RenderSetLogicalSize(renderer, screenWidth, screenHeight);
+
+	//set the hook for the renderer
+	BaseScene::SetRenderer(renderer);
+}
+
+void Application::Proc() {
+	//load the first scene
+	ProcessSceneSignal(SceneSignal::FIRST);
+
+	//fixed frame rate
+	typedef std::chrono::steady_clock Clock;
+
+	Clock::time_point simTime = Clock::now();
+	Clock::time_point realTime;
+	constexpr std::chrono::duration<int, std::milli> frameDelay(16); //~60FPS
+
+	//the game loop continues until the scenes signal QUIT
+	while(activeScene->GetSceneSignal() != SceneSignal::QUIT) {
+		//switch scenes if necessary
+		if(activeScene->GetSceneSignal() != SceneSignal::CONTINUE) {
+			ProcessSceneSignal(activeScene->GetSceneSignal());
+			continue;
+		}
+
+		//update the current time
+		realTime = Clock::now();
+
+		//simulate the game or give the machine a break
+		if (simTime < realTime) {
+			while(simTime < realTime) {
+				//call the user defined functions
+				activeScene->FrameStart();
+				ProcessEvents();
+				activeScene->Update();
+				activeScene->FrameEnd();
+
+				//step to the next frame
+				simTime += frameDelay;
+			}
+		}
+		else {
+			SDL_Delay(1);
+		}
+
+		SDL_RenderClear(renderer);
+		activeScene->RenderFrame(renderer);
+		SDL_RenderPresent(renderer);
+	}
+
+	//cleanup
+	ClearScene();
+}
+
+void Application::Quit() {
+	//clean up after the program
+	BaseScene::SetRenderer(nullptr);
+	SDL_DestroyRenderer(renderer);
+	SDL_DestroyWindow(window);
+}
+
+//-------------------------
+//Scene management
+//-------------------------
+
+void Application::ProcessEvents() {
+	SDL_Event event;
+	while(SDL_PollEvent(&event)) {
+		switch(event.type) {
+			case SDL_QUIT:
+				activeScene->QuitEvent();
+			break;
+
+			case SDL_MOUSEMOTION:
+				activeScene->MouseMotion(event.motion);
+			break;
+
+			case SDL_MOUSEBUTTONDOWN:
+				activeScene->MouseButtonDown(event.button);
+			break;
+
+			case SDL_MOUSEBUTTONUP:
+				activeScene->MouseButtonUp(event.button);
+			break;
+
+			case SDL_MOUSEWHEEL:
+				activeScene->MouseWheel(event.wheel);
+			break;
+
+			case SDL_KEYDOWN:
+				activeScene->KeyDown(event.key);
+			break;
+
+			case SDL_KEYUP:
+				activeScene->KeyUp(event.key);
+			break;
+
+			//TODO: joystick and controller events
+
+			//window events are handled internally
+			case SDL_WINDOWEVENT:
+				switch(event.window.event) {
+					case SDL_WINDOWEVENT_RESIZED:
+						SDL_RenderSetLogicalSize(renderer, event.window.data1, event.window.data2);
+					break;
+				}
+			break;
+		}
+	}
+}
+
+//Add the custom scene headers here
+#include "example_scene.hpp"
+
+void Application::ProcessSceneSignal(SceneSignal signal) {
+	ClearScene();
+
+	switch(signal) {
+		case SceneSignal::FIRST:
+		case SceneSignal::EXAMPLE_SCENE:
+			activeScene = new ExampleScene();
+		break;
+		default: {
+			std::ostringstream msg;
+			msg << "Failed to recognize the scene signal: " << signal;
+			throw(std::logic_error(msg.str()));
+		}
+	}
+}
+
+void Application::ClearScene() {
+	delete activeScene;
+	activeScene = nullptr;
+}

common/frameworks/scenes/application.hpp

@@ -0,0 +1,54 @@
+/* Copyright: (c) Kayne Ruse 2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "base_scene.hpp"
+#include "scene_signal.hpp"
+
+#include "SDL2/SDL.h"
+
+//TODO: do something with these
+constexpr int screenWidth = 800;
+constexpr int screenHeight = 600;
+
+//DOCS: The Application class handles scene switching, utilizing only one window
+class Application {
+public:
+	Application() = default;
+	~Application() = default;
+
+	void Init(int argc, char* argv[]);
+	void Proc();
+	void Quit();
+
+private:
+	//scene management
+	void ProcessEvents();
+	void ProcessSceneSignal(SceneSignal);
+	void ClearScene();
+
+	BaseScene* activeScene = nullptr;
+
+	//TODO: build a "window" class?
+	SDL_Window* window = nullptr;
+	SDL_Renderer* renderer = nullptr;
+};

common/frameworks/scenes/base_scene.cpp

@@ -0,0 +1,105 @@
+/* Copyright: (c) Kayne Ruse 2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "base_scene.hpp"
+
+SDL_Renderer* BaseScene::rendererHandle = nullptr;
+
+BaseScene::BaseScene() {
+	//EMPTY
+}
+
+BaseScene::~BaseScene() {
+	//EMPTY
+}
+
+void BaseScene::RenderFrame(SDL_Renderer* renderer) {
+	//EMPTY
+}
+
+void BaseScene::SetRenderer(SDL_Renderer* r) {
+	rendererHandle = r;
+}
+
+SDL_Renderer* BaseScene::GetRenderer() {
+	return rendererHandle;
+}
+
+void BaseScene::SetSceneSignal(SceneSignal signal) {
+	sceneSignal = signal;
+}
+
+SceneSignal BaseScene::GetSceneSignal() {
+	return sceneSignal;
+}
+
+//-------------------------
+//frame phases
+//-------------------------
+
+void BaseScene::FrameStart() {
+	//EMPTY
+}
+
+void BaseScene::Update() {
+	//EMPTY
+}
+
+void BaseScene::FrameEnd() {
+	//EMPTY
+}
+
+//-------------------------
+//input events
+//-------------------------
+
+void BaseScene::QuitEvent() {
+	sceneSignal = SceneSignal::QUIT;
+}
+
+void BaseScene::MouseMotion(SDL_MouseMotionEvent const& event) {
+	//EMPTY
+}
+
+void BaseScene::MouseButtonDown(SDL_MouseButtonEvent const& event) {
+	//EMPTY
+}
+
+void BaseScene::MouseButtonUp(SDL_MouseButtonEvent const& event) {
+	//EMPTY
+}
+
+void BaseScene::MouseWheel(SDL_MouseWheelEvent const& event) {
+	//EMPTY
+}
+
+void BaseScene::KeyDown(SDL_KeyboardEvent const& event) {
+	//preference as a default
+	switch(event.keysym.sym) {
+		case SDLK_ESCAPE:
+			QuitEvent();
+		break;
+	}
+}
+
+void BaseScene::KeyUp(SDL_KeyboardEvent const& event) {
+	//EMPTY
+}

common/frameworks/scenes/base_scene.hpp

@@ -0,0 +1,61 @@
+/* Copyright: (c) Kayne Ruse 2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "scene_signal.hpp"
+
+#include "SDL2/SDL.h"
+
+class BaseScene {
+public:
+	BaseScene();
+	virtual ~BaseScene();
+
+	virtual void RenderFrame(SDL_Renderer*);
+	static void SetRenderer(SDL_Renderer*);
+	SceneSignal GetSceneSignal();
+
+	//frame phases
+	virtual void FrameStart();
+	virtual void Update();
+	virtual void FrameEnd();
+
+	//input events
+	virtual void QuitEvent();
+	virtual void MouseMotion(SDL_MouseMotionEvent const& event);
+	virtual void MouseButtonDown(SDL_MouseButtonEvent const& event);
+	virtual void MouseButtonUp(SDL_MouseButtonEvent const& event);
+	virtual void MouseWheel(SDL_MouseWheelEvent const& event);
+	virtual void KeyDown(SDL_KeyboardEvent const& event);
+	virtual void KeyUp(SDL_KeyboardEvent const& event);
+
+	//TODO: joystick and controller events
+
+protected:
+	//control
+	static SDL_Renderer* GetRenderer();
+	void SetSceneSignal(SceneSignal);
+
+private:
+	static SDL_Renderer* rendererHandle;
+	SceneSignal sceneSignal = SceneSignal::CONTINUE;
+};

common/frameworks/scenes/example_scene.cpp

@@ -0,0 +1,83 @@
+/* Copyright: (c) Kayne Ruse 2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "example_scene.hpp"
+
+ExampleScene::ExampleScene() {
+	//
+}
+
+ExampleScene::~ExampleScene() {
+	//
+}
+
+//-------------------------
+//frame phases
+//-------------------------
+
+void ExampleScene::FrameStart() {
+	//
+}
+
+void ExampleScene::Update() {
+	//
+}
+
+void ExampleScene::FrameEnd() {
+	//
+}
+
+void ExampleScene::RenderFrame(SDL_Renderer* renderer) {
+	//
+}
+
+//-------------------------
+//input events
+//-------------------------
+
+void ExampleScene::MouseMotion(SDL_MouseMotionEvent const& event) {
+	//
+}
+
+void ExampleScene::MouseButtonDown(SDL_MouseButtonEvent const& event) {
+	//
+}
+
+void ExampleScene::MouseButtonUp(SDL_MouseButtonEvent const& event) {
+	//
+}
+
+void ExampleScene::MouseWheel(SDL_MouseWheelEvent const& event) {
+	//
+}
+
+void ExampleScene::KeyDown(SDL_KeyboardEvent const& event) {
+	//preference as a default
+	switch(event.keysym.sym) {
+		case SDLK_ESCAPE:
+			QuitEvent();
+		break;
+	}
+}
+
+void ExampleScene::KeyUp(SDL_KeyboardEvent const& event) {
+	//
+}

common/frameworks/scenes/example_scene.hpp

@@ -0,0 +1,46 @@
+/* Copyright: (c) Kayne Ruse 2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "base_scene.hpp"
+
+class ExampleScene : public BaseScene {
+public:
+	ExampleScene();
+	~ExampleScene();
+
+	void RenderFrame(SDL_Renderer* renderer) override;
+
+private:
+	//frame phases
+	void FrameStart() override;
+	void Update() override;
+	void FrameEnd() override;
+
+	//input events
+	void MouseMotion(SDL_MouseMotionEvent const& event) override;
+	void MouseButtonDown(SDL_MouseButtonEvent const& event) override;
+	void MouseButtonUp(SDL_MouseButtonEvent const& event) override;
+	void MouseWheel(SDL_MouseWheelEvent const& event) override;
+	void KeyDown(SDL_KeyboardEvent const& event) override;
+	void KeyUp(SDL_KeyboardEvent const& event) override;
+};

common/frameworks/scenes/main.cpp

@@ -0,0 +1,43 @@
+/* Copyright: (c) Kayne Ruse 2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "application.hpp"
+
+#include "SDL2/SDL.h"
+
+#include <iostream>
+#include <stdexcept>
+
+int main(int argc, char** argv) {
+	std::cout << "Beginning " << argv[0] << std::endl;
+	try {
+		Application app;
+		app.Init(argc, argv);
+		app.Proc();
+		app.Quit();
+	}
+	catch(std::exception& e) {
+		std::cerr << "Fatal Error: " << e.what() << std::endl;
+		return 1;
+	}
+	std::cout << "Clean exit from " << argv[0] << std::endl;
+	return 0;
+}

common/frameworks/scenes/makefile

@@ -0,0 +1,56 @@
+#include directories
+INCLUDES+=.
+
+#libraries
+#the order of the $(LIBS) is important, at least for MinGW
+LIBS+=
+ifeq ($(OS),Windows_NT)
+	LIBS+=-lmingw32
+endif
+LIBS+=-lSDL2main -lSDL2
+
+#flags
+CXXFLAGS+=-std=c++11 $(addprefix -I,$(INCLUDES))
+ifeq ($(shell uname), Linux)
+	#read data about the current install
+	CXXFLAGS+=$(shell sdl-config --cflags --static-libs)
+endif
+
+#source
+CXXSRC=$(wildcard *.cpp)
+
+#objects
+OBJDIR=obj
+OBJ+=$(addprefix $(OBJDIR)/,$(CXXSRC:.cpp=.o))
+
+#output
+OUTDIR=out
+OUT=$(addprefix $(OUTDIR)/,scenes)
+
+#targets
+all: $(OBJ) $(OUT)
+	$(CXX) $(CXXFLAGS) -o $(OUT) $(OBJ) $(LIBS)
+
+$(OBJ): | $(OBJDIR)
+
+$(OUT): | $(OUTDIR)
+
+$(OBJDIR):
+	mkdir $(OBJDIR)
+
+$(OUTDIR):
+	mkdir $(OUTDIR)
+
+$(OBJDIR)/%.o: %.cpp
+	$(CXX) $(CXXFLAGS) -c -o $@ $<
+
+clean:
+ifeq ($(OS),Windows_NT)
+	$(RM) *.o *.a *.exe
+else ifeq ($(shell uname), Linux)
+	find . -type f -name '*.o' -exec rm -f -r -v {} \;
+	find . -type f -name '*.a' -exec rm -f -r -v {} \;
+	rm -f -v $(OUT)
+endif
+
+rebuild: clean all

common/frameworks/scenes/scene_signal.hpp

@@ -0,0 +1,32 @@
+/* Copyright: (c) Kayne Ruse 2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+enum SceneSignal {
+	//reserved members for internal use
+	QUIT = -1,
+	CONTINUE = 0,
+	FIRST = 1,
+
+	//custom scenes
+	EXAMPLE_SCENE
+};

common/gameplay/character_defines.hpp

@@ -0,0 +1,39 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include <cmath>
+
+//the speeds that the characters move
+constexpr double CHARACTER_WALKING_SPEED = 2.24;
+constexpr double CHARACTER_WALKING_MOD = 1.0/sqrt(2.0);
+constexpr double CHARACTER_WALKING_NEGATIVE_MOD = 1.0 - CHARACTER_WALKING_MOD;
+
+//the bounds for the character objects, mapped to the default sprites
+constexpr int CHARACTER_BOUNDS_X = 0;
+constexpr int CHARACTER_BOUNDS_Y = 16;
+constexpr int CHARACTER_BOUNDS_WIDTH = 32;
+constexpr int CHARACTER_BOUNDS_HEIGHT = 32;
+
+//the character's sprite format
+constexpr int CHARACTER_CELLS_X = 4;
+constexpr int CHARACTER_CELLS_Y = 4;

common/gameplay/makefile

@@ -0,0 +1,28 @@
+#config
+INCLUDES+=.
+LIBS+=
+CXXFLAGS+=-std=c++11 $(addprefix -I,$(INCLUDES))
+
+#source
+CXXSRC=$(wildcard *.cpp)
+
+#objects
+OBJDIR=obj
+OBJ+=$(addprefix $(OBJDIR)/,$(CXXSRC:.cpp=.o))
+
+#targets
+all: $(OBJ) $(OUT)
+	ar -crs $(OUT) $(OBJ)
+
+$(OBJ): | $(OBJDIR)
+
+$(OUT): | $(OUTDIR)
+
+$(OBJDIR):
+	mkdir $(OBJDIR)
+
+$(OUTDIR):
+	mkdir $(OUTDIR)
+
+$(OBJDIR)/%.o: %.cpp
+	$(CXX) $(CXXFLAGS) -c -o $@ $<

common/graphics/button.cpp

@@ -0,0 +1,167 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "button.hpp"
+
+#include <stdexcept>
+
+void Button::DrawTo(SDL_Renderer* renderer) {
+	image.SetClipY(image.GetClipH() * state);
+	image.DrawTo(renderer, posX, posY);
+}
+
+void Button::SetBackgroundTexture(SDL_Renderer* renderer, SDL_Texture* texture) {
+	//copy the given texture
+	image.Free();
+
+	//a null texture can simply free the image
+	if (!texture) {
+		return;
+	}
+
+	//get the w & h, & create
+	int w = 0, h = 0;
+	SDL_QueryTexture(texture, nullptr, nullptr, &w, &h);
+	image.Create(renderer, w, h);
+
+	//copy
+	SDL_SetRenderTarget(renderer, image.GetTexture());
+	SDL_RenderCopy(renderer, texture, nullptr, nullptr);
+	SDL_SetRenderTarget(renderer, nullptr);
+
+	//prune
+	image.SetClipH(image.GetClipH() / 3);
+}
+
+void Button::SetText(SDL_Renderer* renderer, TTF_Font* font, std::string s, SDL_Color color) {
+	//make the surface (from SDL_ttf)
+	SDL_Surface* surf = TTF_RenderText_Solid(font, s.c_str(), color);
+	if (!surf) {
+		throw(std::runtime_error("Failed to create a TTF surface"));
+	}
+
+	//convert to texture
+	SDL_Texture* text = SDL_CreateTextureFromSurface(renderer, surf);
+	SDL_FreeSurface(surf);
+	if (!text) {
+		throw(std::runtime_error("Failed to create a TTF texture"));
+	}
+
+	//get the dimensions & rects
+	int x, y, w, h;
+	SDL_QueryTexture(text, nullptr, nullptr, &w, &h);
+	x = (image.GetClipW() - w) / 2;
+	y = (image.GetClipH() - h) / 2;
+	SDL_Rect src = {0, 0, w, h};
+	SDL_Rect dst;
+
+	//draw the text to the background
+	SDL_SetRenderTarget(renderer, image.GetTexture());
+
+	for (int i = 0; i < 3; i++) {
+		dst = {x, y + image.GetClipH() * i, w, h};
+		SDL_RenderCopy(renderer, text, &src, &dst);
+	}
+
+	SDL_SetRenderTarget(renderer, nullptr);
+
+	//free the texture
+	SDL_DestroyTexture(text);
+}
+
+void Button::SetX(int x) {
+	posX = x;
+}
+
+void Button::SetY(int y) {
+	posY = y;
+}
+
+Button::State Button::MouseMotion(SDL_MouseMotionEvent const& event) {
+	//if out of bounds, exit
+	if (!CheckBounds(event.x, event.y)) {
+		return state = State::IDLE;
+	}
+
+	//if in bounds, check button
+	if (event.state & SDL_BUTTON_LMASK && state == State::PRESSED) {
+		//stay pressed
+//		state = State::PRESSED;
+	}
+	else {
+		state = State::HOVER;
+	}
+
+	return state;
+}
+
+Button::State Button::MouseButtonDown(SDL_MouseButtonEvent const& event) {
+	//if out of bounds, exit
+	if (!CheckBounds(event.x, event.y)) {
+		return state = State::IDLE;
+	}
+
+	//if in bounds, check button
+	if (event.button == SDL_BUTTON_LEFT) {
+		return state = State::PRESSED;
+	}
+
+	//NOTE: if not left button down, ignore
+	return State::HOVER;
+}
+
+Button::State Button::MouseButtonUp(SDL_MouseButtonEvent const& event) {
+	//if out of bounds, exit
+	if (!CheckBounds(event.x, event.y)) {
+		return state = State::IDLE;
+	}
+
+	//if not left button up, ignore
+	if (event.button != SDL_BUTTON_LEFT) {
+		return state;
+	}
+
+	//if in bounds and left button up, send release signal
+	if (state == State::PRESSED) {
+		state = State::HOVER;
+		return State::RELEASED;
+	}
+
+	return state;
+}
+
+void Button::SetState(State s) {
+	state = s;
+}
+
+Button::State Button::GetState() {
+	return state;
+}
+
+bool Button::CheckBounds(int x, int y) {
+	//return if true (x, y) is within bounds, otherwise return false
+	return !(
+		x < posX ||
+		y < posY ||
+		x > posX + image.GetClipW() ||
+		y > posY + image.GetClipH()
+		);
+}

common/graphics/button.hpp

@@ -0,0 +1,68 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "image.hpp"
+
+#include "SDL2/SDL_ttf.h"
+
+#include <string>
+
+constexpr SDL_Color COLOR_WHITE = {255, 255, 255, 255};
+constexpr SDL_Color COLOR_RED = {255, 0, 0, 255};
+constexpr SDL_Color COLOR_ORANGE = {255, 127, 0, 255};
+constexpr SDL_Color COLOR_BLUE = {0, 0, 255, 255};
+
+class Button {
+public:
+	enum State {
+		IDLE = 0, HOVER = 1, PRESSED = 2, RELEASED = 3
+	};
+
+	//methods
+	Button() = default;
+	~Button() = default;
+
+	void DrawTo(SDL_Renderer*);
+
+	//setup
+	void SetBackgroundTexture(SDL_Renderer*, SDL_Texture*);
+	void SetText(SDL_Renderer*, TTF_Font*, std::string, SDL_Color);
+	void SetX(int x);
+	void SetY(int y);
+
+	//capture input
+	State MouseMotion(SDL_MouseMotionEvent const&);
+	State MouseButtonDown(SDL_MouseButtonEvent const&);
+	State MouseButtonUp(SDL_MouseButtonEvent const&);
+
+	//states
+	void SetState(State); //TODO: idle, busy or disabled
+	State GetState();
+
+protected:
+	bool CheckBounds(int x, int y);
+
+	Image image;
+	int posX = 0, posY = 0;
+	State state = State::IDLE;
+};

common/graphics/image.cpp

@@ -0,0 +1,211 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "image.hpp"
+
+#include "SDL2/SDL_image.h"
+
+#include <sstream>
+#include <stdexcept>
+
+Image& Image::operator=(Image const& rhs) {
+	//don't screw yourself
+	if (this == &rhs) {
+		return *this;
+	}
+
+	Free();
+
+	//Copy the other Image's stuff
+	texture = rhs.texture;
+	clip = rhs.clip;
+	local = false;
+}
+
+Image& Image::operator=(Image&& rhs) {
+	//don't screw yourself
+	if (this == &rhs) {
+		return *this;
+	}
+
+	Free();
+
+	//Steal the other Image's stuff
+	texture = rhs.texture;
+	clip = rhs.clip;
+	local = rhs.local;
+
+	rhs.texture = nullptr;
+	rhs.clip = {0, 0, 0, 0};
+	rhs.local = false;
+}
+
+SDL_Texture* Image::Load(SDL_Renderer* renderer, std::string fname) {
+	Free();
+
+	//load the file into a surface
+	SDL_Surface* surface = IMG_Load(fname.c_str());
+	if (!surface) {
+		std::ostringstream msg;
+		msg << "Failed to load an image file: " << fname;
+		msg << "; " << IMG_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+
+	//create a texture from this surface
+	texture = SDL_CreateTextureFromSurface(renderer, surface);
+	if (!texture) {
+		std::ostringstream msg;
+		msg << "Failed to convert a newly loaded image file: " << fname;
+		msg << "; " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+
+	//set the metadata
+	clip.x = 0;
+	clip.y = 0;
+	if (SDL_QueryTexture(texture, nullptr, nullptr, &clip.w, &clip.h)) {
+		std::ostringstream msg;
+		msg << "Failed to record metadata for a newly loaded image file: " << fname;
+		msg << "; " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+	local = true;
+
+	//free the surface & return
+	SDL_FreeSurface(surface);
+	return texture;
+}
+
+SDL_Texture* Image::Create(SDL_Renderer* renderer, Uint16 w, Uint16 h, SDL_Color blank) {
+	Free();
+
+	//make the texture
+	texture = SDL_CreateTexture(renderer,
+		SDL_PIXELFORMAT_RGBA8888,
+		SDL_TEXTUREACCESS_TARGET,
+		w, h);
+
+	//check
+	if (!texture) {
+		std::ostringstream msg;
+		msg << "Failed to create a texture; " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+
+	//set the metadata
+	clip.x = 0;
+	clip.y = 0;
+	if (SDL_QueryTexture(texture, nullptr, nullptr, &clip.w, &clip.h)) {
+		std::ostringstream msg;
+		msg << "Failed to record metadata for a newly created image";
+		msg << "; " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+	local = true;
+
+	//blank (black) texture
+	SDL_SetRenderTarget(renderer, texture);
+	SDL_SetRenderDrawColor(renderer, blank.r, blank.g, blank.b, blank.a);
+	SDL_RenderFillRect(renderer, nullptr);
+	SDL_SetRenderDrawColor(renderer, 0, 0, 0, 0);
+	SDL_SetRenderTarget(renderer, nullptr);
+
+	return texture;
+}
+
+SDL_Texture* Image::CopyTexture(SDL_Renderer* renderer, SDL_Texture* ptr) {
+	Free();
+	int w = 0, h = 0;
+
+	//get the info
+	SDL_QueryTexture(ptr, nullptr, nullptr, &w, &h);
+
+	//create a texture of (w, h) size (also sets the metadata)
+	Create(renderer, w, h);
+
+	//copy the argument texture to the local texture
+	SDL_SetRenderTarget(renderer, texture);
+	SDL_RenderCopy(renderer, ptr, nullptr, nullptr);
+	SDL_SetRenderTarget(renderer, nullptr);
+
+	//return the local texture
+	return texture;
+}
+
+SDL_Texture* Image::SetTexture(SDL_Texture* ptr) {
+	Free();
+
+	texture = ptr;
+
+	//set the metadata
+	clip.x = 0;
+	clip.y = 0;
+	if (SDL_QueryTexture(texture, nullptr, nullptr, &clip.w, &clip.h)) {
+		std::ostringstream msg;
+		msg << "Failed to record metadata for a newly image image";
+		msg << "; " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+	local = false;
+
+	return texture;
+}
+
+SDL_Texture* Image::GetTexture() const {
+	return texture;
+}
+
+void Image::Free() {
+	if (local) {
+		SDL_DestroyTexture(texture);
+		local = false;
+	}
+	texture = nullptr;
+	clip = {0, 0, 0, 0};
+}
+
+void Image::DrawTo(SDL_Renderer* const renderer, Sint16 x, Sint16 y, double scaleX, double scaleY) {
+	if (!texture) {
+		throw(std::logic_error("No image texture to draw"));
+	}
+	SDL_Rect sclip = clip;
+	SDL_Rect dclip = {x, y, Uint16(clip.w * scaleX), Uint16(clip.h * scaleY)};
+	SDL_RenderCopy(renderer, texture, &sclip, &dclip);
+}
+
+void Image::SetAlpha(Uint8 a) {
+	if (SDL_SetTextureAlphaMod(texture, a)) {
+		std::ostringstream msg;
+		msg << "Failed to set alpha; " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+}
+
+Uint8 Image::GetAlpha() {
+	Uint8 ret = 0;
+	if (SDL_GetTextureAlphaMod(texture, &ret)) {
+		std::ostringstream msg;
+		msg << "Failed to get alpha; " << SDL_GetError();
+		throw(std::runtime_error(msg.str()));
+	}
+	return ret;
+}

common/graphics/image.hpp

@@ -0,0 +1,73 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "SDL2/SDL.h"
+
+#include <string>
+
+class Image {
+public:
+	Image() = default;
+	Image(Image const& rhs) { *this = rhs; }
+	Image(Image&& rhs) { *this = std::move(rhs); }
+	Image(SDL_Renderer* r, std::string fname) { Load(r, fname); }
+	Image(SDL_Renderer* r, Uint16 w, Uint16 h) { Create(r, w, h); }
+	Image(SDL_Texture* p) { SetTexture(p); }
+	virtual ~Image() { Free(); }
+
+	Image& operator=(Image const&);
+	Image& operator=(Image&&);
+
+	SDL_Texture* Load(SDL_Renderer* renderer, std::string fname);
+	SDL_Texture* Create(SDL_Renderer* renderer, Uint16 w, Uint16 h, SDL_Color blank = {0, 0, 0, 255});
+	SDL_Texture* CopyTexture(SDL_Renderer* renderer, SDL_Texture* ptr);
+	SDL_Texture* SetTexture(SDL_Texture*);
+	SDL_Texture* GetTexture() const;
+	virtual void Free();
+
+	void DrawTo(SDL_Renderer* const, Sint16 x, Sint16 y, double scaleX = 1.0, double scaleY = 1.0);
+
+	void SetAlpha(Uint8 a);
+	Uint8 GetAlpha();
+
+	//Clip handlers
+	SDL_Rect SetClip(SDL_Rect r) { return clip = r; }
+	SDL_Rect GetClip() const { return clip; }
+
+	Sint16 SetClipX(Sint16 x) { return clip.x = x; }
+	Sint16 SetClipY(Sint16 y) { return clip.y = y; }
+	Uint16 SetClipW(Uint16 w) { return clip.w = w; }
+	Uint16 SetClipH(Uint16 h) { return clip.h = h; }
+
+	Sint16 GetClipX() const { return clip.x; }
+	Sint16 GetClipY() const { return clip.y; }
+	Uint16 GetClipW() const { return clip.w; }
+	Uint16 GetClipH() const { return clip.h; }
+
+	bool GetLocal() const { return local; }
+
+protected:
+	SDL_Texture* texture = nullptr;
+	SDL_Rect clip = {0, 0, 0, 0};
+	bool local = false;
+};

common/graphics/makefile

@@ -0,0 +1,28 @@
+#config
+INCLUDES+=.
+LIBS+=
+CXXFLAGS+=-std=c++11 $(addprefix -I,$(INCLUDES))
+
+#source
+CXXSRC=$(wildcard *.cpp)
+
+#objects
+OBJDIR=obj
+OBJ+=$(addprefix $(OBJDIR)/,$(CXXSRC:.cpp=.o))
+
+#targets
+all: $(OBJ) $(OUT)
+	ar -crs $(OUT) $(OBJ)
+
+$(OBJ): | $(OBJDIR)
+
+$(OUT): | $(OUTDIR)
+
+$(OBJDIR):
+	mkdir $(OBJDIR)
+
+$(OUTDIR):
+	mkdir $(OUTDIR)
+
+$(OBJDIR)/%.o: %.cpp
+	$(CXX) $(CXXFLAGS) -c -o $@ $<

common/graphics/sprite_sheet.cpp

@@ -0,0 +1,186 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "sprite_sheet.hpp"
+
+#include <sstream>
+#include <stdexcept>
+
+SpriteSheet& SpriteSheet::operator=(SpriteSheet const& rhs) {
+	//don't screw yourself
+	if (this == &rhs) {
+		return *this;
+	}
+
+	Free();
+
+	//Copy the other SpriteSheet's stuff
+	texture = rhs.texture;
+	clip = rhs.clip;
+	local = false;
+	countX = rhs.countX;
+	countY = rhs.countY;
+	indexX = rhs.indexX;
+	indexY = rhs.indexY;
+	delay = rhs.delay;
+	tick = rhs.tick;
+}
+
+SpriteSheet& SpriteSheet::operator=(SpriteSheet&& rhs) {
+	//don't screw yourself
+	if (this == &rhs) {
+		return *this;
+	}
+
+	Free();
+
+	//Steal the other SpriteSheet's stuff
+	texture = rhs.texture;
+	clip = rhs.clip;
+	local = rhs.local;
+	countX = rhs.countX;
+	countY = rhs.countY;
+	indexX = rhs.indexX;
+	indexY = rhs.indexY;
+	delay = rhs.delay;
+	tick = rhs.tick;
+
+	rhs.texture = nullptr;
+	rhs.clip = {0, 0, 0, 0};
+	rhs.local = false;
+	rhs.countX = 0;
+	rhs.countY = 0;
+	rhs.indexX = 0;
+	rhs.indexY = 0;
+	rhs.delay = 0.0;
+	rhs.tick = 0.0;
+}
+
+void SpriteSheet::Update(double delta) {
+	//if the delay has passed
+	if (delay && (tick += delta) >= delay) {
+		//if the index is out of bounds
+		if (++indexX >= countX) {
+			indexX = 0;
+		}
+		tick = 0;
+	}
+	//modify area drawn
+	clip.x = indexX * clip.w;
+	clip.y = indexY * clip.h;
+}
+
+SDL_Texture* SpriteSheet::Load(SDL_Renderer* r, std::string fname, Uint16 cx, Uint16 cy) {
+	//call the base function
+	Image::Load(r, fname);
+
+	//set the metadata
+	countX = cx;
+	countY = cy;
+
+	//assume clip.x and clip.y were set to the size of the texture
+	//reduce the w & h to the size of one cell
+	clip.w = clip.w / countX;
+	clip.h = clip.h / countY;
+
+	indexX = indexY = 0;
+	delay = tick = 0.0;
+
+	return texture;
+}
+
+SDL_Texture* SpriteSheet::Create(SDL_Renderer* r, Uint16 w, Uint16 h, Uint16 cx, Uint16 cy) {
+	//call the base function
+	Image::Create(r, w, h);
+
+	//set the metadata
+	countX = cx;
+	countY = cy;
+
+	//assume clip.x and clip.y were set to the size of the texture
+	//reduce the w & h to the size of one cell
+	clip.w = clip.w / countX;
+	clip.h = clip.h / countY;
+
+	indexX = indexY = 0;
+	delay = tick = 0.0;
+
+	return texture;
+}
+
+SDL_Texture* SpriteSheet::SetTexture(SDL_Texture* ptr, Uint16 cx, Uint16 cy) {
+	//call the base function
+	Image::SetTexture(ptr);
+
+	//set the metadata
+	countX = cx;
+	countY = cy;
+
+	//assume clip.x and clip.y were set to the size of the texture
+	//reduce the w & h to the size of one cell
+	clip.w = clip.w / countX;
+	clip.h = clip.h / countY;
+
+	indexX = indexY = 0;
+	delay = tick = 0.0;
+
+	return texture;
+}
+
+void SpriteSheet::Free() {
+	Image::Free();
+	countX = countY = 0;
+	indexX = indexY = 0;
+	delay = tick = 0.0;
+}
+
+Uint16 SpriteSheet::SetCountX(Uint16 i) {
+	indexX = 0;
+	return countX = i;
+}
+
+Uint16 SpriteSheet::SetCountY(Uint16 i) {
+	indexY = 0;
+	return countY = i;
+}
+
+Uint16 SpriteSheet::SetIndexX(Uint16 i) {
+	if (i > countX) {
+		std::ostringstream msg;
+		msg << "Cannot set index 'x' to " << i;
+		throw(std::out_of_range(msg.str()));
+	}
+	return indexX = i;
+}
+
+Uint16 SpriteSheet::SetIndexY(Uint16 i) {
+	if (i > countY) {
+		std::ostringstream msg;
+		msg << "Cannot set index 'y' to " << i;
+		throw(std::invalid_argument(msg.str()));
+	}
+	return indexY = i;
+}
+
+double SpriteSheet::SetDelay(double d) {
+	tick = 0;
+	return delay = d;
+}

common/graphics/sprite_sheet.hpp

@@ -0,0 +1,70 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "image.hpp"
+
+class SpriteSheet : public Image {
+public:
+	SpriteSheet() = default;
+	SpriteSheet(SpriteSheet const& rhs) { *this = rhs; }
+	SpriteSheet(SpriteSheet&& rhs) { *this = std::move(rhs); }
+	SpriteSheet(SDL_Renderer* r, std::string fname, Uint16 cx, Uint16 cy)
+		{ Load(r, fname, cx, cy); }
+	SpriteSheet(SDL_Renderer* r, Uint16 w, Uint16 h, Uint16 cx, Uint16 cy)
+		{ Create(r, w, h, cx, cy); }
+	SpriteSheet(SDL_Texture* p, Uint16 cx, Uint16 cy)
+		{ SetTexture(p, cx, cy); }
+	~SpriteSheet() = default;
+
+	SpriteSheet& operator=(SpriteSheet const&);
+	SpriteSheet& operator=(SpriteSheet&&);
+
+	void Update(double delta);
+
+	SDL_Texture* Load(SDL_Renderer*, std::string fname, Uint16 cx, Uint16 cy);
+	SDL_Texture* Create(SDL_Renderer*, Uint16 w, Uint16 h, Uint16 cx, Uint16 cy);
+	SDL_Texture* SetTexture(SDL_Texture*, Uint16 cx, Uint16 cy);
+	void Free() override;
+
+	Uint16 SetCountX(Uint16);
+	Uint16 SetCountY(Uint16);
+	Uint16 SetIndexX(Uint16);
+	Uint16 SetIndexY(Uint16);
+
+	Uint16 GetCountX() const { return countX; }
+	Uint16 GetCountY() const { return countY; }
+	Uint16 GetIndexX() const { return indexX; }
+	Uint16 GetIndexY() const { return indexY; }
+
+	double SetDelay(double d);
+	double GetDelay() const { return delay; }
+
+private:
+	Uint16 countX = 0, countY = 0, indexX = 0, indexY = 0;
+	double delay = 0.0, tick = 0.0;
+
+	//disable access
+	using Image::Load;
+	using Image::Create;
+	using Image::SetTexture;
+};

common/graphics/text_box.cpp

@@ -0,0 +1,56 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "text_box.hpp"
+
+#include <stdexcept>
+
+TextBox::TextBox() {
+	//
+}
+
+TextBox::~TextBox() {
+	//
+}
+
+void TextBox::DrawTo(SDL_Renderer* renderer, int posX, int posY, int pointSize) {
+	for (std::list<TextLine>::iterator it = lineList.begin(); it != lineList.end(); it++) {
+		it->DrawTo(renderer, posX, posY);
+		posY += pointSize;
+	}
+}
+
+void TextBox::PushLine(SDL_Renderer* renderer, TTF_Font* font, std::string str, SDL_Color color) {
+	lineList.emplace_front(renderer, font, str, color);
+}
+
+void TextBox::PopLine(int num) {
+	//prevent underflow
+	num < lineList.size() ? num : lineList.size();
+
+	for (int i = 0; i < num; ++i) {
+		lineList.pop_back();
+	}
+}
+
+void TextBox::ClearLines() {
+	lineList.clear();
+}

common/graphics/text_box.hpp

@@ -0,0 +1,45 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "text_line.hpp"
+
+#include "SDL2/SDL.h"
+#include "SDL2/SDL_ttf.h"
+
+#include <string>
+#include <list>
+
+class TextBox {
+public:
+	TextBox();
+	~TextBox();
+
+	void DrawTo(SDL_Renderer*, int posX, int posY, int pointSize);
+
+	void PushLine(SDL_Renderer*, TTF_Font*, std::string, SDL_Color color);
+	void PopLine(int num = 1);
+	void ClearLines();
+
+private:
+	std::list<TextLine> lineList;
+};

common/graphics/text_line.cpp

@@ -0,0 +1,70 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "text_line.hpp"
+
+#include <stdexcept>
+
+SDL_Texture* renderTextTexture(SDL_Renderer* renderer, TTF_Font* font, std::string str, SDL_Color color) {
+	//make the surface (from SDL_ttf)
+	SDL_Surface* surface = TTF_RenderText_Solid(font, str.c_str(), color);
+	if (!surface) {
+		throw(std::runtime_error("Failed to create a TTF surface"));
+	}
+
+	//convert to texture
+	SDL_Texture* texture = SDL_CreateTextureFromSurface(renderer, surface);
+
+	//cleanup
+	SDL_FreeSurface(surface);
+
+	//check
+	if (!texture) {
+		throw(std::runtime_error("Failed to create a TTF texture"));
+	}
+
+	//NOTE: free the texture yourself
+	return texture;
+}
+
+TextLine::TextLine() {
+	//
+}
+
+TextLine::~TextLine() {
+	ClearText();
+}
+
+void TextLine::DrawTo(SDL_Renderer* renderer, int posX, int posY) {
+	SDL_Rect dclip = {posX, posY, 0, 0};
+	SDL_QueryTexture(texture, nullptr, nullptr, &dclip.w, &dclip.h);
+	SDL_RenderCopy(renderer, texture, nullptr, &dclip);
+}
+
+void TextLine::SetText(SDL_Renderer* renderer, TTF_Font* font, std::string str, SDL_Color color) {
+	//just use the above global function
+	SDL_DestroyTexture(texture);
+	texture = renderTextTexture(renderer, font, str, color);
+}
+
+void TextLine::ClearText() {
+	SDL_DestroyTexture(texture);
+}

common/graphics/text_line.hpp

@@ -0,0 +1,45 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "SDL2/SDL.h"
+#include "SDL2/SDL_ttf.h"
+
+#include <string>
+
+SDL_Texture* renderTextTexture(SDL_Renderer*, TTF_Font*, std::string, SDL_Color color);
+
+class TextLine {
+public:
+	TextLine();
+	TextLine(SDL_Renderer* r, TTF_Font* f, std::string s, SDL_Color c)
+		{ SetText(r, f, s, c); }
+	virtual ~TextLine();
+
+	void DrawTo(SDL_Renderer*, int posX, int posY);
+
+	void SetText(SDL_Renderer*, TTF_Font*, std::string, SDL_Color color);
+	void ClearText();
+
+protected:
+	SDL_Texture* texture = nullptr;
+};

common/makefile

@@ -0,0 +1,28 @@
+#output
+export OUTDIR=..
+export OUT=$(addprefix $(OUTDIR)/,libcommon.a)
+
+all: $(OUTDIR)
+	$(MAKE) -C debugging
+	$(MAKE) -C gameplay
+	$(MAKE) -C graphics
+	$(MAKE) -C map
+	$(MAKE) -C network
+	$(MAKE) -C utilities
+
+debug: export CXXFLAGS+=-g
+debug: clean all
+
+$(OUTDIR):
+	mkdir $(OUTDIR)
+
+clean:
+ifeq ($(OS),Windows_NT)
+	$(RM) *.o *.a *.exe
+else ifeq ($(shell uname), Linux)
+	find . -type f -name *.o -exec rm -f -r -v {} \;
+	find . -type f -name *.a -exec rm -f -r -v {} \;
+	rm -f -v out/client out/server
+endif
+
+rebuild: clean all

common/map/makefile

@@ -0,0 +1,28 @@
+#config
+INCLUDES+=. ../graphics
+LIBS+=
+CXXFLAGS+=-std=c++11 $(addprefix -I,$(INCLUDES))
+
+#source
+CXXSRC=$(wildcard *.cpp)
+
+#objects
+OBJDIR=obj
+OBJ+=$(addprefix $(OBJDIR)/,$(CXXSRC:.cpp=.o))
+
+#targets
+all: $(OBJ) $(OUT)
+	ar -crs $(OUT) $(OBJ)
+
+$(OBJ): | $(OBJDIR)
+
+$(OUT): | $(OUTDIR)
+
+$(OBJDIR):
+	mkdir $(OBJDIR)
+
+$(OUTDIR):
+	mkdir $(OUTDIR)
+
+$(OBJDIR)/%.o: %.cpp
+	$(CXX) $(CXXFLAGS) -c -o $@ $<

common/map/region.cpp

@@ -0,0 +1,82 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "region.hpp"
+
+#include <cmath>
+#include <cstring>
+#include <stdexcept>
+
+int snapToBase(int base, int x) {
+	return floor((double)x / base) * base;
+}
+
+Region::Region(int argX, int argY): x(argX), y(argY) {
+	if (x != snapToBase(REGION_WIDTH, x) || y != snapToBase(REGION_HEIGHT, y)) {
+		throw(std::invalid_argument("Region location is off grid"));
+	}
+	memset(tiles, 0, REGION_WIDTH*REGION_HEIGHT*REGION_DEPTH*sizeof(type_t));
+}
+
+Region::Region(Region const& rhs): x(rhs.x), y(rhs.y) {
+	memcpy(tiles, rhs.tiles, REGION_WIDTH*REGION_HEIGHT*REGION_DEPTH*sizeof(type_t));
+	solid = rhs.solid;
+}
+
+Region::type_t Region::SetTile(int x, int y, int z, type_t v) {
+	if (x < 0 || y < 0 || z < 0 || x >= REGION_WIDTH || y >= REGION_HEIGHT || z >= REGION_DEPTH) {
+		throw(std::out_of_range("Region::SetTile() argument out of range"));
+	}
+	return tiles[x][y][z] = v;
+}
+
+Region::type_t Region::GetTile(int x, int y, int z) {
+	if (x < 0 || y < 0 || z < 0 || x >= REGION_WIDTH || y >= REGION_HEIGHT || z >= REGION_DEPTH) {
+		throw(std::out_of_range("Region::GetTile() argument out of range"));
+	}
+	return tiles[x][y][z];
+}
+
+bool Region::SetSolid(int x, int y, bool b) {
+	if (x < 0 || y < 0 || x >= REGION_WIDTH || y >= REGION_HEIGHT) {
+		throw(std::out_of_range("Region::SetSolid() argument out of range"));
+	}
+	return solid[x * REGION_WIDTH + y] = b;
+}
+
+bool Region::GetSolid(int x, int y) const {
+	if (x < 0 || y < 0 || x >= REGION_WIDTH || y >= REGION_HEIGHT) {
+		throw(std::out_of_range("Region::GetSolid() argument out of range"));
+	}
+	return solid[x * REGION_WIDTH + y];
+}
+
+int Region::GetX() const {
+	return x;
+}
+
+int Region::GetY() const {
+	return y;
+}
+
+std::bitset<REGION_WIDTH*REGION_HEIGHT>* Region::GetSolidBitset() {
+	return &solid;
+}

common/map/region.hpp

@@ -0,0 +1,62 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include <bitset>
+
+//the region's storage format
+constexpr int REGION_WIDTH = 20;
+constexpr int REGION_HEIGHT = 20;
+constexpr int REGION_DEPTH = 3;
+
+//utility function
+int snapToBase(int base, int x);
+
+class Region {
+public:
+	typedef unsigned char type_t;
+
+	Region() = delete;
+	Region(int x, int y);
+	Region(Region const&);
+	~Region() = default;
+
+	type_t SetTile(int x, int y, int z, type_t v);
+	type_t GetTile(int x, int y, int z);
+
+	bool SetSolid(int x, int y, bool b);
+	bool GetSolid(int x, int y) const;
+
+	//accessors
+	int GetX() const;
+	int GetY() const;
+
+	std::bitset<REGION_WIDTH*REGION_HEIGHT>* GetSolidBitset();
+private:
+	friend class TileSheet;
+
+	const int x;
+	const int y;
+
+	type_t tiles[REGION_WIDTH][REGION_HEIGHT][REGION_DEPTH];
+	std::bitset<REGION_WIDTH*REGION_HEIGHT> solid;
+};

common/map/region_api.cpp

@@ -0,0 +1,99 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "region_api.hpp"
+
+#include "region.hpp"
+
+static int setTile(lua_State* L) {
+	Region* region = reinterpret_cast<Region*>(lua_touserdata(L, 1));
+	int ret = region->SetTile(lua_tointeger(L, 2)-1, lua_tointeger(L, 3)-1, lua_tointeger(L, 4)-1, lua_tointeger(L, 5));
+	lua_pushinteger(L, ret);
+	return 1;
+}
+
+static int getTile(lua_State* L) {
+	Region* region = reinterpret_cast<Region*>(lua_touserdata(L, 1));
+	int ret = region->GetTile(lua_tointeger(L, 2)-1, lua_tointeger(L, 3)-1, lua_tointeger(L, 4)-1);
+	lua_pushinteger(L, ret);
+	return 1;
+}
+
+static int setSolid(lua_State* L) {
+	Region* region = reinterpret_cast<Region*>(lua_touserdata(L, 1));
+	bool ret = region->SetSolid(lua_tointeger(L, 2)-1, lua_tointeger(L, 3)-1, lua_toboolean(L, 4));
+	lua_pushboolean(L, ret);
+	return 1;
+}
+
+static int getSolid(lua_State* L) {
+	Region* region = reinterpret_cast<Region*>(lua_touserdata(L, 1));
+	bool ret = region->GetSolid(lua_tointeger(L, 2)-1, lua_tointeger(L, 3)-1);
+	lua_pushboolean(L, ret);
+	return 1;
+}
+
+static int getX(lua_State* L) {
+	Region* region = reinterpret_cast<Region*>(lua_touserdata(L, 1));
+	lua_pushinteger(L, region->GetX());
+	return 1;
+}
+
+static int getY(lua_State* L) {
+	Region* region = reinterpret_cast<Region*>(lua_touserdata(L, 1));
+	lua_pushinteger(L, region->GetY());
+	return 1;
+}
+
+static int getWidth(lua_State* L) {
+	lua_pushinteger(L, REGION_WIDTH);
+	return 1;
+}
+
+static int getHeight(lua_State* L) {
+	lua_pushinteger(L, REGION_HEIGHT);
+	return 1;
+}
+
+static int getDepth(lua_State* L) {
+	lua_pushinteger(L, REGION_DEPTH);
+	return 1;
+}
+
+static const luaL_Reg regionLib[] = {
+	{"SetTile",setTile},
+	{"GetTile",getTile},
+	{"SetSolid",setSolid},
+	{"GetSolid",getSolid},
+	{"GetX",getX},
+	{"GetY",getY},
+
+	//the global macros
+	{"GetWidth",getWidth},
+	{"GetHeight",getHeight},
+	{"GetDepth",getDepth},
+	{nullptr, nullptr}
+};
+
+LUAMOD_API int openRegionAPI(lua_State* L) {
+	luaL_newlib(L, regionLib);
+	return 1;
+}

common/map/region_api.hpp

@@ -0,0 +1,27 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "lua.hpp"
+
+#define TORTUGA_REGION_API "region"
+LUAMOD_API int openRegionAPI(lua_State* L);

common/map/region_pager_api.cpp

@@ -0,0 +1,172 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "region_pager_api.hpp"
+
+#include "region_pager_lua.hpp"
+#include "region.hpp"
+
+//DOCS: These glue functions simply wrap RegionPagerLua's methods
+//NOTE: zero indexing is used here, but not in the region API
+
+static int setTile(lua_State* L) {
+	RegionPagerLua* pager = reinterpret_cast<RegionPagerLua*>(lua_touserdata(L, 1));
+	int ret = pager->SetTile(lua_tointeger(L, 2), lua_tointeger(L, 3), lua_tointeger(L, 4), lua_tointeger(L, 5));
+	lua_pushinteger(L, ret);
+	return 1;
+}
+
+static int getTile(lua_State* L) {
+	RegionPagerLua* pager = reinterpret_cast<RegionPagerLua*>(lua_touserdata(L, 1));
+	int ret = pager->GetTile(lua_tointeger(L, 2), lua_tointeger(L, 3), lua_tointeger(L, 4));
+	lua_pushinteger(L, ret);
+	return 1;
+}
+
+static int setSolid(lua_State* L) {
+	RegionPagerLua* pager = reinterpret_cast<RegionPagerLua*>(lua_touserdata(L, 1));
+	bool ret = pager->SetSolid(lua_tointeger(L, 2), lua_tointeger(L, 3), lua_toboolean(L, 4));
+	lua_pushboolean(L, ret);
+	return 1;
+}
+
+static int getSolid(lua_State* L) {
+	RegionPagerLua* pager = reinterpret_cast<RegionPagerLua*>(lua_touserdata(L, 1));
+	bool ret = pager->GetSolid(lua_tointeger(L, 2), lua_tointeger(L, 3));
+	lua_pushboolean(L, ret);
+	return 1;
+}
+
+static int getRegion(lua_State* L) {
+	RegionPagerLua* pager = reinterpret_cast<RegionPagerLua*>(lua_touserdata(L, 1));
+	Region* region = pager->GetRegion(lua_tointeger(L, 2), lua_tointeger(L, 3));
+	lua_pushlightuserdata(L, region);
+	return 1;
+}
+
+static int loadRegion(lua_State* L) {
+	RegionPagerLua* pager = reinterpret_cast<RegionPagerLua*>(lua_touserdata(L, 1));
+	Region* region = pager->LoadRegion(lua_tointeger(L, 2), lua_tointeger(L, 3));
+	lua_pushlightuserdata(L, region);
+	return 1;
+}
+
+static int saveRegion(lua_State* L) {
+	RegionPagerLua* pager = reinterpret_cast<RegionPagerLua*>(lua_touserdata(L, 1));
+	Region* region = pager->SaveRegion(lua_tointeger(L, 2), lua_tointeger(L, 3));
+	lua_pushlightuserdata(L, region);
+	return 1;
+}
+
+static int createRegion(lua_State* L) {
+	RegionPagerLua* pager = reinterpret_cast<RegionPagerLua*>(lua_touserdata(L, 1));
+	Region* region = pager->CreateRegion(lua_tointeger(L, 2), lua_tointeger(L, 3));
+	lua_pushlightuserdata(L, region);
+	return 1;
+}
+
+static int unloadRegion(lua_State* L) {
+	RegionPagerLua* pager = reinterpret_cast<RegionPagerLua*>(lua_touserdata(L, 1));
+
+	//two argument types: coords & the region itself
+	switch(lua_type(L, 2)) {
+		case LUA_TNUMBER:
+			pager->UnloadIf([&](Region const& region) -> bool {
+				int x = lua_tointeger(L, 2);
+				int y = lua_tointeger(L, 3);
+				return region.GetX() == x && region.GetY() == y;
+			});
+		break;
+		case LUA_TLIGHTUSERDATA:
+			pager->UnloadIf([&](Region const& region) -> bool {
+				return (&region) == lua_touserdata(L, 2);
+			});
+		break;
+	}
+	return 0;
+}
+
+static int setOnLoad(lua_State* L) {
+	RegionPagerLua* pager = reinterpret_cast<RegionPagerLua*>(lua_touserdata(L, 1));
+	luaL_unref(L, LUA_REGISTRYINDEX, pager->GetLoadReference());
+	pager->SetLoadReference(luaL_ref(L, LUA_REGISTRYINDEX));
+	return 0;
+}
+
+static int setOnSave(lua_State* L) {
+	RegionPagerLua* pager = reinterpret_cast<RegionPagerLua*>(lua_touserdata(L, 1));
+	luaL_unref(L, LUA_REGISTRYINDEX, pager->GetSaveReference());
+	pager->SetSaveReference(luaL_ref(L, LUA_REGISTRYINDEX));
+	return 0;
+}
+
+static int setOnCreate(lua_State* L) {
+	RegionPagerLua* pager = reinterpret_cast<RegionPagerLua*>(lua_touserdata(L, 1));
+	luaL_unref(L, LUA_REGISTRYINDEX, pager->GetCreateReference());
+	pager->SetCreateReference(luaL_ref(L, LUA_REGISTRYINDEX));
+	return 0;
+}
+
+static int setOnUnload(lua_State* L) {
+	RegionPagerLua* pager = reinterpret_cast<RegionPagerLua*>(lua_touserdata(L, 1));
+	luaL_unref(L, LUA_REGISTRYINDEX, pager->GetUnloadReference());
+	pager->SetUnloadReference(luaL_ref(L, LUA_REGISTRYINDEX));
+	return 0;
+}
+
+//debugging
+static int containerSize(lua_State* L) {
+	RegionPagerLua* pager = static_cast<RegionPagerLua*>(lua_touserdata(L, 1));
+	lua_pushinteger(L, pager->GetContainer()->size());
+	return 1;
+}
+
+static const luaL_Reg regionPagerLib[] = {
+	//curry
+	{"SetTile", setTile},
+	{"GetTile", getTile},
+	{"SetSolid", setSolid},
+	{"GetSolid", getSolid},
+
+	//access and control
+	{"GetRegion", getRegion},
+	{"LoadRegion", loadRegion},
+	{"SaveRegion", saveRegion},
+	{"CreateRegion", createRegion},
+	{"UnloadRegion", unloadRegion},
+
+	//triggers
+	{"SetOnLoad",setOnLoad},
+	{"SetOnSave",setOnSave},
+	{"SetOnCreate",setOnCreate},
+	{"SetOnUnload",setOnUnload},
+
+	//debugging
+	{"ContainerSize", containerSize},
+
+	//sentinel
+	{nullptr, nullptr}
+};
+
+LUAMOD_API int openRegionPagerAPI(lua_State* L) {
+	luaL_newlib(L, regionPagerLib);
+	return 1;
+}

common/map/region_pager_api.hpp

@@ -0,0 +1,27 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "lua.hpp"
+
+#define TORTUGA_REGION_PAGER_API "region_pager"
+LUAMOD_API int openRegionPagerAPI(lua_State* L);

common/map/region_pager_base.cpp

@@ -0,0 +1,105 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "region_pager_base.hpp"
+
+#include <stdexcept>
+#include <algorithm>
+
+RegionPagerBase::~RegionPagerBase() {
+	UnloadAll();
+};
+
+Region::type_t RegionPagerBase::SetTile(int x, int y, int z, Region::type_t v) {
+	Region* ptr = GetRegion(x, y);
+	return ptr->SetTile(x - ptr->GetX(), y - ptr->GetY(), z, v);
+}
+
+Region::type_t RegionPagerBase::GetTile(int x, int y, int z) {
+	Region* ptr = GetRegion(x, y);
+	return ptr->GetTile(x - ptr->GetX(), y - ptr->GetY(), z);
+}
+
+bool RegionPagerBase::SetSolid(int x, int y, int b) {
+	Region* ptr = GetRegion(x, y);
+	return ptr->SetSolid(x - ptr->GetX(), y - ptr->GetY(), b);
+}
+
+bool RegionPagerBase::GetSolid(int x, int y) {
+	Region* ptr = GetRegion(x, y);
+	return ptr->GetSolid(x - ptr->GetX(), y - ptr->GetY());
+}
+
+Region* RegionPagerBase::GetRegion(int x, int y) {
+	x = snapToBase(REGION_WIDTH, x);
+	y = snapToBase(REGION_HEIGHT, y);
+
+	//get the region by various means
+	Region* ptr = nullptr;
+	ptr = FindRegion(x, y);
+	if (ptr) return ptr;
+	ptr = LoadRegion(x, y);
+	if (ptr) return ptr;
+	return CreateRegion(x, y);
+}
+
+Region* RegionPagerBase::FindRegion(int x, int y) {
+	//find the region
+	std::list<Region>::iterator it = find_if(regionList.begin(), regionList.end(), [x, y](Region& region) -> bool {
+		return region.GetX() == x && region.GetY() == y;
+	});
+	return it != regionList.end() ? &(*it) : nullptr;
+}
+
+Region* RegionPagerBase::PushRegion(Region* const ptr) {
+	regionList.push_front(*ptr);
+	return &regionList.front();
+}
+
+Region* RegionPagerBase::LoadRegion(int x, int y) {
+	//EMPTY, intended for override
+	return nullptr;
+}
+
+Region* RegionPagerBase::SaveRegion(int x, int y) {
+	//EMPTY, intended for override
+	return nullptr;
+}
+
+Region* RegionPagerBase::CreateRegion(int x, int y) {
+	if (FindRegion(x, y)) {
+		throw(std::logic_error("Cannot overwrite an existing region"));
+	}
+	regionList.emplace_front(x, y);
+	return &regionList.front();
+}
+
+void RegionPagerBase::UnloadIf(std::function<bool(Region const&)> fn) {
+	regionList.remove_if(fn);
+}
+
+void RegionPagerBase::UnloadAll() {
+	regionList.clear();
+}
+
+std::list<Region>* RegionPagerBase::GetContainer() {
+	return &regionList;
+}

common/map/region_pager_base.hpp

@@ -0,0 +1,58 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "region.hpp"
+
+#include <functional>
+#include <list>
+
+class RegionPagerBase {
+public:
+	RegionPagerBase() = default;
+	virtual ~RegionPagerBase();
+
+	//tile manipulation
+	virtual Region::type_t SetTile(int x, int y, int z, Region::type_t v);
+	virtual Region::type_t GetTile(int x, int y, int z);
+
+	//solid manipulation
+	virtual bool SetSolid(int x, int y, int b);
+	virtual bool GetSolid(int x, int y);
+
+	//region manipulation
+	virtual Region* GetRegion(int x, int y);
+	virtual Region* FindRegion(int x, int y);
+	virtual Region* PushRegion(Region* const);
+
+	virtual Region* LoadRegion(int x, int y);
+	virtual Region* SaveRegion(int x, int y);
+	virtual Region* CreateRegion(int x, int y);
+
+	virtual void UnloadIf(std::function<bool(Region const&)> fn);
+	virtual void UnloadAll();
+
+	//accessors & mutators
+	std::list<Region>* GetContainer();
+protected:
+	std::list<Region> regionList;
+};

common/map/region_pager_lua.cpp

@@ -0,0 +1,208 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "region_pager_lua.hpp"
+
+#include <stdexcept>
+
+RegionPagerLua::~RegionPagerLua() {
+	//unload all regions
+	UnloadAll();
+	//clear any stored functions
+	luaL_unref(lua, LUA_REGISTRYINDEX, loadRef);
+	luaL_unref(lua, LUA_REGISTRYINDEX, saveRef);
+	luaL_unref(lua, LUA_REGISTRYINDEX, createRef);
+	luaL_unref(lua, LUA_REGISTRYINDEX, unloadRef);
+}
+
+//return the loaded region, or nullptr on failure
+Region* RegionPagerLua::LoadRegion(int x, int y) {
+	//get the pager's function from the registry
+	lua_rawgeti(lua, LUA_REGISTRYINDEX, loadRef);
+
+	//check if this function is available
+	if (lua_isnil(lua, -1)) {
+		lua_pop(lua, 1);
+		//signal that there is no load function
+		return nullptr;
+	}
+
+	//something to work on
+	Region tmpRegion(x, y);
+	lua_pushlightuserdata(lua, &tmpRegion);
+
+	//call the funtion, 1 arg, 1 return
+	if (lua_pcall(lua, 1, 1, 0) != LUA_OK) {
+		throw(std::runtime_error(std::string() + "Lua error: " + lua_tostring(lua, -1) ));
+	}
+
+	//check the return value, success or failure
+	if (lua_isboolean(lua, -1) && lua_toboolean(lua, -1)) {
+		lua_pop(lua, 1);
+		//push and return the loaded region
+		regionList.push_front(tmpRegion);
+		return &regionList.front();
+	}
+	else {
+		lua_pop(lua, 1);
+		//signal a failure
+		return nullptr;
+	}
+}
+
+//NOTE: this return value seems strange; could replace it with a boolean
+//return the saved region, or nullptr on failure
+Region* RegionPagerLua::SaveRegion(int x, int y) {
+	//get the pager's function from the registry
+	lua_rawgeti(lua, LUA_REGISTRYINDEX, saveRef);
+
+	//check if this function is available
+	if (lua_isnil(lua, -1)) {
+		lua_pop(lua, 1);
+		//signal that the region wasn't saved
+		return nullptr;
+	}
+
+	//find the specified region
+	Region* ptr = FindRegion(x, y);
+	if (!ptr) {
+		lua_pop(lua, 1);
+		//signal that there is no save function
+		return nullptr;
+	}
+	lua_pushlightuserdata(lua, ptr);
+
+	//call the function, 1 arg, 1 return
+	if (lua_pcall(lua, 1, 1, 0) != LUA_OK) {
+		throw(std::runtime_error(std::string() + "Lua error: " + lua_tostring(lua, -1) ));
+	}
+
+	//check the return value, success or failure
+	if (lua_isboolean(lua, -1) && lua_toboolean(lua, -1)) {
+		lua_pop(lua, 1);
+		//return the specified region that was saved
+		return ptr;
+	}
+	else {
+		lua_pop(lua, 1);
+		//signal a failure
+		return nullptr;
+	}
+}
+
+//DOCS: since this method is the last ditch call from GetRegion, it must return a valid region object, even if the create function hasn't been set.
+//return a new region, throwing an error on failure
+Region* RegionPagerLua::CreateRegion(int x, int y) {
+	if (FindRegion(x, y)) {
+		throw(std::logic_error("Cannot overwrite an existing region"));
+	}
+
+	//get the pager's function from the registry
+	lua_rawgeti(lua, LUA_REGISTRYINDEX, createRef);
+
+	//check if this function is available
+	if (lua_isnil(lua, -1)) {
+		lua_pop(lua, 1);
+		//return an empty region object
+		regionList.emplace_front(x, y);
+		return &regionList.front();
+	}
+
+	//something to work on
+	Region tmpRegion(x, y);
+	lua_pushlightuserdata(lua, &tmpRegion);
+
+	//call the function, 1 arg, 0 return
+	if (lua_pcall(lua, 1, 0, 0) != LUA_OK) {
+		throw(std::runtime_error(std::string() + "Lua error: " + lua_tostring(lua, -1) ));
+	}
+
+	//return the new region
+	regionList.push_front(tmpRegion);
+	return &regionList.front();
+}
+
+//no return
+void RegionPagerLua::UnloadIf(std::function<bool(Region const&)> fn) {
+	//get the pager's function from the registry
+	lua_rawgeti(lua, LUA_REGISTRYINDEX, unloadRef);
+
+	//check if this function is available
+	if (lua_isnil(lua, -1)) {
+		lua_pop(lua, 1);
+		//remove the regions anyway
+		regionList.remove_if(fn);
+		return;
+	}
+
+	//run each region through this lambda
+	regionList.remove_if([&](Region& region) -> bool {
+		if (fn(region)) {
+
+			//push a copy of the function onto the stack with the region
+			lua_pushvalue(lua, -1);
+			lua_pushlightuserdata(lua, static_cast<void*>(&region));
+
+			//call the function, 1 arg, 0 return
+			if (lua_pcall(lua, 1, 0, 0) != LUA_OK) {
+				throw(std::runtime_error(std::string() + "Lua error: " + lua_tostring(lua, -1) ));
+			}
+
+			//signal to the container
+			return true;
+		}
+		//signal to the container
+		return false;
+	});
+
+	//pop the base copy of the function
+	lua_pop(lua, 1);
+}
+
+void RegionPagerLua::UnloadAll() {
+	//get the pager's function from the registry
+	lua_rawgeti(lua, LUA_REGISTRYINDEX, unloadRef);
+
+	//check if this function is available
+	if (lua_isnil(lua, -1)) {
+		lua_pop(lua, 1);
+		//remove the regions anyway
+		regionList.clear();
+		return;
+	}
+
+	for (auto& it : regionList) {
+		//push a copy of the function onto the stack with the region
+		lua_pushvalue(lua, -1);
+		lua_pushlightuserdata(lua, &it);
+
+		//call the function, 1 arg, 0 return
+		if (lua_pcall(lua, 1, 0, 0) != LUA_OK) {
+			throw(std::runtime_error(std::string() + "Lua error: " + lua_tostring(lua, -1) ));
+		}
+	}
+
+	//pop the base copy of the function
+	lua_pop(lua, 1);
+
+	//remove from memory
+	regionList.clear();
+}

common/map/region_pager_lua.hpp

@@ -0,0 +1,68 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "region_pager_base.hpp"
+
+#include "lua.hpp"
+
+#include <functional>
+#include <string>
+
+//DOCS: set the lua hook before use
+
+class RegionPagerLua : public RegionPagerBase {
+public:
+	RegionPagerLua() = default;
+	~RegionPagerLua();
+
+	//region manipulation
+	Region* LoadRegion(int x, int y) override;
+	Region* SaveRegion(int x, int y) override;
+	Region* CreateRegion(int x, int y) override;
+
+	void UnloadIf(std::function<bool(Region const&)> fn) override;
+	void UnloadAll() override;
+
+	//accessors & mutators
+	lua_State* SetLuaState(lua_State* L) { return lua = L; }
+	lua_State* GetLuaState() { return lua; }
+
+	//utilities for the API
+	int SetLoadReference(int i) { return loadRef = i; }
+	int SetSaveReference(int i) { return saveRef = i; }
+	int SetCreateReference(int i) { return createRef = i; }
+	int SetUnloadReference(int i) { return unloadRef = i; }
+
+	int GetLoadReference() { return loadRef; }
+	int GetSaveReference() { return saveRef; }
+	int GetCreateReference() { return createRef; }
+	int GetUnloadReference() { return unloadRef; }
+
+protected:
+	lua_State* lua = nullptr;
+
+	int loadRef = LUA_NOREF;
+	int saveRef = LUA_NOREF;
+	int createRef = LUA_NOREF;
+	int unloadRef = LUA_NOREF;
+};

common/map/tile_sheet.cpp

@@ -0,0 +1,124 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "tile_sheet.hpp"
+
+#include <stdexcept>
+
+TileSheet& TileSheet::operator=(TileSheet const& rhs) {
+	//don't screw yourself
+	if (this == &rhs) {
+		return *this;
+	}
+
+	Free();
+
+	//Copy the other TileSheet's stuff
+	texture = rhs.texture;
+	clip = rhs.clip;
+	local = false;
+	countX = rhs.countX;
+	countY = rhs.countY;
+}
+
+TileSheet& TileSheet::operator=(TileSheet&& rhs) {
+	//don't screw yourself
+	if (this == &rhs) {
+		return *this;
+	}
+
+	Free();
+
+	//Copy the other TileSheet's stuff
+	texture = rhs.texture;
+	clip = rhs.clip;
+	local = false;
+	countX = rhs.countX;
+	countY = rhs.countY;
+
+	rhs.texture = nullptr;
+	rhs.clip = {0, 0, 0, 0};
+	rhs.local = false;
+	rhs.countX = 0;
+	rhs.countY = 0;
+}
+
+void TileSheet::Load(SDL_Renderer* renderer, std::string fname, int tileWidth, int tileHeight) {
+	Image::Load(renderer, fname);
+	countX = clip.w / tileWidth;
+	countY = clip.h / tileHeight;
+	clip.w = tileWidth;
+	clip.h = tileHeight;
+}
+
+SDL_Texture* TileSheet::SetTexture(SDL_Texture* ptr, int tileWidth, int tileHeight) {
+	Image::SetTexture(ptr);
+	countX = clip.w / tileWidth;
+	countY = clip.h / tileHeight;
+	clip.w = tileWidth;
+	clip.h = tileHeight;
+}
+
+void TileSheet::Free() {
+	Image::Free();
+	countX = countY = 0;
+}
+
+void TileSheet::DrawLayerTo(SDL_Renderer* const renderer, Region* const region, int layer, int camX, int camY, double scaleX, double scaleY) {
+	//TODO: (2) empty
+}
+
+void TileSheet::DrawRegionTo(SDL_Renderer* const renderer, Region* const region, int camX, int camY, double scaleX, double scaleY) {
+	//NOTE: TileSheet is a friend class of Region
+	//reimplementing DrawTo() to improve performance (less indirection)
+	if (!texture) {
+		throw(std::logic_error("No image texture to draw"));
+	}
+
+	//the local variables
+	SDL_Rect sclip = {0, 0, clip.w, clip.h};
+	SDL_Rect dclip = {0, 0, Uint16(clip.w * scaleX), Uint16(clip.h * scaleY)};
+	Region::type_t tile = 0;
+
+	//for each tile
+	for (register int i = 0; i < REGION_WIDTH; ++i) {
+		for (register int j = 0; j < REGION_HEIGHT; ++j) {
+			for (register int k = 0; k < REGION_DEPTH; ++k) {
+				//get the value to skip expensive lookups
+				tile = region->tiles[i][j][k];
+
+				//0 is invisible
+				if (tile == 0) continue;
+
+				//set the sclip
+				sclip.x = (tile-1) % countX * clip.h;
+				sclip.y = (tile-1) / countX * clip.w;
+
+				//set the dclip
+				dclip.x = ((region->x + i) * clip.w - camX) * scaleX;
+				dclip.y = ((region->y + j) * clip.h - camY) * scaleY;
+
+				//draw
+				SDL_RenderCopy(renderer, texture, &sclip, &dclip);
+			}
+		}
+	}
+}

common/map/tile_sheet.hpp

@@ -0,0 +1,67 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "region.hpp"
+
+#include "image.hpp"
+
+#include <string>
+
+class TileSheet : public Image {
+public:
+	TileSheet() = default;
+	TileSheet(TileSheet const& rhs) { *this = rhs; }
+	TileSheet(TileSheet&& rhs) { *this = std::move(rhs); }
+	TileSheet(SDL_Renderer* r, std::string fn, int tw, int th) { Load(r, fn, tw, th); }
+	TileSheet(SDL_Texture* p, int tw, int th) { SetTexture(p, tw, th); }
+	~TileSheet() = default;
+
+	TileSheet& operator=(TileSheet const&);
+	TileSheet& operator=(TileSheet&&);
+
+	void Load(SDL_Renderer*, std::string fname, int tileWidth, int tileHeight);
+	SDL_Texture* SetTexture(SDL_Texture*, int tileWidth, int tileHeight);
+	void Free() override;
+
+	void DrawLayerTo(SDL_Renderer* const renderer, Region* const region, int layer, int camX, int camY, double scaleX = 1.0, double scaleY = 1.0);
+	void DrawRegionTo(SDL_Renderer* const renderer, Region* const region, int camX, int camY, double scaleX = 1.0, double scaleY = 1.0);
+
+	//accessors
+	//DOCS: Reuse Image::clip for tile sizes
+	int GetCountX() { return countX; }
+	int GetCountY() { return countY; }
+	int GetTileW() { return clip.w; }
+	int GetTileH() { return clip.h; }
+
+protected:
+	int countX = 0, countY = 0;
+
+	using Image::Load;
+	using Image::Create;
+	using Image::SetTexture;
+	using Image::SetClip;
+	using Image::SetClipX;
+	using Image::SetClipY;
+	using Image::SetClipW;
+	using Image::SetClipH;
+};

common/network/makefile

@@ -0,0 +1,29 @@
+#config
+INCLUDES+=. packet_types ../gameplay ../map ../utilities
+LIBS+=
+CXXFLAGS+=-std=c++11 $(addprefix -I,$(INCLUDES))
+
+#source
+CXXSRC=$(wildcard *.cpp)
+
+#objects
+OBJDIR=obj
+OBJ+=$(addprefix $(OBJDIR)/,$(CXXSRC:.cpp=.o))
+
+#targets
+all: $(OBJ) $(OUT)
+	ar -crs $(OUT) $(OBJ)
+	$(MAKE) -C packet_types
+
+$(OBJ): | $(OBJDIR)
+
+$(OUT): | $(OUTDIR)
+
+$(OBJDIR):
+	mkdir $(OBJDIR)
+
+$(OUTDIR):
+	mkdir $(OUTDIR)
+
+$(OBJDIR)/%.o: %.cpp
+	$(CXX) $(CXXFLAGS) -c -o $@ $<

common/network/packet_types/character_packet.cpp

@@ -0,0 +1,80 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "character_packet.hpp"
+
+#include "serial_utility.hpp"
+
+void serializeCharacter(void* buffer, CharacterPacket* packet) {
+	serialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//identify the character
+	serialCopy(&buffer, &packet->characterIndex, sizeof(int));
+	serialCopy(&buffer, packet->handle, PACKET_STRING_SIZE);
+	serialCopy(&buffer, packet->avatar, PACKET_STRING_SIZE);
+
+	//the owner
+	serialCopy(&buffer, &packet->accountIndex, sizeof(int));
+
+	//location
+	serialCopy(&buffer, &packet->roomIndex, sizeof(int));
+
+	serialCopy(&buffer, &packet->origin.x, sizeof(double));
+	serialCopy(&buffer, &packet->origin.y, sizeof(double));
+
+	serialCopy(&buffer, &packet->motion.x, sizeof(double));
+	serialCopy(&buffer, &packet->motion.y, sizeof(double));
+
+	serialCopy(&buffer, &packet->bounds.x, sizeof(int));
+	serialCopy(&buffer, &packet->bounds.y, sizeof(int));
+	serialCopy(&buffer, &packet->bounds.w, sizeof(int));
+	serialCopy(&buffer, &packet->bounds.h, sizeof(int));
+
+	//gameplay components: equipment, items, buffs, debuffs...
+}
+
+void deserializeCharacter(void* buffer, CharacterPacket* packet) {
+	deserialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//identify the character
+	deserialCopy(&buffer, &packet->characterIndex, sizeof(int));
+	deserialCopy(&buffer, packet->handle, PACKET_STRING_SIZE);
+	deserialCopy(&buffer, packet->avatar, PACKET_STRING_SIZE);
+
+	//the owner
+	deserialCopy(&buffer, &packet->accountIndex, sizeof(int));
+
+	//location
+	deserialCopy(&buffer, &packet->roomIndex, sizeof(int));
+
+	deserialCopy(&buffer, &packet->origin.x, sizeof(double));
+	deserialCopy(&buffer, &packet->origin.y, sizeof(double));
+
+	deserialCopy(&buffer, &packet->motion.x, sizeof(double));
+	deserialCopy(&buffer, &packet->motion.y, sizeof(double));
+
+	deserialCopy(&buffer, &packet->bounds.x, sizeof(int));
+	deserialCopy(&buffer, &packet->bounds.y, sizeof(int));
+	deserialCopy(&buffer, &packet->bounds.w, sizeof(int));
+	deserialCopy(&buffer, &packet->bounds.h, sizeof(int));
+
+	//gameplay components: equipment, items, buffs, debuffs...
+}

common/network/packet_types/character_packet.hpp

@@ -0,0 +1,46 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "serial_packet_base.hpp"
+
+#include "bounding_box.hpp"
+#include "vector2.hpp"
+
+struct CharacterPacket : SerialPacketBase {
+	//identify the character
+	int characterIndex;
+	char handle[PACKET_STRING_SIZE];
+	char avatar[PACKET_STRING_SIZE];
+
+	//the owner
+	int accountIndex;
+
+	//location
+	int roomIndex;
+	Vector2 origin;
+	Vector2 motion;
+	BoundingBox bounds;
+};
+
+void serializeCharacter(void* buffer, CharacterPacket* packet);
+void deserializeCharacter(void* buffer, CharacterPacket* packet);

common/network/packet_types/client_packet.cpp

@@ -0,0 +1,40 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "client_packet.hpp"
+
+#include "serial_utility.hpp"
+
+void serializeClient(void* buffer, ClientPacket* packet) {
+	serialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	serialCopy(&buffer, &packet->clientIndex, sizeof(int));
+	serialCopy(&buffer, &packet->accountIndex, sizeof(int));
+	serialCopy(&buffer, packet->username, PACKET_STRING_SIZE);
+}
+
+void deserializeClient(void* buffer, ClientPacket* packet) {
+	deserialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	deserialCopy(&buffer, &packet->clientIndex, sizeof(int));
+	deserialCopy(&buffer, &packet->accountIndex, sizeof(int));
+	deserialCopy(&buffer, packet->username, PACKET_STRING_SIZE);
+}

common/network/packet_types/client_packet.hpp

@@ -0,0 +1,34 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "serial_packet_base.hpp"
+
+struct ClientPacket : SerialPacketBase {
+	int clientIndex;
+	int accountIndex;
+	char username[PACKET_STRING_SIZE];
+	//TODO: (3) password, auth token
+};
+
+void serializeClient(void* buffer, ClientPacket* packet);
+void deserializeClient(void* buffer, ClientPacket* packet);

common/network/packet_types/creature_packet.cpp

@@ -0,0 +1,70 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "creature_packet.hpp"
+
+#include "serial_utility.hpp"
+
+void serializeCreature(void* buffer, CreaturePacket* packet) {
+	serialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//identify the creature
+	serialCopy(&buffer, &packet->creatureIndex, sizeof(int));
+	serialCopy(&buffer, packet->handle, PACKET_STRING_SIZE);
+	serialCopy(&buffer, packet->avatar, PACKET_STRING_SIZE);
+
+	//bounds
+	serialCopy(&buffer, &packet->bounds.x, sizeof(int));
+	serialCopy(&buffer, &packet->bounds.y, sizeof(int));
+	serialCopy(&buffer, &packet->bounds.w, sizeof(int));
+	serialCopy(&buffer, &packet->bounds.h, sizeof(int));
+
+
+	//location
+	serialCopy(&buffer, &packet->roomIndex, sizeof(int));
+	serialCopy(&buffer, &packet->origin.x, sizeof(double));
+	serialCopy(&buffer, &packet->origin.y, sizeof(double));
+	serialCopy(&buffer, &packet->motion.x, sizeof(double));
+	serialCopy(&buffer, &packet->motion.y, sizeof(double));
+}
+
+void deserializeCreature(void* buffer, CreaturePacket* packet) {
+	deserialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//identify the creature
+	deserialCopy(&buffer, &packet->creatureIndex, sizeof(int));
+	deserialCopy(&buffer, packet->handle, PACKET_STRING_SIZE);
+	deserialCopy(&buffer, packet->avatar, PACKET_STRING_SIZE);
+
+	//bounds
+	deserialCopy(&buffer, &packet->bounds.x, sizeof(int));
+	deserialCopy(&buffer, &packet->bounds.y, sizeof(int));
+	deserialCopy(&buffer, &packet->bounds.w, sizeof(int));
+	deserialCopy(&buffer, &packet->bounds.h, sizeof(int));
+
+
+	//location
+	deserialCopy(&buffer, &packet->roomIndex, sizeof(int));
+	deserialCopy(&buffer, &packet->origin.x, sizeof(double));
+	deserialCopy(&buffer, &packet->origin.y, sizeof(double));
+	deserialCopy(&buffer, &packet->motion.x, sizeof(double));
+	deserialCopy(&buffer, &packet->motion.y, sizeof(double));
+}

common/network/packet_types/creature_packet.hpp

@@ -0,0 +1,43 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "serial_packet_base.hpp"
+
+#include "bounding_box.hpp"
+#include "vector2.hpp"
+
+struct CreaturePacket : SerialPacketBase {
+	//identify the creature
+	int creatureIndex;
+	char handle[PACKET_STRING_SIZE];
+	char avatar[PACKET_STRING_SIZE];
+	BoundingBox bounds;
+
+	//location
+	int roomIndex;
+	Vector2 origin;
+	Vector2 motion;
+};
+
+void serializeCreature(void* buffer, CreaturePacket* packet);
+void deserializeCreature(void* buffer, CreaturePacket* packet);

common/network/packet_types/makefile

@@ -0,0 +1,28 @@
+#config
+INCLUDES+=. .. ../../gameplay ../../map ../../utilities
+LIBS+=
+CXXFLAGS+=-std=c++11 $(addprefix -I,$(INCLUDES))
+
+#source
+CXXSRC=$(wildcard *.cpp)
+
+#objects
+OBJDIR=obj
+OBJ+=$(addprefix $(OBJDIR)/,$(CXXSRC:.cpp=.o))
+
+#targets
+all: $(OBJ) $(OUT)
+	ar -crs ../$(OUT) $(OBJ)
+
+$(OBJ): | $(OBJDIR)
+
+$(OUT): | $(OUTDIR)
+
+$(OBJDIR):
+	mkdir $(OBJDIR)
+
+$(OUTDIR):
+	mkdir $(OUTDIR)
+
+$(OBJDIR)/%.o: %.cpp
+	$(CXX) $(CXXFLAGS) -c -o $@ $<

common/network/packet_types/region_packet.cpp

@@ -0,0 +1,79 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "region_packet.hpp"
+
+#include "serial_utility.hpp"
+
+void serializeRegion(void* buffer, RegionPacket* packet) {
+	serialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//format
+	serialCopy(&buffer, &packet->roomIndex, sizeof(int));
+	serialCopy(&buffer, &packet->x, sizeof(int));
+	serialCopy(&buffer, &packet->y, sizeof(int));
+
+	if (packet->type != SerialPacketType::REGION_CONTENT) {
+		return;
+	}
+
+	//tiles
+	for (int i = 0; i < REGION_WIDTH; i++) {
+		for (int j = 0; j < REGION_HEIGHT; j++) {
+			for (int k = 0; k < REGION_DEPTH; k++) {
+				*reinterpret_cast<Region::type_t*>(buffer) = packet->region->GetTile(i, j, k);
+				buffer = reinterpret_cast<char*>(buffer) + sizeof(Region::type_t);
+			}
+		}
+	}
+
+	//solids
+	serialCopy(&buffer, packet->region->GetSolidBitset(), REGION_SOLID_FOOTPRINT);
+}
+
+void deserializeRegion(void* buffer, RegionPacket* packet) {
+	deserialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//format
+	deserialCopy(&buffer, &packet->roomIndex, sizeof(int));
+	deserialCopy(&buffer, &packet->x, sizeof(int));
+	deserialCopy(&buffer, &packet->y, sizeof(int));
+
+	if (packet->type != SerialPacketType::REGION_CONTENT) {
+		return;
+	}
+
+	//an object to work on
+	packet->region = new Region(packet->x, packet->y);
+
+	//tiles
+	for (int i = 0; i < REGION_WIDTH; i++) {
+		for (int j = 0; j < REGION_HEIGHT; j++) {
+			for (int k = 0; k < REGION_DEPTH; k++) {
+				packet->region->SetTile(i, j, k, *reinterpret_cast<Region::type_t*>(buffer));
+				buffer = reinterpret_cast<char*>(buffer) + sizeof(Region::type_t);
+			}
+		}
+	}
+
+	//solids
+	deserialCopy(&buffer, packet->region->GetSolidBitset(), REGION_SOLID_FOOTPRINT);
+}

common/network/packet_types/region_packet.hpp

@@ -0,0 +1,45 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "serial_packet_base.hpp"
+
+#include "region.hpp"
+
+#include <cmath>
+
+//define the memory footprint for the region's members
+constexpr int REGION_TILE_FOOTPRINT = sizeof(Region::type_t) * REGION_WIDTH * REGION_HEIGHT * REGION_DEPTH;
+constexpr int REGION_SOLID_FOOTPRINT = ceil(REGION_WIDTH * REGION_HEIGHT / 8.0);
+constexpr int REGION_METADATA_FOOTPRINT = sizeof(int) * 3;
+
+struct RegionPacket : SerialPacketBase {
+	//location/identify the region
+	int roomIndex;
+	int x, y;
+
+	//the data
+	Region* region;
+};
+
+void serializeRegion(void* buffer, RegionPacket* packet);
+void deserializeRegion(void* buffer, RegionPacket* packet);

common/network/packet_types/serial_packet_base.cpp

@@ -0,0 +1,24 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "serial_packet_base.hpp"
+
+//sanity check

common/network/packet_types/serial_packet_base.hpp

@@ -0,0 +1,36 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "serial_packet_type.hpp"
+
+#include "SDL2/SDL_net.h"
+
+constexpr int PACKET_STRING_SIZE = 100;
+
+struct SerialPacketBase {
+	//members
+	SerialPacketType type;
+	IPaddress srcAddress;
+
+	virtual ~SerialPacketBase() {};
+};

common/network/packet_types/server_packet.cpp

@@ -0,0 +1,42 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "server_packet.hpp"
+
+#include "serial_utility.hpp"
+
+void serializeServer(void* buffer, ServerPacket* packet) {
+	serialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//identify the server
+	serialCopy(&buffer, &packet->version, sizeof(int));
+	serialCopy(&buffer, packet->name, PACKET_STRING_SIZE);
+	serialCopy(&buffer, &packet->playerCount, sizeof(int));
+}
+
+void deserializeServer(void* buffer, ServerPacket* packet) {
+	deserialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//identify the server
+	deserialCopy(&buffer, &packet->version, sizeof(int));
+	deserialCopy(&buffer, packet->name, PACKET_STRING_SIZE);
+	deserialCopy(&buffer, &packet->playerCount, sizeof(int));
+}

common/network/packet_types/server_packet.hpp

@@ -0,0 +1,34 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "serial_packet_base.hpp"
+
+struct ServerPacket : SerialPacketBase {
+	//identify the server
+	char name[PACKET_STRING_SIZE];
+	int playerCount;
+	int version;
+};
+
+void serializeServer(void* buffer, ServerPacket* packet);
+void deserializeServer(void* buffer, ServerPacket* packet);

common/network/packet_types/text_packet.cpp

@@ -0,0 +1,52 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "text_packet.hpp"
+
+#include "serial_utility.hpp"
+
+void serializeText(void* buffer, TextPacket* packet) {
+	serialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//content
+	serialCopy(&buffer, packet->name, PACKET_STRING_SIZE);
+	serialCopy(&buffer, packet->text, PACKET_STRING_SIZE);
+
+	//location
+	serialCopy(&buffer, &packet->roomIndex, sizeof(int));
+	serialCopy(&buffer, &packet->origin.x, sizeof(double));
+	serialCopy(&buffer, &packet->origin.y, sizeof(double));
+	serialCopy(&buffer, &packet->range, sizeof(int));
+}
+
+void deserializeText(void* buffer, TextPacket* packet) {
+	deserialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//content
+	deserialCopy(&buffer, packet->name, PACKET_STRING_SIZE);
+	deserialCopy(&buffer, packet->text, PACKET_STRING_SIZE);
+
+	//location
+	deserialCopy(&buffer, &packet->roomIndex, sizeof(int));
+	deserialCopy(&buffer, &packet->origin.x, sizeof(double));
+	deserialCopy(&buffer, &packet->origin.y, sizeof(double));
+	deserialCopy(&buffer, &packet->range, sizeof(int));
+}

common/network/packet_types/text_packet.hpp

@@ -0,0 +1,37 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "serial_packet_base.hpp"
+
+#include "vector2.hpp"
+
+struct TextPacket : SerialPacketBase {
+	char name[PACKET_STRING_SIZE];
+	char text[PACKET_STRING_SIZE];
+	int roomIndex;
+	Vector2 origin;
+	int range;
+};
+
+void serializeText(void* buffer, TextPacket* packet);
+void deserializeText(void* buffer, TextPacket* packet);

common/network/serial_packet.hpp

@@ -0,0 +1,63 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "serial_packet_base.hpp"
+#include "character_packet.hpp"
+#include "client_packet.hpp"
+#include "creature_packet.hpp"
+#include "region_packet.hpp"
+#include "server_packet.hpp"
+#include "text_packet.hpp"
+
+//SerialPacketBase is defined in serial_packet_base.hpp
+typedef SerialPacketBase SerialPacket;
+
+//DOCS: NETWORK_VERSION is used to discern compatible servers and clients
+constexpr int NETWORK_VERSION = 20160321;
+
+union MaxPacket {
+	CharacterPacket a;
+	ClientPacket b;
+	CreaturePacket c;
+	RegionPacket d;
+	ServerPacket e;
+	TextPacket f;
+};
+
+constexpr int MAX_PACKET_SIZE = sizeof(MaxPacket);
+
+/* DOCS: PACKET_BUFFER_SIZE is the memory required to store serialized data
+ * DOCS: SerialPacketType::REGION_CONTENT is currently the largest packet type
+ * Serialized RegionPacket structure:
+ *     SerialPacketType
+ *     room index (int)
+ *     X & Y position (int)
+ *     tile data (3 layers)
+ *     solid data (bitset)
+*/
+
+constexpr int PACKET_BUFFER_SIZE =
+	sizeof(SerialPacketType) +
+	REGION_METADATA_FOOTPRINT +
+	REGION_TILE_FOOTPRINT +
+	REGION_SOLID_FOOTPRINT;

common/network/serial_packet_type.hpp

@@ -0,0 +1,173 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+/* DOCS: The headers indicate what packet type is used for each message
+ * different messages under the same header will carry different amounts of
+ * valid data, but it will still be carried in that packet's format.
+ * FORMAT_* is for internal use, deviding the different format bounds.
+*/
+
+enum class SerialPacketType {
+	//default: there is something wrong
+	NONE = 0,
+
+	//-------------------------
+	//ServerPacket
+	//  name, player count, version
+	//-------------------------
+
+	FORMAT_SERVER = 100,
+
+	//heartbeat
+	PING = 101,
+	PONG = 102,
+
+	//Used for finding available servers
+	BROADCAST_REQUEST = 103,
+	BROADCAST_RESPONSE = 104,
+
+	FORMAT_END_SERVER = 199,
+
+	//-------------------------
+	//ClientPacket
+	//  client index, account index, username
+	//-------------------------
+
+	FORMAT_CLIENT = 200,
+
+	//Connecting to a server as a client
+	JOIN_REQUEST = 201,
+	JOIN_RESPONSE = 202,
+
+	//disconnect from the server
+	DISCONNECT_REQUEST = 203,
+	DISCONNECT_RESPONSE = 204,
+	ADMIN_DISCONNECT_FORCED = 205,
+
+	//load the account
+	LOGIN_REQUEST = 206,
+	LOGIN_RESPONSE = 207,
+
+	//unload the account
+	LOGOUT_REQUEST = 208,
+	LOGOUT_RESPONSE = 209,
+
+	//shut down the server
+	ADMIN_SHUTDOWN_REQUEST = 210,
+
+	FORMAT_END_CLIENT = 299,
+
+	//-------------------------
+	//RegionPacket
+	//  room index, x, y, raw data
+	//-------------------------
+
+	FORMAT_REGION = 300,
+
+	//map data
+	REGION_REQUEST = 301,
+	REGION_CONTENT = 302,
+
+	FORMAT_END_REGION = 399,
+
+	//-------------------------
+	//CharacterPacket
+	//  character index,
+	//  handle, avatar,
+	//  account index (owner),
+	//  room index, origin, motion
+	//-------------------------
+
+	FORMAT_CHARACTER = 400,
+
+	//full data update
+	CHARACTER_UPDATE = 401,
+
+	//character management
+	CHARACTER_CREATE = 402,
+	CHARACTER_DELETE = 403,
+	CHARACTER_LOAD = 404,
+	CHARACTER_UNLOAD = 405,
+
+	//find out info from the server
+	QUERY_CHARACTER_EXISTS = 406,
+
+	//actions taken
+	CHARACTER_MOVEMENT = 407,
+
+	FORMAT_END_CHARACTER = 499,
+
+	//-------------------------
+	//CreaturePacket
+	//  creature index,
+	//  handle, avatar
+	//  bounds
+	//  room index, origin, motion
+	//-------------------------
+
+	FORMAT_CREATURE = 500,
+
+	//full data update
+	CREATURE_UPDATE = 501,
+
+	//character management
+	CREATURE_CREATE = 502,
+	CREATURE_UNLOAD = 503,
+
+	//find out info from the server
+	QUERY_CREATURE_EXISTS = 504,
+
+	//actions taken
+	CREATURE_MOVEMENT = 505,
+
+	FORMAT_END_CREATURE = 599,
+
+	//-------------------------
+	//TextPacket
+	//  name, text
+	//-------------------------
+
+	FORMAT_TEXT = 600,
+
+	//general speech
+	TEXT_BROADCAST = 601,
+	TEXT_SPEECH = 602,
+	TEXT_WHISPER = 603,
+
+	//rejection/error messages
+	JOIN_REJECTION = 604,
+	LOGIN_REJECTION = 605,
+	REGION_REJECTION = 606,
+	CHARACTER_REJECTION = 607,
+	CREATURE_REJECTION = 608,
+	SHUTDOWN_REJECTION = 609,
+	QUERY_REJECTION = 610,
+
+	FORMAT_END_TEXT = 699,
+
+	//-------------------------
+	//not used
+	//-------------------------
+
+	LAST = 700
+};

common/network/serial_utility.cpp

@@ -0,0 +1,105 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "serial_utility.hpp"
+
+//packet types
+#include "character_packet.hpp"
+#include "client_packet.hpp"
+#include "creature_packet.hpp"
+#include "region_packet.hpp"
+#include "server_packet.hpp"
+#include "text_packet.hpp"
+
+#include <cstring>
+
+//macros
+#define BOUNDS(type, lower, upper) ((type) > (lower) && (type) < (upper))
+
+//raw memory copy
+void serialCopy(void** buffer, void* data, int size) {
+	memcpy(*buffer, data, size);
+	*buffer = reinterpret_cast<char*>(*buffer) + size;
+}
+
+void deserialCopy(void** buffer, void* data, int size) {
+	memcpy(data, *buffer, size);
+	*buffer = reinterpret_cast<char*>(*buffer) + size;
+}
+
+//DOCS: The server and client MUST use the correct packet types
+
+//main switch functions
+void serializePacket(void* buffer, SerialPacketBase* packet) {
+	if (BOUNDS(packet->type, SerialPacketType::FORMAT_SERVER, SerialPacketType::FORMAT_END_SERVER)) {
+		serializeServer(buffer, static_cast<ServerPacket*>(packet));
+	}
+
+	if (BOUNDS(packet->type, SerialPacketType::FORMAT_CLIENT, SerialPacketType::FORMAT_END_CLIENT)) {
+		serializeClient(buffer, static_cast<ClientPacket*>(packet));
+	}
+
+	if (BOUNDS(packet->type, SerialPacketType::FORMAT_REGION, SerialPacketType::FORMAT_END_REGION)) {
+		serializeRegion(buffer, static_cast<RegionPacket*>(packet));
+	}
+
+	if (BOUNDS(packet->type, SerialPacketType::FORMAT_CHARACTER, SerialPacketType::FORMAT_END_CHARACTER)) {
+		serializeCharacter(buffer, static_cast<CharacterPacket*>(packet));
+	}
+
+	if (BOUNDS(packet->type, SerialPacketType::FORMAT_CREATURE, SerialPacketType::FORMAT_END_CREATURE)) {
+		serializeCreature(buffer, static_cast<CreaturePacket*>(packet));
+	}
+
+	if (BOUNDS(packet->type, SerialPacketType::FORMAT_TEXT, SerialPacketType::FORMAT_END_TEXT)) {
+		serializeText(buffer, static_cast<TextPacket*>(packet));
+	}
+}
+
+void deserializePacket(void* buffer, SerialPacketBase* packet) {
+	//find the type, so that you can actually deserialize the packet!
+	SerialPacketType type;
+	memcpy(&type, buffer, sizeof(SerialPacketType));
+
+	if (BOUNDS(type, SerialPacketType::FORMAT_SERVER, SerialPacketType::FORMAT_END_SERVER)) {
+		deserializeServer(buffer, static_cast<ServerPacket*>(packet));
+	}
+
+	if (BOUNDS(type, SerialPacketType::FORMAT_CLIENT, SerialPacketType::FORMAT_END_CLIENT)) {
+		deserializeClient(buffer, static_cast<ClientPacket*>(packet));
+	}
+
+	if (BOUNDS(type, SerialPacketType::FORMAT_REGION, SerialPacketType::FORMAT_END_REGION)) {
+		deserializeRegion(buffer, static_cast<RegionPacket*>(packet));
+	}
+
+	if (BOUNDS(type, SerialPacketType::FORMAT_CHARACTER, SerialPacketType::FORMAT_END_CHARACTER)) {
+		deserializeCharacter(buffer, static_cast<CharacterPacket*>(packet));
+	}
+
+	if (BOUNDS(type, SerialPacketType::FORMAT_CREATURE, SerialPacketType::FORMAT_END_CREATURE)) {
+		deserializeCreature(buffer, static_cast<CreaturePacket*>(packet));
+	}
+
+	if (BOUNDS(type, SerialPacketType::FORMAT_TEXT, SerialPacketType::FORMAT_END_TEXT)) {
+		deserializeText(buffer, static_cast<TextPacket*>(packet));
+	}
+}

common/network/serial_utility.hpp

@@ -0,0 +1,34 @@
+/* Copyright: (c) Kayne Ruse 2013-2015
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#pragma once
+
+#include "serial_packet_base.hpp"
+
+#include <cstring>
+
+//raw memory copy
+void serialCopy(void** buffer, void* data, int size);
+void deserialCopy(void** buffer, void* data, int size);
+
+//primary functions
+void serializePacket(void* buffer, SerialPacketBase* packet);
+void deserializePacket(void* buffer, SerialPacketBase* packet);