That didn't go as well as I'd hoped

Conflicts:
	todo.txt

.gitignore

@@ -9,10 +9,6 @@
 Release/
 Debug/
 Out/
-release/
-debug/
-out/
-bin/
 
 #Project generated files
 *.db

.gitmodules

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

README.md

@@ -0,0 +1,41 @@
+## Outline
+
+Tortuga is a 2D multiplayer JRPG 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 amd 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.rar).
+
+## Documentation
+
+* [Tortuga Wiki](https://github.com/Ratstail91/Tortuga/wiki) - Full documentation
+* [Tortuga Bug Tracker](https://github.com/Ratstail91/Tortuga/issues) - A list of all known bugs and issues
+
+## External Dependencies
+
+* [SDL 1.2](http://www.libsdl.org/) - Simple DirectMedia Layer API
+* [SDL_net 1.2](http://www.libsdl.org/projects/SDL_net/) - SDL's networking extension
+* [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/) - The best compression tool available IMO; only needed for distribution
+
+## 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-2015 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.

README.txt

@@ -0,0 +1,35 @@
+This is the README for Tortuga's demo build. The source code is available at:
+
+   https://github.com/Ratstail91/Tortuga
+
+The current build may have bugs, missing features, bugs masquerading as
+features, etc. You can report a bug/feature here:
+
+   https://github.com/Ratstail91/Tortuga/issues
+
+Please note that this game requires a functioning server to operate correctly.
+Both a game server and game client are included in this package.
+
+-------------------------
+Instructions For Setup
+-------------------------
+
+1. To create a server, simply run server.exe
+	(a public server is provided by default)
+2. To join a server, your player information must be input into rsc/config.cfg
+	(NOTE: This process will be streamlined later)
+3. To change the config settings, open rsc/config.cfg
+4. These settings must be unique for each player:
+
+* client.username
+* client.handle
+
+5. There are currently two options for 'client.avatar':
+
+* client.avatar = elliot2.bmp #male
+* client.avatar = coa2.bmp    #female
+
+6. When you've correctly set these values, run client.exe, and select 'Start'
+	from the main menu; this displays the list of available servers.
+7. Select the name of a server (default is 'Public') and select 'Join'.
+8. Welcome to Tortuga, enjoy your stay.

client/base_scene.cpp

@@ -0,0 +1,140 @@
+/* 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"
+
+#include <stdexcept>
+
+//-------------------------
+//Static declarations
+//-------------------------
+
+SDL_Surface* BaseScene::screen = nullptr;
+
+//-------------------------
+//Public access members
+//-------------------------
+
+BaseScene::BaseScene() {
+	//
+}
+
+BaseScene::~BaseScene() {
+	//
+}
+
+//-------------------------
+//Program control
+//-------------------------
+
+SDL_Surface* BaseScene::SetScreen(int w, int h, int bpp, Uint32 flags) {
+	if (!bpp) {
+		bpp = SDL_GetVideoInfo()->vfmt->BitsPerPixel;
+	}
+
+	screen = SDL_SetVideoMode(w, h, bpp, flags);
+
+	if (!screen) {
+		throw(std::runtime_error("Failed to create the screen surface"));
+	}
+
+	return screen;
+}
+
+SDL_Surface* BaseScene::GetScreen() {
+	return screen;
+}
+
+SceneList BaseScene::SetNextScene(SceneList sceneIndex) {
+	return nextScene = sceneIndex;
+}
+
+SceneList BaseScene::GetNextScene() const {
+	return nextScene;
+}
+
+//-------------------------
+//Frame loop
+//-------------------------
+
+void BaseScene::RunFrame() {
+	FrameStart();
+	HandleEvents();
+	Update();
+	FrameEnd();
+}
+
+void BaseScene::RenderFrame() {
+	SDL_FillRect(screen, 0, 0);
+	Render(screen);
+	SDL_Flip(screen);
+	SDL_Delay(10);
+}
+
+//-------------------------
+//Event handlers
+//-------------------------
+
+void BaseScene::HandleEvents() {
+	SDL_Event event;
+
+	while(SDL_PollEvent(&event)) {
+		switch(event.type) {
+			case SDL_QUIT:
+				QuitEvent();
+			break;
+
+			case SDL_VIDEORESIZE:
+				SetScreen(event.resize.w, event.resize.h, 0, screen->flags);
+			break;
+
+			case SDL_MOUSEMOTION:
+				MouseMotion(event.motion);
+			break;
+
+			case SDL_MOUSEBUTTONDOWN:
+				MouseButtonDown(event.button);
+			break;
+
+			case SDL_MOUSEBUTTONUP:
+				MouseButtonUp(event.button);
+			break;
+
+			case SDL_KEYDOWN:
+				KeyDown(event.key);
+			break;
+
+			case SDL_KEYUP:
+				KeyUp(event.key);
+			break;
+
+#ifdef USE_EVENT_JOYSTICK
+			//TODO: joystick/gamepad support
+#endif
+
+#ifdef USE_EVENT_UNKNOWN
+			default:
+				UnknownEvent(event);
+			break;
+#endif
+		}//switch
+	}//while
+}

client/base_scene.hpp

@@ -0,0 +1,74 @@
+/* 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.
+*/
+#ifndef BASESCENE_HPP_
+#define BASESCENE_HPP_
+
+#include "scene_list.hpp"
+
+#include "SDL/SDL.h"
+
+class BaseScene {
+public:
+	//Public access members
+	BaseScene();
+	virtual ~BaseScene();
+
+	//Program control
+	static SDL_Surface* SetScreen(int w, int h, int bpp = 0, Uint32 flags = SDL_HWSURFACE|SDL_DOUBLEBUF);
+	static SDL_Surface* GetScreen();
+
+	SceneList SetNextScene(SceneList sceneIndex);
+	SceneList GetNextScene() const;
+
+	//Frame loop
+	virtual void RunFrame();
+	virtual void RenderFrame();
+
+protected:
+	virtual void FrameStart() {}
+	virtual void HandleEvents();
+	virtual void Update() {}
+	virtual void FrameEnd() {}
+	virtual void Render(SDL_Surface* const screen) {}
+
+	//Event handlers
+	virtual void QuitEvent() { SetNextScene(SceneList::QUIT); }
+	virtual void MouseMotion(SDL_MouseMotionEvent const&) {}
+	virtual void MouseButtonDown(SDL_MouseButtonEvent const&) {}
+	virtual void MouseButtonUp(SDL_MouseButtonEvent const&) {}
+	virtual void KeyDown(SDL_KeyboardEvent const&) {}
+	virtual void KeyUp(SDL_KeyboardEvent const&) {}
+
+#ifdef USE_EVENT_JOYSTICK
+	//TODO: joystick/gamepad support
+#endif
+
+#ifdef USE_EVENT_UNKNOWN
+	virtual void UnknownEvent(SDL_Event const&) {}
+#endif
+
+private:
+	static SDL_Surface* screen;
+	SceneList nextScene = SceneList::CONTINUE;
+};
+
+#endif

client/channels.hpp

@@ -1,4 +1,4 @@
-/* Copyright: (c) Kayne Ruse 2015
+/* 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
@@ -19,14 +19,11 @@
  * 3. This notice may not be removed or altered from any source
  * distribution.
 */
-#pragma once
+#ifndef CHANNELS_HPP_
+#define CHANNELS_HPP_
 
-enum SceneSignal {
-	//reserved members for internal use
-	QUIT = -1,
-	CONTINUE = 0,
-	FIRST = 1,
+enum Channels {
+	SERVER = 0
+};
 
-	//custom scenes
-	EXAMPLE_SCENE
-};
+#endif

client/client_application.cpp

@@ -0,0 +1,203 @@
+/* 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"
+
+#include <stdexcept>
+#include <chrono>
+#include <iostream>
+
+//-------------------------
+//Scene headers
+//-------------------------
+
+//Add the custom scene headers here
+#include "splash_screen.hpp"
+#include "main_menu.hpp"
+#include "options_menu.hpp"
+#include "lobby_menu.hpp"
+#include "in_world.hpp"
+#include "disconnected_screen.hpp"
+
+//-------------------------
+//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 the APIs
+	//-------------------------
+
+	//initialize SDL
+	if (SDL_Init(SDL_INIT_VIDEO)) {
+		throw(std::runtime_error("Failed to initialize SDL"));
+	}
+	std::cout << "Initialized SDL" << std::endl;
+
+	//initialize SDL_net
+	if (SDLNet_Init()) {
+		throw(std::runtime_error("Failed to initialize SDL_net"));
+	}
+	UDPNetworkUtility::GetSingleton().Open(0);
+	std::cout << "Initialized SDL_net" << std::endl;
+
+	//-------------------------
+	//Setup the screen
+	//-------------------------
+
+	int w = config.Int("client.screen.w");
+	int h = config.Int("client.screen.h");
+	int f = config.Bool("client.screen.f") ? SDL_HWSURFACE|SDL_DOUBLEBUF|SDL_FULLSCREEN : SDL_HWSURFACE|SDL_DOUBLEBUF;
+
+	BaseScene::SetScreen(w ? w : 800, h ? h : 600, 0, f);
+	std::cout << "Initialized the screen" << std::endl;
+
+	//-------------------------
+	//debug output
+	//-------------------------
+
+	//TODO: enable/disable these with a switch
+#define DEBUG_OUTPUT_VAR(x) std::cout << "\t" << #x << ": " << x << std::endl;
+
+	std::cout << "Internal sizes:" << std::endl;
+
+	DEBUG_OUTPUT_VAR(NETWORK_VERSION);
+	DEBUG_OUTPUT_VAR(sizeof(Region::type_t));
+	DEBUG_OUTPUT_VAR(sizeof(Region));
+	DEBUG_OUTPUT_VAR(REGION_WIDTH);
+	DEBUG_OUTPUT_VAR(REGION_HEIGHT);
+	DEBUG_OUTPUT_VAR(REGION_DEPTH);
+	DEBUG_OUTPUT_VAR(REGION_TILE_FOOTPRINT);
+	DEBUG_OUTPUT_VAR(REGION_SOLID_FOOTPRINT);
+	DEBUG_OUTPUT_VAR(PACKET_STRING_SIZE);
+	DEBUG_OUTPUT_VAR(PACKET_BUFFER_SIZE);
+	DEBUG_OUTPUT_VAR(MAX_PACKET_SIZE);
+	DEBUG_OUTPUT_VAR(static_cast<int>(SerialPacketType::LAST));
+
+#undef DEBUG_OUTPUT_VAR
+
+	//-------------------------
+	//finalize the startup
+	//-------------------------
+
+	std::cout << "Startup completed successfully" << std::endl;
+
+	//-------------------------
+	//debugging
+	//-------------------------
+
+	//...
+}
+
+void ClientApplication::Proc() {
+	LoadScene(SceneList::FIRST);
+
+	//prepare the time system
+	typedef std::chrono::steady_clock Clock;
+
+	Clock::time_point simTime = Clock::now();
+	Clock::time_point realTime;
+
+	//The main loop
+	while(activeScene->GetNextScene() != SceneList::QUIT) {
+		//switch scenes when necessary
+		if (activeScene->GetNextScene() != SceneList::CONTINUE) {
+			LoadScene(activeScene->GetNextScene());
+			continue;
+		}
+
+		//update the current time
+		realTime = Clock::now();
+
+		//simulate game time
+		if (simTime < realTime) {
+			while (simTime < realTime) {
+				//call each user defined function
+				activeScene->RunFrame();
+				//~60 FPS
+				simTime += std::chrono::duration<int, std::milli>(16);
+			}
+		}
+		else {
+			//give the machine a break
+			SDL_Delay(10);
+		}
+
+		//draw the game to the screen
+		activeScene->RenderFrame();
+	}
+
+	UnloadScene();
+}
+
+void ClientApplication::Quit() {
+	std::cout << "Shutting down" << std::endl;
+	UDPNetworkUtility::GetSingleton().Close();
+	SDLNet_Quit();
+	SDL_Quit();
+	std::cout << "Clean exit" << std::endl;
+}
+
+//-------------------------
+//Private access members
+//-------------------------
+
+void ClientApplication::LoadScene(SceneList sceneIndex) {
+	UnloadScene();
+	switch(sceneIndex) {
+		//add scene creation calls here
+		case SceneList::FIRST:
+		case SceneList::SPLASHSCREEN:
+			activeScene = new SplashScreen();
+		break;
+		case SceneList::MAINMENU:
+			activeScene = new MainMenu();
+		break;
+		case SceneList::OPTIONSMENU:
+			activeScene = new OptionsMenu();
+		break;
+		case SceneList::LOBBYMENU:
+			activeScene = new LobbyMenu(&clientIndex, &accountIndex);
+		break;
+		case SceneList::INWORLD:
+			activeScene = new InWorld(&clientIndex, &accountIndex);
+		break;
+		case SceneList::DISCONNECTEDSCREEN:
+			activeScene = new DisconnectedScreen();
+		break;
+		default:
+			throw(std::logic_error("Failed to recognize the scene index"));
+	}
+}
+
+void ClientApplication::UnloadScene() {
+	delete activeScene;
+	activeScene = nullptr;
+}

client/client_application.hpp

@@ -1,4 +1,4 @@
-/* Copyright: (c) Kayne Ruse 2015
+/* 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
@@ -19,40 +19,40 @@
  * 3. This notice may not be removed or altered from any source
  * distribution.
 */
-#pragma once
+#ifndef CLIENTAPPLICATION_HPP_
+#define CLIENTAPPLICATION_HPP_
 
+#include "scene_list.hpp"
 #include "base_scene.hpp"
-#include "scene_signal.hpp"
 
-#include "lua.hpp"
-#include "SDL2/SDL.h"
-#include "SDL2/SDL_ttf.h"
+#include "udp_network_utility.hpp"
 
-//TODO: do something with these
-constexpr int screenWidth = 800;
-constexpr int screenHeight = 600;
+#include "singleton.hpp"
 
-//DOCS: The Application class handles scene switching, utilizing only one window
-class Application {
+#include <map>
+
+class ClientApplication: public Singleton<ClientApplication> {
 public:
-	Application() = default;
-	~Application() = default;
-
+	//public methods
 	void Init(int argc, char* argv[]);
 	void Proc();
 	void Quit();
 
 private:
-	//scene management
-	void ProcessEvents();
-	void ProcessSceneSignal(SceneSignal);
-	void ClearScene();
+	friend Singleton<ClientApplication>;
+
+	ClientApplication() = default;
+	~ClientApplication() = default;
+
+	//Private access members
+	void LoadScene(SceneList sceneIndex);
+	void UnloadScene();
 
 	BaseScene* activeScene = nullptr;
 
-	//TODO: build a "window" class?
-	SDL_Window* window = nullptr;
-	SDL_Renderer* renderer = nullptr;
+	//shared parameters
+	int clientIndex = -1;
+	int accountIndex = -1;
+};
 
-	lua_State* lua = nullptr;
-};
+#endif

client/client_utilities/ip_operators.cpp

@@ -0,0 +1,30 @@
+/* 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 "ip_operators.hpp"
+
+bool operator==(IPaddress lhs, IPaddress rhs) {
+	return lhs.host == rhs.host && lhs.port == rhs.port;
+}
+
+bool operator!=(IPaddress lhs, IPaddress rhs) {
+	return !(lhs == rhs);
+}

client/client_utilities/ip_operators.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.
+*/
+#ifndef IPOPERATORS_HPP_
+#define IPOPERATORS_HPP_
+
+#include "SDL/SDL_net.h"
+
+//these should've come standard
+bool operator==(IPaddress lhs, IPaddress rhs);
+bool operator!=(IPaddress lhs, IPaddress rhs);
+
+#endif

client/client_utilities/makefile

@@ -0,0 +1,37 @@
+#config
+INCLUDES+=.
+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 $@ $<
+
+clean:
+	$(RM) *.o *.a *.exe
+
+rebuild: clean all

client/client_utilities/terminal_error.cpp

@@ -0,0 +1,23 @@
+/* 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 "terminal_error.hpp"
+

client/client_utilities/terminal_error.hpp

@@ -1,4 +1,4 @@
-/* Copyright: (c) Kayne Ruse 2015
+/* 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
@@ -19,25 +19,16 @@
  * 3. This notice may not be removed or altered from any source
  * distribution.
 */
-#include "application.hpp"
+#ifndef TERMINALERROR_HPP_
+#define TERMINALERROR_HPP_
 
-#include "SDL2/SDL.h"
-
-#include <iostream>
 #include <stdexcept>
+#include <string>
 
-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;
-}
+class terminal_error: public std::runtime_error {
+public:
+	explicit terminal_error(const std::string& str): runtime_error(str) {}
+	explicit terminal_error(const char* cstr): runtime_error(cstr) {}
+};
+
+#endif

client/entities/base_character.cpp

@@ -0,0 +1,83 @@
+/* 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"
+
+#include "config_utility.hpp"
+
+//-------------------------
+//graphics
+//-------------------------
+
+void BaseCharacter::CorrectSprite() {
+	//NOTE: These must correspond to the sprite sheet in use
+	if (motion.y > 0) {
+		sprite.SetYIndex(0);
+	}
+	else if (motion.y < 0) {
+		sprite.SetYIndex(1);
+	}
+	else if (motion.x > 0) {
+		sprite.SetYIndex(3);
+	}
+	else if (motion.x < 0) {
+		sprite.SetYIndex(2);
+	}
+
+	//animation
+	if (motion != 0) {
+		sprite.SetDelay(0.1);
+	}
+	else {
+		sprite.SetDelay(0);
+		sprite.SetXIndex(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(std::string s) {
+	avatar = s;
+	sprite.LoadSurface(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,55 @@
+/* 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.
+*/
+#ifndef BASECHARACTER_HPP_
+#define BASECHARACTER_HPP_
+
+//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(std::string s);
+	std::string GetAvatar() const;
+
+protected:
+	//metadata
+	int owner;
+	std::string handle;
+	std::string avatar;
+};
+
+#endif

client/entities/base_monster.cpp

@@ -0,0 +1,23 @@
+/* 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_monster.hpp"
+

client/entities/base_monster.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.
+*/
+#ifndef BASEMONSTER_HPP_
+#define BASEMONSTER_HPP_
+
+#include "entity.hpp"
+
+class BaseMonster: public Entity {
+public:
+	BaseMonster() = default;
+	virtual ~BaseMonster() = default;
+
+protected:
+	//
+};
+
+#endif

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_Surface* const dest, int camX, int camY) {
+	sprite.DrawTo(dest, 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,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.
+*/
+#ifndef ENTITY_HPP_
+#define ENTITY_HPP_
+
+#include "bounding_box.hpp"
+#include "sprite_sheet.hpp"
+#include "vector2.hpp"
+
+//The base class for all objects in the world
+class Entity {
+public:
+	virtual void Update();
+	virtual void DrawTo(SDL_Surface* 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;
+};
+
+#endif

client/entities/local_character.cpp

@@ -0,0 +1,76 @@
+/* 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, Uint8* keyState) {
+	//skip this if there's no movement
+	if (motion == 0) {
+		return false;
+	}
+
+	//determine the simple movement based on input
+	Vector2 newMotion = {0, 0};
+	if (keyState[SDLK_w]) {
+		newMotion.y -= CHARACTER_WALKING_SPEED;
+	}
+	if (keyState[SDLK_a]) {
+		newMotion.x -= CHARACTER_WALKING_SPEED;
+	}
+	if (keyState[SDLK_s]) {
+		newMotion.y += CHARACTER_WALKING_SPEED;
+	}
+	if (keyState[SDLK_d]) {
+		newMotion.x += CHARACTER_WALKING_SPEED;
+	}
+
+	bool ret = false;
+
+	for(auto& box : boxList) {
+		if (box.CheckCollision(origin + bounds)) {
+			//push the character to the closest non-contact position
+			Vector2 shift = box.CalcShift(origin + bounds);
+			origin += shift;
+
+			//set any motion in that direction to zero
+			if (shift.x != 0) {
+				newMotion.x = 0;
+			}
+			if (shift.y != 0) {
+				newMotion.y = 0;
+			}
+			ret = true;
+		}
+	}
+
+	//handle diagonals
+	if (newMotion.x != 0 && newMotion.y != 0) {
+		newMotion *= CHARACTER_WALKING_MOD;
+	}
+
+	//set the new motion
+	motion = newMotion;
+
+	//signal for updates
+	return ret;
+}

client/entities/local_character.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.
+*/
+#ifndef LOCALCHARACTER_HPP_
+#define LOCALCHARACTER_HPP_
+
+#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>, Uint8* keyState);
+
+private:
+	//NOTE: NO MEMBERS
+};
+
+#endif

client/entities/makefile

@@ -0,0 +1,37 @@
+#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 $@ $<
+
+clean:
+	$(RM) *.o *.a *.exe
+
+rebuild: clean all

client/gameplay_scenes/in_world.hpp

@@ -0,0 +1,157 @@
+/* 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.
+*/
+#ifndef INWORLD_HPP_
+#define INWORLD_HPP_
+
+//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 "raster_font.hpp"
+#include "button.hpp"
+#include "tile_sheet.hpp"
+
+//common
+#include "frame_rate.hpp"
+
+//client
+#include "base_scene.hpp"
+#include "base_monster.hpp"
+#include "local_character.hpp"
+
+//STL
+#include <map>
+
+#include <chrono>
+
+class InWorld : public BaseScene {
+public:
+	//Public access members
+	InWorld(int* const argClientIndex, int* const argAccountIndex);
+	~InWorld();
+
+protected:
+	//Frame loop
+	void FrameStart();
+	void Update();
+	void FrameEnd();
+	void RenderFrame();
+	void Render(SDL_Surface* const);
+
+	//Event handlers
+	void QuitEvent();
+	void MouseMotion(SDL_MouseMotionEvent const&);
+	void MouseButtonDown(SDL_MouseButtonEvent const&);
+	void MouseButtonUp(SDL_MouseButtonEvent const&);
+	void KeyDown(SDL_KeyboardEvent const&);
+	void KeyUp(SDL_KeyboardEvent const&);
+
+	//Basic connections
+	void HandlePacket(SerialPacket* const);
+	void HandlePing(ServerPacket* const);
+	void HandlePong(ServerPacket* const);
+
+	//Connection control
+	void SendLogoutRequest();
+	void SendDisconnectRequest();
+	void SendShutdownRequest();
+
+	void HandleLogoutResponse(ClientPacket* const);
+	void HandleDisconnectResponse(ClientPacket* const);
+	void HandleDisconnectForced(ClientPacket* const);
+
+	void CheckHeartBeat();
+
+	//map management
+	void SendRegionRequest(int roomIndex, int x, int y);
+	void HandleRegionContent(RegionPacket* const);
+	void UpdateMap();
+
+	//character management
+	void HandleCharacterCreate(CharacterPacket* const);
+	void HandleCharacterDelete(CharacterPacket* const);
+	void HandleCharacterQueryExists(CharacterPacket* const);
+	void HandleCharacterMovement(CharacterPacket* const);
+	void HandleCharacterAttack(CharacterPacket* const);
+
+	//monster management
+	void HandleMonsterCreate(MonsterPacket* const);
+	void HandleMonsterDelete(MonsterPacket* const);
+	void HandleMonsterQueryExists(MonsterPacket* const);
+	void HandleMonsterMovement(MonsterPacket* const);
+	void HandleMonsterAttack(MonsterPacket* const);
+
+	//player movement
+	void ProcessLocalCharacterMovement();
+	void SendLocalCharacterMovement();
+	std::list<BoundingBox> GenerateCollisionGrid(Entity*, int tileWidth, int tileHeight);
+
+	//indexes
+	int& clientIndex;
+	int& accountIndex;
+	int characterIndex = -1;
+	int roomIndex = -1;
+
+	//graphics
+	Image buttonImage;
+	RasterFont font;
+	TileSheet tileSheet;
+
+	//map
+	RegionPagerBase regionPager;
+
+	//UI
+	Button disconnectButton;
+	Button shutDownButton;
+	FrameRate fps;
+
+	//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, BaseMonster> monsterMap;
+	LocalCharacter* localCharacter = nullptr;
+
+	//heartbeat
+	//TODO: 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();
+	Uint8* keyState = nullptr;
+};
+
+#endif

client/gameplay_scenes/in_world_entities.cpp

@@ -0,0 +1,252 @@
+/* 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 "in_world.hpp"
+
+#include "channels.hpp"
+
+#include <iostream>
+#include <sstream>
+#include <stdexcept>
+
+//-------------------------
+//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 InWorld::HandleCharacterCreate(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->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(argPacket->avatar);
+	character->SetOwner(argPacket->accountIndex);
+	character->CorrectSprite();
+
+	//check for this player's character
+	if (character->GetOwner() == accountIndex) {
+		localCharacter = static_cast<LocalCharacter*>(character);
+
+		//focus the camera on this character
+		camera.marginX = (camera.width / 2 - localCharacter->GetSprite()->GetImage()->GetClipW() / 2);
+		camera.marginY = (camera.height/ 2 - localCharacter->GetSprite()->GetImage()->GetClipH() / 2);
+
+		//focus on this character's info
+		characterIndex = argPacket->characterIndex;
+		roomIndex = argPacket->roomIndex;
+	}
+
+	//debug
+	std::cout << "Create, total: " << characterMap.size() << std::endl;
+}
+
+void InWorld::HandleCharacterDelete(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;
+	}
+
+	//remove this character
+	characterMap.erase(characterIt);
+
+	//debug
+	std::cout << "Delete, total: " << characterMap.size() << std::endl;
+}
+
+void InWorld::HandleCharacterQueryExists(CharacterPacket* const argPacket) {
+	//prevent a double message about this player's character
+	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(argPacket->avatar);
+	character->SetOwner(argPacket->accountIndex);
+	character->CorrectSprite();
+
+	//debug
+	std::cout << "Query, total: " << characterMap.size() << std::endl;
+}
+
+void InWorld::HandleCharacterMovement(CharacterPacket* const argPacket) {
+	//TODO: 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();
+	}
+}
+
+void InWorld::HandleCharacterAttack(CharacterPacket* const argPacket) {
+	//TODO: attack animation
+}
+
+//-------------------------
+//monster management
+//-------------------------
+
+void InWorld::HandleMonsterCreate(MonsterPacket* const argPacket) {
+	//TODO
+}
+
+void InWorld::HandleMonsterDelete(MonsterPacket* const argPacket) {
+	//TODO
+}
+
+void InWorld::HandleMonsterQueryExists(MonsterPacket* const argPacket) {
+	//TODO
+}
+
+void InWorld::HandleMonsterMovement(MonsterPacket* const argPacket) {
+	//TODO
+}
+
+void InWorld::HandleMonsterAttack(MonsterPacket* const argPacket) {
+	//TODO
+}
+
+//-------------------------
+//player movement
+//-------------------------
+
+void InWorld::ProcessLocalCharacterMovement() {
+	//character movement
+	if (!localCharacter) {
+		return;
+	}
+
+	Vector2 newMotion = {0, 0};
+	if (keyState[SDLK_w]) {
+		newMotion.y -= CHARACTER_WALKING_SPEED;
+	}
+	if (keyState[SDLK_a]) {
+		newMotion.x -= CHARACTER_WALKING_SPEED;
+	}
+	if (keyState[SDLK_s]) {
+		newMotion.y += CHARACTER_WALKING_SPEED;
+	}
+	if (keyState[SDLK_d]) {
+		newMotion.x += CHARACTER_WALKING_SPEED;
+	}
+
+	//handle diagonals
+	if (newMotion.x != 0 && newMotion.y != 0) {
+		newMotion *= CHARACTER_WALKING_MOD;
+	}
+
+	//set the info
+	if (localCharacter->GetMotion() != newMotion) {
+		localCharacter->SetMotion(newMotion);
+		localCharacter->CorrectSprite();
+		SendLocalCharacterMovement();
+	}
+}
+
+void InWorld::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> InWorld::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
+			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/gameplay_scenes/in_world_networking.cpp

@@ -0,0 +1,264 @@
+/* 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 "in_world.hpp"
+
+#include "channels.hpp"
+#include "ip_operators.hpp"
+#include "terminal_error.hpp"
+
+#include <chrono>
+#include <sstream>
+#include <stdexcept>
+
+//-------------------------
+//Basic connections
+//-------------------------
+
+void InWorld::HandlePacket(SerialPacket* const argPacket) {
+	switch(argPacket->type) {
+		//heartbeat system
+		case SerialPacketType::PING:
+			HandlePing(static_cast<ServerPacket*>(argPacket));
+		break;
+		case SerialPacketType::PONG:
+			HandlePong(static_cast<ServerPacket*>(argPacket));
+		break;
+
+		//game server connections
+		case SerialPacketType::LOGOUT_RESPONSE:
+			HandleLogoutResponse(static_cast<ClientPacket*>(argPacket));
+		break;
+		case SerialPacketType::DISCONNECT_RESPONSE:
+			HandleDisconnectResponse(static_cast<ClientPacket*>(argPacket));
+		break;
+		case SerialPacketType::DISCONNECT_FORCED:
+			HandleDisconnectForced(static_cast<ClientPacket*>(argPacket));
+		break;
+
+		//map management
+		case SerialPacketType::REGION_CONTENT:
+			HandleRegionContent(static_cast<RegionPacket*>(argPacket));
+		break;
+
+		//character management
+		case SerialPacketType::CHARACTER_CREATE:
+			HandleCharacterCreate(static_cast<CharacterPacket*>(argPacket));
+		break;
+		case SerialPacketType::CHARACTER_DELETE:
+			HandleCharacterDelete(static_cast<CharacterPacket*>(argPacket));
+		break;
+		case SerialPacketType::QUERY_CHARACTER_EXISTS:
+			HandleCharacterQueryExists(static_cast<CharacterPacket*>(argPacket));
+		break;
+		case SerialPacketType::CHARACTER_MOVEMENT:
+			HandleCharacterMovement(static_cast<CharacterPacket*>(argPacket));
+		break;
+		case SerialPacketType::CHARACTER_ATTACK:
+			HandleCharacterAttack(static_cast<CharacterPacket*>(argPacket));
+		break;
+
+		//monster management
+		case SerialPacketType::MONSTER_CREATE:
+			HandleMonsterCreate(static_cast<MonsterPacket*>(argPacket));
+		break;
+		case SerialPacketType::MONSTER_DELETE:
+			HandleMonsterDelete(static_cast<MonsterPacket*>(argPacket));
+		break;
+		case SerialPacketType::QUERY_MONSTER_EXISTS:
+			HandleMonsterQueryExists(static_cast<MonsterPacket*>(argPacket));
+		break;
+		case SerialPacketType::MONSTER_MOVEMENT:
+			HandleMonsterMovement(static_cast<MonsterPacket*>(argPacket));
+		break;
+		case SerialPacketType::MONSTER_ATTACK:
+			HandleMonsterAttack(static_cast<MonsterPacket*>(argPacket));
+		break;
+
+		//rejection messages
+		case SerialPacketType::REGION_REJECTION:
+		case SerialPacketType::CHARACTER_REJECTION:
+			throw(terminal_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 InWorld: " << static_cast<int>(argPacket->type);
+			throw(std::runtime_error(msg.str()));
+		}
+		break;
+	}
+}
+
+void InWorld::HandlePing(ServerPacket* const argPacket) {
+	ServerPacket newPacket;
+	newPacket.type = SerialPacketType::PONG;
+	network.SendTo(argPacket->srcAddress, &newPacket);
+}
+
+void InWorld::HandlePong(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();
+}
+
+//-------------------------
+//Connection control
+//-------------------------
+
+void InWorld::SendLogoutRequest() {
+	ClientPacket newPacket;
+
+	//send a logout request
+	newPacket.type = SerialPacketType::LOGOUT_REQUEST;
+	newPacket.accountIndex = accountIndex;
+
+	network.SendTo(Channels::SERVER, &newPacket);
+}
+
+void InWorld::SendDisconnectRequest() {
+	ClientPacket newPacket;
+
+	//send a disconnect request
+	newPacket.type = SerialPacketType::DISCONNECT_REQUEST;
+	newPacket.clientIndex = clientIndex;
+
+	network.SendTo(Channels::SERVER, &newPacket);
+}
+
+void InWorld::SendShutdownRequest() {
+	ClientPacket newPacket;
+
+	//send a shutdown request
+	newPacket.type = SerialPacketType::SHUTDOWN_REQUEST;
+	newPacket.accountIndex = accountIndex;
+
+	network.SendTo(Channels::SERVER, &newPacket);
+}
+
+void InWorld::HandleLogoutResponse(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 InWorld::HandleDisconnectResponse(ClientPacket* const argPacket) {
+	HandleLogoutResponse(argPacket);//shortcut
+	SetNextScene(SceneList::DISCONNECTEDSCREEN);
+	ConfigUtility::GetSingleton()["client.disconnectMessage"] = "You have successfully logged out";
+}
+
+void InWorld::HandleDisconnectForced(ClientPacket* const argPacket) {
+	HandleDisconnectResponse(argPacket);//shortcut
+	SetNextScene(SceneList::DISCONNECTEDSCREEN);
+	ConfigUtility::GetSingleton()["client.disconnectMessage"] = "You have been forcibly disconnected by the server";
+}
+
+void InWorld::CheckHeartBeat() {
+	//check the connection (heartbeat)
+	if (Clock::now() - lastBeat > std::chrono::seconds(3)) {
+		if (attemptedBeats > 2) {
+			//escape to the disconnect screen
+			SendDisconnectRequest();
+			SetNextScene(SceneList::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();
+		}
+	}
+}
+
+//-------------------------
+//map management
+//-------------------------
+
+void InWorld::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 InWorld::HandleRegionContent(RegionPacket* const argPacket) {
+	//replace existing regions
+	regionPager.UnloadIf([&](Region const& region) -> bool {
+		return region.GetX() == argPacket->x && region.GetY() == argPacket->y;
+	});
+	regionPager.PushRegion(argPacket->region);
+
+	//clean up after the serial code
+	delete argPacket->region;
+	argPacket->region = nullptr;
+}
+
+void InWorld::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) {
+			if (!regionPager.FindRegion(i, j)) {
+				SendRegionRequest(roomIndex, i, j);
+			}
+		}
+	}
+}

client/gameplay_scenes/in_world_scene.cpp

@@ -0,0 +1,253 @@
+/* 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 "in_world.hpp"
+
+#include "channels.hpp"
+
+#include "terminal_error.hpp"
+#include <stdexcept>
+#include <algorithm>
+#include <cmath>
+#include <iostream>
+#include <sstream>
+
+//-------------------------
+//Public access members
+//-------------------------
+
+InWorld::InWorld(int* const argClientIndex,	int* const argAccountIndex):
+	clientIndex(*argClientIndex),
+	accountIndex(*argAccountIndex),
+	keyState(SDL_GetKeyState(nullptr))
+{
+	//setup the utility objects
+	buttonImage.LoadSurface(config["dir.interface"] + "button_menu.bmp");
+	buttonImage.SetClipH(buttonImage.GetClipH()/3);
+	font.LoadSurface(config["dir.fonts"] + "pk_white_8.bmp");
+
+	//pass the utility objects
+	disconnectButton.SetImage(&buttonImage);
+	disconnectButton.SetFont(&font);
+	shutDownButton.SetImage(&buttonImage);
+	shutDownButton.SetFont(&font);
+
+	//set the button positions
+	disconnectButton.SetX(50);
+	disconnectButton.SetY(50 + buttonImage.GetClipH() * 0);
+	shutDownButton.SetX(50);
+	shutDownButton.SetY(50 + buttonImage.GetClipH() * 1);
+
+	//set the button texts
+	disconnectButton.SetText("Disconnect");
+	shutDownButton.SetText("Shut Down");
+
+	//load the tilesheet
+	//TODO: add the tilesheet to the map system
+	//TODO: Tile size and tile sheet should be loaded elsewhere
+	tileSheet.Load(config["dir.tilesets"] + "overworld.bmp", 32, 32);
+
+	//Send the character data
+	//TODO: login scene, prompt, etc.
+	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);
+
+	//query the world state
+	memset(&newPacket, 0, MAX_PACKET_SIZE);
+	newPacket.type = SerialPacketType::QUERY_CHARACTER_EXISTS;
+	network.SendTo(Channels::SERVER, &newPacket);
+
+	//set the camera's values
+	camera.width = GetScreen()->w;
+	camera.height = GetScreen()->h;
+
+	//debug
+	//
+}
+
+InWorld::~InWorld() {
+	//unload the local data
+	characterMap.clear();
+	monsterMap.clear();
+}
+
+//-------------------------
+//Frame loop
+//-------------------------
+
+void InWorld::FrameStart() {
+	//
+}
+
+void InWorld::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(terminal_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 : monsterMap) {
+		it.second.Update();
+	}
+
+	//update the map
+	UpdateMap();
+
+	//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
+	if (localCharacter->ProcessCollisionGrid(boxList, keyState)) {
+		localCharacter->CorrectSprite();
+		SendLocalCharacterMovement();
+	}
+
+	//update the camera
+	camera.x = localCharacter->GetOrigin().x - camera.marginX;
+	camera.y = localCharacter->GetOrigin().y - camera.marginY;
+}
+
+void InWorld::FrameEnd() {
+	//
+}
+
+void InWorld::RenderFrame() {
+	SDL_FillRect(GetScreen(), 0, 0);
+	Render(GetScreen());
+	SDL_Flip(GetScreen());
+	fps.Calculate();
+}
+
+void InWorld::Render(SDL_Surface* const screen) {
+	//draw the map
+	for (std::list<Region>::iterator it = regionPager.GetContainer()->begin(); it != regionPager.GetContainer()->end(); it++) {
+		tileSheet.DrawRegionTo(screen, &(*it), camera.x, camera.y);
+	}
+
+	//draw the entities
+	for (auto& it : characterMap) {
+		//TODO: depth ordering
+		it.second.DrawTo(screen, camera.x, camera.y);
+	}
+	for (auto& it : monsterMap) {
+		//TODO: depth ordering
+		it.second.DrawTo(screen, camera.x, camera.y);
+	}
+
+	//draw UI
+	disconnectButton.DrawTo(screen);
+	shutDownButton.DrawTo(screen);
+	std::ostringstream msg;
+	msg << fps.GetFrameRate();
+	font.DrawStringTo(msg.str(), screen, 0, 0);
+}
+
+//-------------------------
+//Event handlers
+//-------------------------
+
+void InWorld::QuitEvent() {
+	//two-step logout
+	SendDisconnectRequest();
+	SetNextScene(SceneList::QUIT);
+}
+
+void InWorld::MouseMotion(SDL_MouseMotionEvent const& motion) {
+	disconnectButton.MouseMotion(motion);
+	shutDownButton.MouseMotion(motion);
+}
+
+void InWorld::MouseButtonDown(SDL_MouseButtonEvent const& button) {
+	disconnectButton.MouseButtonDown(button);
+	shutDownButton.MouseButtonDown(button);
+}
+
+void InWorld::MouseButtonUp(SDL_MouseButtonEvent const& button) {
+	if (disconnectButton.MouseButtonUp(button) == Button::State::HOVER && button.button == SDL_BUTTON_LEFT) {
+		SendLogoutRequest();
+	}
+	if (shutDownButton.MouseButtonUp(button) == Button::State::HOVER && button.button == SDL_BUTTON_LEFT) {
+		SendShutdownRequest();
+	}
+}
+
+void InWorld::KeyDown(SDL_KeyboardEvent const& key) {
+	//hotkeys & player input
+	switch(key.keysym.sym) {
+		case SDLK_ESCAPE:
+			//TODO: the escape key should actually control menus and stuff
+			SendLogoutRequest();
+		return;
+		case SDLK_w:
+		case SDLK_a:
+		case SDLK_s:
+		case SDLK_d:
+			ProcessLocalCharacterMovement();
+		break;
+		default:
+			//DOCS: prevents wrong keys screwing with character movement
+			return;
+	}
+}
+
+void InWorld::KeyUp(SDL_KeyboardEvent const& key) {
+	switch(key.keysym.sym) {
+		case SDLK_w:
+		case SDLK_a:
+		case SDLK_s:
+		case SDLK_d:
+			ProcessLocalCharacterMovement();
+		break;
+		default:
+			//DOCS: prevents wrong keys screwing with character movement
+			return;
+	}
+}

client/gameplay_scenes/makefile

@@ -0,0 +1,37 @@
+#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 $@ $<
+
+clean:
+	$(RM) *.o *.a *.exe
+
+rebuild: clean all

client/main.cpp

@@ -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.
+*/
+#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();
+
+		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,50 @@
+#include directories
+INCLUDES+=. client_utilities entities gameplay_scenes menu_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 ../libcommon.a -lSDL_net
+ifeq ($(OS),Windows_NT)
+	LIBS+=-lwsock32 -liphlpapi -lmingw32
+endif
+LIBS+=-lSDLmain -lSDL
+
+#flags
+CXXFLAGS+=-std=c++11 $(addprefix -I,$(INCLUDES))
+
+#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 client_utilities
+	$(MAKE) -C entities
+	$(MAKE) -C gameplay_scenes
+	$(MAKE) -C menu_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:
+	$(RM) *.o *.a *.exe
+
+rebuild: clean all

client/menu_scenes/disconnected_screen.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 "disconnected_screen.hpp"
+
+#include "channels.hpp"
+#include "config_utility.hpp"
+#include "udp_network_utility.hpp"
+
+#include <stdexcept>
+
+//-------------------------
+//Public access members
+//-------------------------
+
+DisconnectedScreen::DisconnectedScreen() {
+	ConfigUtility& config = ConfigUtility::GetSingleton();
+
+	//setup the utility objects
+	image.LoadSurface(config["dir.interface"] + "button_menu.bmp");
+	image.SetClipH(image.GetClipH()/3);
+	font.LoadSurface(config["dir.fonts"] + "pk_white_8.bmp");
+
+	//pass the utility objects
+	backButton.SetImage(&image);
+	backButton.SetFont(&font);
+
+	//set the button positions
+	backButton.SetX(50);
+	backButton.SetY(50 + image.GetClipH() * 0);
+
+	//set the button texts
+	backButton.SetText("Back");
+
+	//full reset
+	UDPNetworkUtility::GetSingleton().Unbind(Channels::SERVER);
+
+	//auto return
+	startTick = std::chrono::steady_clock::now();
+}
+
+DisconnectedScreen::~DisconnectedScreen() {
+	//
+}
+
+//-------------------------
+//Frame loop
+//-------------------------
+
+void DisconnectedScreen::Update() {
+	if (std::chrono::steady_clock::now() - startTick > std::chrono::duration<int>(10)) {
+		SetNextScene(SceneList::MAINMENU);
+	}
+
+	//Eat incoming packets
+	while(UDPNetworkUtility::GetSingleton().Receive());
+}
+
+void DisconnectedScreen::Render(SDL_Surface* const screen) {
+	ConfigUtility& config = ConfigUtility::GetSingleton();
+
+	backButton.DrawTo(screen);
+	font.DrawStringTo(config["client.disconnectMessage"], screen, 50, 30);
+}
+
+//-------------------------
+//Event handlers
+//-------------------------
+
+void DisconnectedScreen::QuitEvent() {
+	SetNextScene(SceneList::QUIT);
+}
+
+void DisconnectedScreen::MouseMotion(SDL_MouseMotionEvent const& motion) {
+	backButton.MouseMotion(motion);
+}
+
+void DisconnectedScreen::MouseButtonDown(SDL_MouseButtonEvent const& button) {
+	backButton.MouseButtonDown(button);
+}
+
+void DisconnectedScreen::MouseButtonUp(SDL_MouseButtonEvent const& button) {
+	if (backButton.MouseButtonUp(button) == Button::State::HOVER) {
+		SetNextScene(SceneList::MAINMENU);
+	}
+}
+
+void DisconnectedScreen::KeyDown(SDL_KeyboardEvent const& key) {
+	switch(key.keysym.sym) {
+		case SDLK_ESCAPE:
+			SetNextScene(SceneList::MAINMENU);
+		break;
+	}
+}
+
+void DisconnectedScreen::KeyUp(SDL_KeyboardEvent const& key) {
+	//
+}

client/menu_scenes/disconnected_screen.hpp

@@ -0,0 +1,66 @@
+/* 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.
+*/
+#ifndef DISCONNECTEDSCREEN_HPP_
+#define DISCONNECTEDSCREEN_HPP_
+
+//graphics
+#include "image.hpp"
+#include "raster_font.hpp"
+#include "button.hpp"
+
+//client
+#include "base_scene.hpp"
+
+//std namespace
+#include <chrono>
+
+class DisconnectedScreen : public BaseScene {
+public:
+	//Public access members
+	DisconnectedScreen();
+	~DisconnectedScreen();
+
+protected:
+	//Frame loop
+	void Update();
+	void Render(SDL_Surface* const);
+
+	//Event handlers
+	void QuitEvent();
+	void MouseMotion(SDL_MouseMotionEvent const&);
+	void MouseButtonDown(SDL_MouseButtonEvent const&);
+	void MouseButtonUp(SDL_MouseButtonEvent const&);
+	void KeyDown(SDL_KeyboardEvent const&);
+	void KeyUp(SDL_KeyboardEvent const&);
+
+	//graphics
+	Image image;
+	RasterFont font;
+
+	//UI
+	Button backButton;
+
+	//auto return
+	std::chrono::steady_clock::time_point startTick;
+};
+
+#endif

client/menu_scenes/lobby_menu.cpp

@@ -0,0 +1,297 @@
+/* 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 <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
+	image.LoadSurface(config["dir.interface"] + "button_menu.bmp");
+	image.SetClipH(image.GetClipH()/3);
+	font.LoadSurface(config["dir.fonts"] + "pk_white_8.bmp");
+
+	//pass the utility objects
+	search.SetImage(&image);
+	search.SetFont(&font);
+	join.SetImage(&image);
+	join.SetFont(&font);
+	back.SetImage(&image);
+	back.SetFont(&font);
+
+	//set the button positions
+	search.SetX(50);
+	search.SetY(50 + image.GetClipH() * 0);
+	join.SetX(50);
+	join.SetY(50 + image.GetClipH() * 1);
+	back.SetX(50);
+	back.SetY(50 + image.GetClipH() * 2);
+
+	//set the button texts
+	search.SetText("Search");
+	join.SetText("Join");
+	back.SetText("Back");
+
+	//set the server list's position
+	listBox = {300, 50, 200, font.GetCharH()};
+
+	//Eat incoming packets
+	while(network.Receive());
+
+	//Initial broadcast
+	SendBroadcastRequest();
+}
+
+LobbyMenu::~LobbyMenu() {
+	//
+}
+
+//-------------------------
+//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::Render(SDL_Surface* const screen) {
+	//TODO: I need a proper UI system for the entire client and the editor
+
+	//UI
+	search.DrawTo(screen);
+	join.DrawTo(screen);
+	back.DrawTo(screen);
+
+	//TODO: draw headers for the server list
+	for (int i = 0; i < serverInfo.size(); i++) {
+		//draw the selected server's highlight
+		if (selection == &serverInfo[i]) {
+			SDL_Rect r = {
+				(Sint16)listBox.x, (Sint16)listBox.y,
+				(Uint16)listBox.w, (Uint16)listBox.h
+			};
+			r.y += i * listBox.h;
+			SDL_FillRect(screen, &r, SDL_MapRGB(screen->format, 49, 150, 5));
+		}
+
+		//draw the server name
+		font.DrawStringTo(serverInfo[i].name, screen, listBox.x, listBox.y + i*listBox.h);
+
+		//draw the player count
+		std::ostringstream msg;
+		msg << serverInfo[i].playerCount;
+		font.DrawStringTo(msg.str(), screen, listBox.x + listBox.w, listBox.y + i*listBox.h);
+
+		//compatible?
+		if (!serverInfo[i].compatible) {
+			font.DrawStringTo("?", screen, listBox.x - font.GetCharW(), listBox.y + i*listBox.h);
+		}
+
+		//TODO: ping/delay?
+	}
+}
+
+//-------------------------
+//Event handlers
+//-------------------------
+
+void LobbyMenu::MouseMotion(SDL_MouseMotionEvent const& motion) {
+	search.MouseMotion(motion);
+	join.MouseMotion(motion);
+	back.MouseMotion(motion);
+}
+
+void LobbyMenu::MouseButtonDown(SDL_MouseButtonEvent const& button) {
+	search.MouseButtonDown(button);
+	join.MouseButtonDown(button);
+	back.MouseButtonDown(button);
+}
+
+void LobbyMenu::MouseButtonUp(SDL_MouseButtonEvent const& button) {
+	if (search.MouseButtonUp(button) == Button::State::HOVER) {
+		SendBroadcastRequest();
+	}
+	else if (join.MouseButtonUp(button) == Button::State::HOVER && selection != nullptr && selection->compatible) {
+		SendJoinRequest();
+	}
+	else if (back.MouseButtonUp(button) == Button::State::HOVER) {
+		SetNextScene(SceneList::MAINMENU);
+	}
+
+	//has the user selected a server on the list?
+	BoundingBox tmpBox = listBox;
+	tmpBox.h *= serverInfo.size();
+	if (tmpBox.CheckCollision({button.x, button.y, 0, 0})) {
+		selection = &serverInfo[(button.y - listBox.y)/listBox.h];
+	}
+	else {
+		selection = nullptr;
+	}
+}
+
+void LobbyMenu::KeyDown(SDL_KeyboardEvent const& key) {
+	switch(key.keysym.sym) {
+		case SDLK_ESCAPE:
+			SetNextScene(SceneList::MAINMENU);
+		break;
+	}
+}
+
+void LobbyMenu::KeyUp(SDL_KeyboardEvent const& key) {
+	//
+}
+
+//-------------------------
+//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
+	ServerInformation server;
+	server.address = argPacket->srcAddress;
+	server.name = argPacket->name;
+	server.playerCount = argPacket->playerCount;
+	server.version = argPacket->version;
+
+	//Checking compatibility
+	server.compatible = server.version == NETWORK_VERSION;
+
+	//push
+	serverInfo.push_back(server);
+}
+
+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;
+	SetNextScene(SceneList::INWORLD);
+}
+
+void LobbyMenu::HandleJoinRejection(TextPacket* const argPacket) {
+	//TODO: Better output for join rejection
+}
+
+void LobbyMenu::HandleLoginRejection(TextPacket* const argPacket) {
+	//TODO: Better output for login rejection
+}
+
+//-------------------------
+//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
+		serverInfo.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
+	ClientPacket packet;
+	packet.type = SerialPacketType::LOGIN_REQUEST;
+	packet.clientIndex = clientIndex;
+	strncpy(packet.username, config["client.username"].c_str(), PACKET_STRING_SIZE);
+
+	network.SendTo(Channels::SERVER, &packet);
+}

client/menu_scenes/lobby_menu.hpp

@@ -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.
+*/
+#ifndef LOBBYMENU_HPP_
+#define LOBBYMENU_HPP_
+
+//graphics & ui
+#include "image.hpp"
+#include "raster_font.hpp"
+#include "button.hpp"
+#include "bounding_box.hpp"
+
+//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();
+
+protected:
+	//Frame loop
+	void FrameStart();
+	void Update();
+	void FrameEnd();
+	void Render(SDL_Surface* const);
+
+	//Event handlers
+	void MouseMotion(SDL_MouseMotionEvent const&);
+	void MouseButtonDown(SDL_MouseButtonEvent const&);
+	void MouseButtonUp(SDL_MouseButtonEvent const&);
+	void KeyDown(SDL_KeyboardEvent const&);
+	void KeyUp(SDL_KeyboardEvent const&);
+
+	//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;
+
+	//members
+	Image image;
+	RasterFont font;
+	Button search;
+	Button join;
+	Button back;
+
+	//server list
+	struct ServerInformation {
+		IPaddress address;
+		std::string name;
+		int playerCount;
+		int version;
+		bool compatible;
+	};
+
+	std::vector<ServerInformation> serverInfo;
+
+	//NOTE: a terrible hack
+	//I'd love a proper gui system for this
+	BoundingBox listBox;
+	ServerInformation* selection = nullptr;
+};
+
+#endif

client/menu_scenes/main_menu.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 "main_menu.hpp"
+
+#include "config_utility.hpp"
+
+//-------------------------
+//Public access members
+//-------------------------
+
+MainMenu::MainMenu() {
+	ConfigUtility& config = ConfigUtility::GetSingleton();
+
+	//setup the utility objects
+	image.LoadSurface(config["dir.interface"] + "button_menu.bmp");
+	image.SetClipH(image.GetClipH()/3);
+	font.LoadSurface(config["dir.fonts"] + "pk_white_8.bmp");
+
+	//pass the utility objects
+	startButton.SetImage(&image);
+	startButton.SetFont(&font);
+	optionsButton.SetImage(&image);
+	optionsButton.SetFont(&font);
+	quitButton.SetImage(&image);
+	quitButton.SetFont(&font);
+
+	//set the button positions
+	startButton.SetX(50);
+	startButton.SetY(50 + image.GetClipH() * 0);
+	optionsButton.SetX(50);
+	optionsButton.SetY(50 + image.GetClipH() * 1);
+	quitButton.SetX(50);
+	quitButton.SetY(50 + image.GetClipH() * 2);
+
+	//set the button texts
+	startButton.SetText("Start");
+	optionsButton.SetText("Options");
+	quitButton.SetText("Quit");
+
+	//debug
+	//
+}
+
+MainMenu::~MainMenu() {
+	//
+}
+
+//-------------------------
+//Frame loop
+//-------------------------
+
+void MainMenu::FrameStart() {
+	//
+}
+
+void MainMenu::Update() {
+	//
+}
+
+void MainMenu::FrameEnd() {
+	//
+}
+
+void MainMenu::Render(SDL_Surface* const screen) {
+	startButton.DrawTo(screen);
+	optionsButton.DrawTo(screen);
+	quitButton.DrawTo(screen);
+
+	//text
+	font.DrawStringTo("Thanks for playing!", screen, 50, screen->h - 50 - image.GetClipH() * 2);
+	font.DrawStringTo("You can get the latest version at: ", screen, 50, screen->h - 50 - image.GetClipH() * 1);
+	font.DrawStringTo("https://github.com/Ratstail91/Tortuga", screen, 50, screen->h - 50 - image.GetClipH() * 0);
+	//TODO: replace this with a website address
+}
+
+//-------------------------
+//Event handlers
+//-------------------------
+
+void MainMenu::MouseMotion(SDL_MouseMotionEvent const& motion) {
+	startButton.MouseMotion(motion);
+	optionsButton.MouseMotion(motion);
+	quitButton.MouseMotion(motion);
+}
+
+void MainMenu::MouseButtonDown(SDL_MouseButtonEvent const& button) {
+	startButton.MouseButtonDown(button);
+	optionsButton.MouseButtonDown(button);
+	quitButton.MouseButtonDown(button);
+}
+
+void MainMenu::MouseButtonUp(SDL_MouseButtonEvent const& button) {
+	//TODO: Buttons should only register as "selected" when the left button is used
+	if (startButton.MouseButtonUp(button) == Button::State::HOVER) {
+		SetNextScene(SceneList::LOBBYMENU);
+	}
+	if (optionsButton.MouseButtonUp(button) == Button::State::HOVER) {
+		SetNextScene(SceneList::OPTIONSMENU);
+	}
+	if (quitButton.MouseButtonUp(button) == Button::State::HOVER) {
+		QuitEvent();
+	}
+}
+
+void MainMenu::KeyDown(SDL_KeyboardEvent const& key) {
+	//
+}
+
+void MainMenu::KeyUp(SDL_KeyboardEvent const& key) {
+	//
+}

client/menu_scenes/main_menu.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.
+*/
+#ifndef MAINMENU_HPP_
+#define MAINMENU_HPP_
+
+#include "base_scene.hpp"
+
+#include "image.hpp"
+#include "raster_font.hpp"
+#include "button.hpp"
+
+class MainMenu : public BaseScene {
+public:
+	//Public access members
+	MainMenu();
+	~MainMenu();
+
+protected:
+	//Frame loop
+	void FrameStart();
+	void Update();
+	void FrameEnd();
+	void Render(SDL_Surface* const);
+
+	//Event handlers
+	void MouseMotion(SDL_MouseMotionEvent const&);
+	void MouseButtonDown(SDL_MouseButtonEvent const&);
+	void MouseButtonUp(SDL_MouseButtonEvent const&);
+	void KeyDown(SDL_KeyboardEvent const&);
+	void KeyUp(SDL_KeyboardEvent const&);
+
+	//members
+	Image image;
+	RasterFont font;
+	Button startButton;
+	Button optionsButton;
+	Button quitButton;
+};
+
+#endif

client/menu_scenes/makefile

@@ -0,0 +1,37 @@
+#config
+INCLUDES+=. .. ../../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 $@ $<
+
+clean:
+	$(RM) *.o *.a *.exe
+
+rebuild: clean all

client/menu_scenes/options_menu.cpp

@@ -0,0 +1,104 @@
+/* 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"
+
+//-------------------------
+//Public access members
+//-------------------------
+
+OptionsMenu::OptionsMenu() {
+	ConfigUtility& config = ConfigUtility::GetSingleton();
+
+	//setup the utility objects
+	image.LoadSurface(config["dir.interface"] + "button_menu.bmp");
+	image.SetClipH(image.GetClipH()/3);
+	font.LoadSurface(config["dir.fonts"] + "pk_white_8.bmp");
+
+	//pass the utility objects
+	backButton.SetImage(&image);
+	backButton.SetFont(&font);
+
+	//set the button positions
+	backButton.SetX(50);
+	backButton.SetY(50 + image.GetClipH() * 0);
+
+	//set the button texts
+	backButton.SetText("Back");
+}
+
+OptionsMenu::~OptionsMenu() {
+	//
+}
+
+//-------------------------
+//Frame loop
+//-------------------------
+
+void OptionsMenu::FrameStart() {
+	//
+}
+
+void OptionsMenu::Update() {
+	//
+}
+
+void OptionsMenu::FrameEnd() {
+	//
+}
+
+void OptionsMenu::Render(SDL_Surface* const screen) {
+	backButton.DrawTo(screen);
+
+	font.DrawStringTo("Oh, were you looking for the options screen?", screen, 50, 30);
+}
+
+//-------------------------
+//Event handlers
+//-------------------------
+
+void OptionsMenu::MouseMotion(SDL_MouseMotionEvent const& motion) {
+	backButton.MouseMotion(motion);
+}
+
+void OptionsMenu::MouseButtonDown(SDL_MouseButtonEvent const& button) {
+	backButton.MouseButtonDown(button);
+}
+
+void OptionsMenu::MouseButtonUp(SDL_MouseButtonEvent const& button) {
+	if (backButton.MouseButtonUp(button) == Button::State::HOVER) {
+		SetNextScene(SceneList::MAINMENU);
+	}
+}
+
+void OptionsMenu::KeyDown(SDL_KeyboardEvent const& key) {
+	switch(key.keysym.sym) {
+		case SDLK_ESCAPE:
+			SetNextScene(SceneList::MAINMENU);
+		break;
+	}
+}
+
+void OptionsMenu::KeyUp(SDL_KeyboardEvent const& key) {
+	//
+}

client/menu_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.
+*/
+#ifndef OPTIONSMENU_HPP_
+#define OPTIONSMENU_HPP_
+
+#include "base_scene.hpp"
+
+#include "image.hpp"
+#include "raster_font.hpp"
+#include "button.hpp"
+
+//TODO: The options screen needs to be USED
+class OptionsMenu : public BaseScene {
+public:
+	//Public access members
+	OptionsMenu();
+	~OptionsMenu();
+
+protected:
+	//Frame loop
+	void FrameStart();
+	void Update();
+	void FrameEnd();
+	void Render(SDL_Surface* const);
+
+	//Event handlers
+	void MouseMotion(SDL_MouseMotionEvent const&);
+	void MouseButtonDown(SDL_MouseButtonEvent const&);
+	void MouseButtonUp(SDL_MouseButtonEvent const&);
+	void KeyDown(SDL_KeyboardEvent const&);
+	void KeyUp(SDL_KeyboardEvent const&);
+
+	//members
+	Image image;
+	RasterFont font;
+	Button backButton;
+};
+
+#endif

client/menu_scenes/splash_screen.cpp

@@ -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.
+*/
+#include "splash_screen.hpp"
+
+#include "config_utility.hpp"
+
+//-------------------------
+//Public access members
+//-------------------------
+
+SplashScreen::SplashScreen() {
+	logo.LoadSurface(ConfigUtility::GetSingleton()["dir.logos"] + "krstudios.bmp");
+	startTick = std::chrono::steady_clock::now();
+}
+
+SplashScreen::~SplashScreen() {
+	//
+}
+
+//-------------------------
+//Frame loop
+//-------------------------
+
+void SplashScreen::Update() {
+	if (std::chrono::steady_clock::now() - startTick > std::chrono::duration<int>(1)) {
+		SetNextScene(SceneList::MAINMENU);
+	}
+}
+
+void SplashScreen::Render(SDL_Surface* const screen) {
+	logo.DrawTo(screen, (screen->w - logo.GetClipW()) / 2, (screen->h - logo.GetClipH()) / 2);
+}

client/menu_scenes/splash_screen.hpp

@@ -0,0 +1,47 @@
+/* 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.
+*/
+#ifndef SPLASHSCREEN_HPP_
+#define SPLASHSCREEN_HPP_
+
+#include "base_scene.hpp"
+
+#include "image.hpp"
+
+#include <chrono>
+
+class SplashScreen : public BaseScene {
+public:
+	//Public access members
+	SplashScreen();
+	~SplashScreen();
+
+protected:
+	//Frame loop
+	void Update();
+	void Render(SDL_Surface* const);
+
+	//members
+	std::chrono::steady_clock::time_point startTick;
+	Image logo;
+};
+
+#endif

client/scene_list.hpp

@@ -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.
+*/
+#ifndef SCENELIST_HPP_
+#define SCENELIST_HPP_
+
+enum class SceneList {
+	//these are reserved
+	QUIT,
+	CONTINUE,
+	FIRST,
+
+	//custom indexes
+	SPLASHSCREEN,
+	MAINMENU,
+	OPTIONSMENU,
+	LOBBYMENU,
+	INWORLD,
+	DISCONNECTEDSCREEN,
+};
+
+#endif

common/debugging/makefile

@@ -0,0 +1,37 @@
+#config
+INCLUDES+=.
+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)/,libcommon.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 $@ $<
+
+clean:
+	$(RM) *.o *.a *.exe
+
+rebuild: clean all

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,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.
+*/
+#ifndef TIMER_HPP_
+#define TIMER_HPP_
+
+#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);
+
+#endif

common/gameplay/character_defines.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.
+*/
+#ifndef CHARACTERDEFINES_HPP_
+#define CHARACTERDEFINES_HPP_
+
+#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;
+
+#endif

common/gameplay/makefile

@@ -0,0 +1,37 @@
+#config
+INCLUDES+=.
+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)/,libcommon.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 $@ $<
+
+clean:
+	$(RM) *.o *.a *.exe
+
+rebuild: clean all

common/graphics/image.cpp

@@ -0,0 +1,145 @@
+/* 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 <stdexcept>
+#include <sstream>
+
+Image& Image::operator=(Image const& rhs) {
+	//don't screw yourself
+	if (this == &rhs) {
+		return *this;
+	}
+
+	FreeSurface();
+
+	//Copy the other Image's stuff
+	surface = rhs.surface;
+	clip = rhs.clip;
+	local = false;
+}
+
+Image& Image::operator=(Image&& rhs) {
+	//don't screw yourself
+	if (this == &rhs) {
+		return *this;
+	}
+
+	FreeSurface();
+
+	//Steal the other Image's stuff
+	surface = rhs.surface;
+	clip = rhs.clip;
+	local = rhs.local;
+
+	rhs.surface = nullptr;
+	rhs.clip = {0, 0, 0, 0};
+	rhs.local = false;
+}
+
+SDL_Surface* Image::LoadSurface(std::string fname) {
+	FreeSurface();
+	SDL_Surface* p = SDL_LoadBMP(fname.c_str());
+	if (!p) {
+		std::ostringstream os;
+		os << "Failed to load file: " << fname;
+		throw(std::runtime_error(os.str()));
+	}
+	surface = p;
+	clip = {0, 0, (Uint16)surface->w, (Uint16)surface->h};
+	local = true;
+	SetTransparentColor(255, 0, 255); //default
+	return surface;
+}
+
+SDL_Surface* Image::CreateSurface(Uint16 w, Uint16 h) {
+	FreeSurface();
+	Uint32 rmask, gmask, bmask, amask;
+#if SDL_BYTEORDER == SDL_BIG_ENDIAN
+    rmask = 0xff000000;
+    gmask = 0x00ff0000;
+    bmask = 0x0000ff00;
+    amask = 0x000000ff;
+#else
+    rmask = 0x000000ff;
+    gmask = 0x0000ff00;
+    bmask = 0x00ff0000;
+    amask = 0xff000000;
+#endif
+	SDL_Surface* p = SDL_CreateRGBSurface(SDL_SWSURFACE, w, h, 32, rmask, gmask, bmask, amask);
+	if (!p) {
+		throw(std::runtime_error("Failed to create Image surface"));
+	}
+	surface = p;
+	clip = {0, 0, (Uint16)surface->w, (Uint16)surface->h};
+	local = true;
+	SetTransparentColor(255, 0, 255); //default
+	return surface;
+}
+
+SDL_Surface* Image::SetSurface(SDL_Surface* p) {
+	FreeSurface();
+	if (!p) {
+		throw(std::invalid_argument("No surface pointer provided"));
+	}
+	surface = p;
+	clip = {0, 0, (Uint16)surface->w, (Uint16)surface->h};
+	local = false;
+	return surface;
+}
+
+void Image::FreeSurface() {
+	if (local) {
+		SDL_FreeSurface(surface);
+		local = false;
+	}
+	surface = nullptr;
+	clip = {0, 0, 0, 0};
+}
+
+void Image::DrawTo(SDL_Surface* dest, Sint16 x, Sint16 y) {
+	if (!surface) {
+		throw(std::logic_error("No image surface to draw"));
+	}
+	SDL_Rect sclip = clip, dclip = {x,y};
+	SDL_BlitSurface(surface, &sclip, dest, &dclip);
+}
+
+void Image::SetTransparentColor(Uint8 r, Uint8 g, Uint8 b) {
+	if (!surface) {
+		throw(std::logic_error("Failed to set the transparent color"));
+	}
+	if (!local) {
+		throw(std::logic_error("Cannot set the transparent color of a non-local surface"));
+	}
+	SDL_SetColorKey(surface, SDL_SRCCOLORKEY, SDL_MapRGB(surface->format, r, g, b));
+}
+
+void Image::ClearTransparentColor() {
+	if (!surface) {
+		throw(std::logic_error("Failed to clear the transparent color"));
+	}
+	if (!local) {
+		throw(std::logic_error("Cannot clear the transparent color of a non-local surface"));
+	}
+	SDL_SetColorKey(surface, 0, 0);
+}

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.
+*/
+#ifndef IMAGE_HPP_
+#define IMAGE_HPP_
+
+#include "SDL/SDL.h"
+#include <string>
+
+class Image {
+public:
+	Image() = default;
+	Image(Image const& rhs) { *this = rhs; }
+	Image(Image&& rhs) { *this = std::move(rhs); }
+	Image(std::string fname) { LoadSurface(fname); }
+	Image(Uint16 w, Uint16 h) { CreateSurface(w, h); }
+	Image(SDL_Surface* p) { SetSurface(p); }
+	~Image() { FreeSurface(); }
+
+	Image& operator=(Image const&);
+	Image& operator=(Image&&);
+
+	SDL_Surface* LoadSurface(std::string fname);
+	SDL_Surface* CreateSurface(Uint16 w, Uint16 h);
+	SDL_Surface* SetSurface(SDL_Surface*);
+	SDL_Surface* GetSurface() const { return surface; }
+	void FreeSurface();
+
+	void DrawTo(SDL_Surface* const, Sint16 x, Sint16 y);
+
+	//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; }
+
+	void SetTransparentColor(Uint8 r, Uint8 g, Uint8 b);
+	void ClearTransparentColor();
+protected:
+	SDL_Surface* surface = nullptr;
+	SDL_Rect clip = {0, 0, 0, 0};
+	bool local = false;
+};
+
+#endif

common/graphics/makefile

@@ -0,0 +1,37 @@
+#config
+INCLUDES+=. ../map
+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)/,libcommon.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 $@ $<
+
+clean:
+	$(RM) *.o *.a *.exe
+
+rebuild: clean all

common/graphics/sprite_sheet.cpp

@@ -0,0 +1,102 @@
+/* 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 <stdexcept>
+#include <sstream>
+
+void SpriteSheet::Update(double delta) {
+	if (delay && (tick += delta) >= delay) {
+		if (++xIndex >= xCount) {
+			xIndex = 0;
+		}
+		tick = 0;
+	}
+	image.SetClipX(xIndex * image.GetClipW());
+	image.SetClipY(yIndex * image.GetClipH());
+}
+
+SDL_Surface* SpriteSheet::LoadSurface(std::string fname, Uint16 xCellCount, Uint16 yCellCount) {
+	image.LoadSurface(fname);
+
+	xCount = xCellCount;
+	yCount = yCellCount;
+
+	image.SetClipW(image.GetSurface()->w / xCount);
+	image.SetClipH(image.GetSurface()->h / yCount);
+
+	xIndex = yIndex = 0;
+	delay = tick = 0.0;
+}
+
+SDL_Surface* SpriteSheet::SetSurface(SDL_Surface* surface, Uint16 xCellCount, Uint16 yCellCount) {
+	image.SetSurface(surface);
+
+	xCount = xCellCount;
+	yCount = yCellCount;
+
+	image.SetClipW(image.GetSurface()->w / xCount);
+	image.SetClipH(image.GetSurface()->h / yCount);
+
+	xIndex = yIndex = 0;
+	delay = tick = 0.0;
+}
+
+void SpriteSheet::FreeSurface() {
+	image.FreeSurface();
+	xCount = yCount = 0;
+	xIndex = yIndex = 0;
+	delay = tick = 0.0;
+}
+
+Uint16 SpriteSheet::SetXCount(Uint16 i) {
+	xIndex = 0;
+	return xCount = i;
+}
+
+Uint16 SpriteSheet::SetYCount(Uint16 i) {
+	yIndex = 0;
+	return yCount = i;
+}
+
+Uint16 SpriteSheet::SetXIndex(Uint16 i) {
+	if (i > xCount) {
+		std::ostringstream os;
+		os << "Cannot set x index to " << i;
+		throw(std::invalid_argument(os.str()));
+	}
+	return xIndex = i;
+}
+
+Uint16 SpriteSheet::SetYIndex(Uint16 i) {
+	if (i > yCount) {
+		std::ostringstream os;
+		os << "Cannot set y index to " << i;
+		throw(std::invalid_argument(os.str()));
+	}
+	return yIndex = i;
+}
+
+double SpriteSheet::SetDelay(double d) {
+	tick = 0;
+	return delay = d;
+}

common/graphics/sprite_sheet.hpp

@@ -0,0 +1,66 @@
+/* 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.
+*/
+#ifndef SPRITESHEET_HPP_
+#define SPRITESHEET_HPP_
+
+#include "image.hpp"
+
+class SpriteSheet {
+public:
+	SpriteSheet() = default;
+	SpriteSheet(std::string fname, Uint16 xCellCount, Uint16 yCellCount) { LoadSurface(fname, xCellCount, yCellCount); }
+	SpriteSheet(SDL_Surface* surface, Uint16 xCellCount, Uint16 yCellCount) { SetSurface(surface, xCellCount, yCellCount); }
+	~SpriteSheet() { FreeSurface(); };
+
+	void Update(double delta);
+
+	SDL_Surface* LoadSurface(std::string fname, Uint16 xCellCount, Uint16 yCellCount);
+	SDL_Surface* SetSurface(SDL_Surface* surface, Uint16 xCellCount, Uint16 yCellCount);
+	SDL_Surface* GetSurface() { return image.GetSurface(); }
+	void FreeSurface();
+
+	void DrawTo(SDL_Surface* const dest, Sint16 x, Sint16 y) { image.DrawTo(dest, x, y); }
+
+	//accessors and mutators
+	Image* GetImage() { return ℑ } //OO breaker
+
+	Uint16 SetXCount(Uint16);
+	Uint16 SetYCount(Uint16);
+	Uint16 SetXIndex(Uint16);
+	Uint16 SetYIndex(Uint16);
+
+	Uint16 GetXCount() const { return xCount; }
+	Uint16 GetYCount() const { return yCount; }
+	Uint16 GetXIndex() const { return xIndex; }
+	Uint16 GetYIndex() const { return yIndex; }
+
+	double SetDelay(double d);
+	double GetDelay() const { return delay; }
+
+private:
+	Image image;
+	Uint16 xCount = 0, yCount = 0; //number of cells
+	Uint16 xIndex = 0, yIndex = 0; //current cell being drawn
+	double delay = 0.0, tick = 0.0;
+};
+
+#endif

common/graphics/tile_sheet.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 "tile_sheet.hpp"
+
+void TileSheet::Load(std::string fname, int tileWidth, int tileHeight) {
+	image.LoadSurface(fname);
+	image.SetClipW(tileWidth);
+	image.SetClipH(tileHeight);
+	xCount = image.GetSurface()->w / image.GetClipW();
+	yCount = image.GetSurface()->h / image.GetClipH();
+}
+
+void TileSheet::Unload() {
+	image.FreeSurface();
+	xCount = yCount = 0;
+}
+
+void TileSheet::DrawTileTo(SDL_Surface* const dest, int x, int y, Region::type_t tile) {
+	//0 is invisible
+	if (tile == 0) return;
+	image.SetClipX((tile-1) % xCount * image.GetClipW());
+	image.SetClipY((tile-1) / xCount * image.GetClipH());
+	image.DrawTo(dest, x, y);
+}
+
+void TileSheet::DrawRegionTo(SDL_Surface* const dest, Region* const region, int camX, int camY) {
+	Region::type_t tile = 0;
+	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) {
+				tile = region->GetTile(i, j, k);
+				//0 is invisible
+				if (tile == 0) continue;
+				image.SetClipX((tile-1) % xCount * image.GetClipW());
+				image.SetClipY((tile-1) / xCount * image.GetClipH());
+				image.DrawTo(dest,
+					(region->GetX() + i) * image.GetClipW() - camX,
+					(region->GetY() + j) * image.GetClipH() - camY);
+			}
+		}
+	}
+}

common/graphics/tile_sheet.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.
+*/
+#ifndef TILESHEET_HPP_
+#define TILESHEET_HPP_
+
+#include "region.hpp"
+
+#include "image.hpp"
+
+#include <string>
+
+class TileSheet {
+public:
+	TileSheet() = default;
+	TileSheet(std::string f, int w, int h) { Load(f, w, h); }
+	~TileSheet() = default;
+
+	void Load(std::string fname, int tileWidth, int tileHeight);
+	void Unload();
+
+	void DrawTileTo(SDL_Surface* const dest, int x, int y, Region::type_t tile);
+	void DrawRegionTo(SDL_Surface* const dest, Region* const region, int camX, int camY);
+
+	//accessors
+	Image* GetImage() { return &image; }
+	int GetXCount() { return xCount; }
+	int GetYCount() { return yCount; }
+	int GetTileW() { return image.GetClipW(); }
+	int GetTileH() { return image.GetClipH(); }
+private:
+	Image image;
+	int xCount = 0, yCount = 0;
+};
+
+#endif

common/makefile

@@ -0,0 +1,13 @@
+all:
+	$(MAKE) -C debugging
+	$(MAKE) -C gameplay
+	$(MAKE) -C graphics
+	$(MAKE) -C map
+	$(MAKE) -C network
+	$(MAKE) -C ui
+	$(MAKE) -C utilities
+
+clean:
+	$(RM) *.o *.a *.exe
+
+rebuild: clean all

common/map/makefile

@@ -0,0 +1,37 @@
+#config
+INCLUDES+=. ../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)/,libcommon.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 $@ $<
+
+clean:
+	$(RM) *.o *.a *.exe
+
+rebuild: clean all

common/map/map_system_api.cpp

@@ -0,0 +1,55 @@
+/* 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 "map_system_api.hpp"
+
+//all map API headers
+#include "region_api.hpp"
+#include "region_pager_api.hpp"
+
+//useful "globals"
+//...
+
+//This mimics linit.c to create a nested collection of all map modules.
+static const luaL_Reg funcs[] = {
+	{nullptr, nullptr}
+};
+
+static const luaL_Reg libs[] = {
+	{"Region", openRegionAPI},
+	{"RegionPager", openRegionPagerAPI},
+	{nullptr, nullptr}
+};
+
+int openMapSystemAPI(lua_State* L) {
+	//create the table
+	luaL_newlibtable(L, libs);
+
+	//push the "global" functions
+	luaL_setfuncs(L, funcs, 0);
+
+	//push the substable
+	for (const luaL_Reg* lib = libs; lib->func; lib++) {
+		lib->func(L);
+		lua_setfield(L, -2, lib->name);
+	}
+	return 1;
+}

common/map/map_system_api.hpp

@@ -0,0 +1,30 @@
+/* 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.
+*/
+#ifndef MAPSYSTEMAPI_HPP_
+#define MAPSYSTEMAPI_APP_
+
+#include "lua.hpp"
+
+#define TORTUGA_MAP_SYSTEM_API "map_system"
+LUAMOD_API int openMapSystemAPI(lua_State* L);
+
+#endif

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) {
+	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,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.
+*/
+#ifndef REGION_HPP_
+#define REGION_HPP_
+
+#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);
+
+	//accessors
+	int GetX() const;
+	int GetY() const;
+
+	std::bitset<REGION_WIDTH*REGION_HEIGHT>* GetSolidBitset();
+private:
+	const int x;
+	const int y;
+
+	type_t tiles[REGION_WIDTH][REGION_HEIGHT][REGION_DEPTH];
+	std::bitset<REGION_WIDTH*REGION_HEIGHT> solid;
+};
+
+#endif

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,30 @@
+/* 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.
+*/
+#ifndef REGIONAPI_HPP_
+#define REGIONAPI_HPP_
+
+#include "lua.hpp"
+
+#define TORTUGA_REGION_NAME "region"
+LUAMOD_API int openRegionAPI(lua_State* L);
+
+#endif

common/map/region_pager_api.cpp

@@ -0,0 +1,171 @@
+/* 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
+
+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,30 @@
+/* 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.
+*/
+#ifndef REGIONPAGERAPI_HPP_
+#define REGIONPAGERAPI_HPP_
+
+#include "lua.hpp"
+
+#define TORTUGA_REGION_PAGER_NAME "region_pager"
+LUAMOD_API int openRegionPagerAPI(lua_State* L);
+
+#endif

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,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.
+*/
+#ifndef REGIONPAGERBASE_HPP_
+#define REGIONPAGERBASE_HPP_
+
+#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;
+};
+
+#endif

common/map/region_pager_lua.cpp

@@ -0,0 +1,200 @@
+/* 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>
+
+//DOCS: Load, Save and Create fail unless the lua function has been set
+//DOCS: UnloadIf and UnloadAll will still continue without the function set
+
+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);
+		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_toboolean(lua, -1)) {
+		lua_pop(lua, 1);
+		regionList.push_front(tmpRegion);
+		return &regionList.front();
+	}
+	else {
+		lua_pop(lua, 1);
+		return nullptr;
+	}
+}
+
+//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);
+		return nullptr;
+	}
+
+	//find the specified region
+	Region* ptr = FindRegion(x, y);
+	if (!ptr) {
+		lua_pop(lua, 1);
+		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_toboolean(lua, -1)) {
+		lua_pop(lua, 1);
+		return ptr;
+	}
+	else {
+		lua_pop(lua, 1);
+		return nullptr;
+	}
+}
+
+//return the created region, or nullptr 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 nullptr;
+	}
+
+	//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,69 @@
+/* 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.
+*/
+#ifndef REGIONPAGERLUA_HPP_
+#define REGIONPAGERLUA_HPP_
+
+#include "region_pager_base.hpp"
+
+#include "lua.hpp"
+
+#include <functional>
+#include <string>
+
+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;
+};
+
+#endif

common/network/makefile

@@ -0,0 +1,38 @@
+#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))
+
+#output
+OUTDIR=../..
+OUT=$(addprefix $(OUTDIR)/,libcommon.a)
+
+#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 $@ $<
+
+clean:
+	$(RM) *.o *.a *.exe
+
+rebuild: clean all

common/network/packet_types/character_packet.cpp

@@ -0,0 +1,66 @@
+/* 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));
+
+	//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));
+
+	//gameplay components: equipment, items, buffs, debuffs...
+}

common/network/packet_types/character_packet.hpp

@@ -0,0 +1,50 @@
+/* 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.
+*/
+#ifndef CHARACTERPACKET_HPP_
+#define CHARACTERPACKET_HPP_
+
+#include "serial_packet_base.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;
+	//TODO: Authentication token?
+
+	//location
+	int roomIndex;
+	Vector2 origin;
+	Vector2 motion;
+
+	//gameplay components: equipment, items, buffs, debuffs...
+};
+
+void serializeCharacter(void* buffer, CharacterPacket* packet);
+void deserializeCharacter(void* buffer, CharacterPacket* packet);
+
+#endif

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,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.
+*/
+#ifndef CLIENTPACKET_HPP_
+#define CLIENTPACKET_HPP_
+
+#include "serial_packet_base.hpp"
+
+struct ClientPacket : SerialPacketBase {
+	int clientIndex;
+	int accountIndex;
+	char username[PACKET_STRING_SIZE];
+};
+
+void serializeClient(void* buffer, ClientPacket* packet);
+void deserializeClient(void* buffer, ClientPacket* packet);
+
+#endif

common/network/packet_types/makefile

@@ -0,0 +1,37 @@
+#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))
+
+#output
+OUTDIR=../../..
+OUT=$(addprefix $(OUTDIR)/,libcommon.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 $@ $<
+
+clean:
+	$(RM) *.o *.a *.exe
+
+rebuild: clean all

common/network/packet_types/monster_packet.cpp

@@ -0,0 +1,76 @@
+/* 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 "monster_packet.hpp"
+
+#include "serial_utility.hpp"
+
+void serializeMonster(void* buffer, MonsterPacket* packet) {
+	serialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//identify the monster
+	serialCopy(&buffer, &packet->monsterIndex, 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));
+
+	//attack data
+	//TODO
+}
+
+void deserializeMonster(void* buffer, MonsterPacket* packet) {
+	deserialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//identify the monster
+	deserialCopy(&buffer, &packet->monsterIndex, 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));
+
+	//attack data
+	//TODO
+}

common/network/packet_types/monster_packet.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.
+*/
+#ifndef MONSTERPACKET_HPP_
+#define MONSTERPACKET_HPP_
+
+#include "serial_packet_base.hpp"
+
+#include "bounding_box.hpp"
+#include "vector2.hpp"
+
+struct MonsterPacket : SerialPacketBase {
+	//identify the monster
+	int monsterIndex;
+	char handle[PACKET_STRING_SIZE];
+	char avatar[PACKET_STRING_SIZE];
+	BoundingBox bounds;
+
+	//location
+	int roomIndex;
+	Vector2 origin;
+	Vector2 motion;
+
+	//TODO: attack data
+};
+
+void serializeMonster(void* buffer, MonsterPacket* packet);
+void deserializeMonster(void* buffer, MonsterPacket* packet);
+
+#endif

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,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.
+*/
+#ifndef REGIONPACKET_HPP_
+#define REGIONPACKET_HPP_
+
+#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);
+
+#endif

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,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.
+*/
+#ifndef SERIALPACKETBASE_HPP_
+#define SERIALPACKETBASE_HPP_
+
+#include "serial_packet_type.hpp"
+
+#include "SDL/SDL_net.h"
+
+constexpr int PACKET_STRING_SIZE = 100;
+
+struct SerialPacketBase {
+	//members
+	SerialPacketType type;
+	IPaddress srcAddress;
+
+	virtual ~SerialPacketBase() {};
+};
+
+#endif

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->name, PACKET_STRING_SIZE);
+	serialCopy(&buffer, &packet->playerCount, sizeof(int));
+	serialCopy(&buffer, &packet->version, sizeof(int));
+}
+
+void deserializeServer(void* buffer, ServerPacket* packet) {
+	deserialCopy(&buffer, &packet->type, sizeof(SerialPacketType));
+
+	//identify the server
+	deserialCopy(&buffer, packet->name, PACKET_STRING_SIZE);
+	deserialCopy(&buffer, &packet->playerCount, sizeof(int));
+	deserialCopy(&buffer, &packet->version, sizeof(int));
+}

common/network/packet_types/server_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.
+*/
+#ifndef SERVERPACKET_HPP_
+#define SERVERPACKET_HPP_
+
+#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);
+
+#endif

common/network/packet_types/text_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 "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);
+}
+
+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);
+}

common/network/packet_types/text_packet.hpp

@@ -0,0 +1,35 @@
+/* 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.
+*/
+#ifndef TEXTPACKET_HPP_
+#define TEXTPACKET_HPP_
+
+#include "serial_packet_base.hpp"
+
+struct TextPacket : SerialPacketBase {
+	char name[PACKET_STRING_SIZE];
+	char text[PACKET_STRING_SIZE];
+};
+
+void serializeText(void* buffer, TextPacket* packet);
+void deserializeText(void* buffer, TextPacket* packet);
+
+#endif

common/network/serial_packet.hpp

@@ -0,0 +1,66 @@
+/* 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.
+*/
+#ifndef SERIALPACKET_HPP_
+#define SERIALPACKET_HPP_
+
+#include "serial_packet_base.hpp"
+#include "character_packet.hpp"
+#include "client_packet.hpp"
+#include "monster_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 = -1;
+
+union MaxPacket {
+	CharacterPacket a;
+	ClientPacket b;
+	MonsterPacket 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;
+
+#endif

common/network/serial_packet_type.hpp

@@ -0,0 +1,150 @@
+/* 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.
+*/
+#ifndef SERIALPACKETTYPE_HPP_
+#define SERIALPACKETTYPE_HPP_
+
+/* 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.
+*/
+
+//TODO: This needs to be smoothed out
+enum class SerialPacketType {
+	//default: there is something wrong
+	NONE,
+
+	//-------------------------
+	//ServerPacket
+	//  name, player count, version
+	//-------------------------
+
+	//heartbeat
+	PING,
+	PONG,
+
+	//Used for finding available servers
+	BROADCAST_REQUEST,
+	BROADCAST_RESPONSE,
+
+	//-------------------------
+	//ClientPacket
+	//  client index, account index, username
+	//-------------------------
+
+	//Connecting to a server as a client
+	JOIN_REQUEST,
+	JOIN_RESPONSE,
+
+	//disconnect from the server
+	DISCONNECT_REQUEST,
+	DISCONNECT_RESPONSE,
+	DISCONNECT_FORCED,
+
+	//load the account
+	LOGIN_REQUEST,
+	LOGIN_RESPONSE,
+
+	//unload the account
+	LOGOUT_REQUEST,
+	LOGOUT_RESPONSE,
+
+	//shut down the server
+	SHUTDOWN_REQUEST,
+
+	//-------------------------
+	//RegionPacket
+	//  room index, x, y, raw data
+	//-------------------------
+
+	//map data
+	REGION_REQUEST, //NOTE: technically a query
+	REGION_CONTENT,
+
+	//-------------------------
+	//CharacterPacket
+	//  character index,
+	//  handle, avatar,
+	//  account index (owner),
+	//  room index, origin, motion,
+	//  statistics
+	//-------------------------
+
+	//character management
+	CHARACTER_CREATE,
+	CHARACTER_DELETE,
+	CHARACTER_LOAD,
+	CHARACTER_UNLOAD,
+
+	//find out info from the server
+	QUERY_CHARACTER_EXISTS,
+	QUERY_CHARACTER_STATS,
+	QUERY_CHARACTER_LOCATION,
+
+	//set the info in the server
+	CHARACTER_MOVEMENT,
+	CHARACTER_ATTACK,
+
+	//admin control
+//	ADMIN_SET_CHARACTER_ORIGIN,
+
+	//-------------------------
+	//MonsterPacket
+	//  monster index,
+	//  handle, avatar, hitbox
+	//  room index, origin, motion
+	//  TODO: attack data
+	//-------------------------
+
+	MONSTER_CREATE,
+	MONSTER_DELETE,
+
+	QUERY_MONSTER_EXISTS, //a list of monsters in a room
+	QUERY_MONSTER_STATS, //statistics of a specific monster type or instance
+	QUERY_MONSTER_LOCATION, //umm...
+
+	MONSTER_MOVEMENT, //monster movement
+	MONSTER_ATTACK,
+
+	//-------------------------
+	//TextPacket
+	//  name, text
+	//-------------------------
+
+	//general speech
+	TEXT_BROADCAST,
+
+	//rejection/error messages
+	JOIN_REJECTION,
+	LOGIN_REJECTION,
+	REGION_REJECTION,
+	CHARACTER_REJECTION,
+	MONSTER_REJECTION,
+	SHUTDOWN_REJECTION,
+
+	//-------------------------
+	//not used
+	//-------------------------
+
+	LAST
+};
+
+#endif

common/network/serial_utility.cpp

@@ -0,0 +1,162 @@
+/* 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 "monster_packet.hpp"
+#include "region_packet.hpp"
+#include "server_packet.hpp"
+#include "text_packet.hpp"
+
+#include <cstring>
+
+//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) {
+	switch(packet->type) {
+		case SerialPacketType::PING:
+		case SerialPacketType::PONG:
+		case SerialPacketType::BROADCAST_REQUEST:
+		case SerialPacketType::BROADCAST_RESPONSE:
+			serializeServer(buffer, static_cast<ServerPacket*>(packet));
+		break;
+		case SerialPacketType::JOIN_REQUEST:
+		case SerialPacketType::JOIN_RESPONSE:
+		case SerialPacketType::DISCONNECT_REQUEST:
+		case SerialPacketType::DISCONNECT_RESPONSE:
+		case SerialPacketType::DISCONNECT_FORCED:
+		case SerialPacketType::LOGIN_REQUEST:
+		case SerialPacketType::LOGIN_RESPONSE:
+		case SerialPacketType::LOGOUT_REQUEST:
+		case SerialPacketType::LOGOUT_RESPONSE:
+		case SerialPacketType::SHUTDOWN_REQUEST:
+			serializeClient(buffer, static_cast<ClientPacket*>(packet));
+		break;
+		case SerialPacketType::REGION_REQUEST:
+		case SerialPacketType::REGION_CONTENT:
+			serializeRegion(buffer, static_cast<RegionPacket*>(packet));
+		break;
+		case SerialPacketType::CHARACTER_CREATE:
+		case SerialPacketType::CHARACTER_DELETE:
+		case SerialPacketType::CHARACTER_LOAD:
+		case SerialPacketType::CHARACTER_UNLOAD:
+		case SerialPacketType::QUERY_CHARACTER_EXISTS:
+		case SerialPacketType::QUERY_CHARACTER_STATS:
+		case SerialPacketType::QUERY_CHARACTER_LOCATION:
+		case SerialPacketType::CHARACTER_MOVEMENT:
+		case SerialPacketType::CHARACTER_ATTACK:
+			serializeCharacter(buffer, static_cast<CharacterPacket*>(packet));
+		break;
+		case SerialPacketType::MONSTER_CREATE:
+		case SerialPacketType::MONSTER_DELETE:
+		case SerialPacketType::QUERY_MONSTER_EXISTS:
+		case SerialPacketType::QUERY_MONSTER_STATS:
+		case SerialPacketType::QUERY_MONSTER_LOCATION:
+		case SerialPacketType::MONSTER_MOVEMENT:
+		case SerialPacketType::MONSTER_ATTACK:
+			serializeMonster(buffer, static_cast<MonsterPacket*>(packet));
+		break;
+		case SerialPacketType::TEXT_BROADCAST:
+		case SerialPacketType::JOIN_REJECTION:
+		case SerialPacketType::LOGIN_REJECTION:
+		case SerialPacketType::REGION_REJECTION:
+		case SerialPacketType::CHARACTER_REJECTION:
+		case SerialPacketType::MONSTER_REJECTION:
+		case SerialPacketType::SHUTDOWN_REJECTION:
+			serializeText(buffer, static_cast<TextPacket*>(packet));
+		break;
+	}
+}
+
+void deserializePacket(void* buffer, SerialPacketBase* packet) {
+	//find the type, so that you can actually deserialize the packet!
+	SerialPacketType type;
+	memcpy(&type, buffer, sizeof(SerialPacketType));
+
+	switch(type) {
+		case SerialPacketType::PING:
+		case SerialPacketType::PONG:
+		case SerialPacketType::BROADCAST_REQUEST:
+		case SerialPacketType::BROADCAST_RESPONSE:
+			deserializeServer(buffer, static_cast<ServerPacket*>(packet));
+		break;
+		case SerialPacketType::JOIN_REQUEST:
+		case SerialPacketType::JOIN_RESPONSE:
+		case SerialPacketType::DISCONNECT_REQUEST:
+		case SerialPacketType::DISCONNECT_RESPONSE:
+		case SerialPacketType::DISCONNECT_FORCED:
+		case SerialPacketType::LOGIN_REQUEST:
+		case SerialPacketType::LOGIN_RESPONSE:
+		case SerialPacketType::LOGOUT_REQUEST:
+		case SerialPacketType::LOGOUT_RESPONSE:
+		case SerialPacketType::SHUTDOWN_REQUEST:
+			deserializeClient(buffer, static_cast<ClientPacket*>(packet));
+		break;
+		case SerialPacketType::REGION_REQUEST:
+		case SerialPacketType::REGION_CONTENT:
+			deserializeRegion(buffer, static_cast<RegionPacket*>(packet));
+		break;
+		case SerialPacketType::CHARACTER_CREATE:
+		case SerialPacketType::CHARACTER_DELETE:
+		case SerialPacketType::CHARACTER_LOAD:
+		case SerialPacketType::CHARACTER_UNLOAD:
+		case SerialPacketType::QUERY_CHARACTER_EXISTS:
+		case SerialPacketType::QUERY_CHARACTER_STATS:
+		case SerialPacketType::QUERY_CHARACTER_LOCATION:
+		case SerialPacketType::CHARACTER_MOVEMENT:
+		case SerialPacketType::CHARACTER_ATTACK:
+			deserializeCharacter(buffer, static_cast<CharacterPacket*>(packet));
+		break;
+		case SerialPacketType::MONSTER_CREATE:
+		case SerialPacketType::MONSTER_DELETE:
+		case SerialPacketType::QUERY_MONSTER_EXISTS:
+		case SerialPacketType::QUERY_MONSTER_STATS:
+		case SerialPacketType::QUERY_MONSTER_LOCATION:
+		case SerialPacketType::MONSTER_MOVEMENT:
+		case SerialPacketType::MONSTER_ATTACK:
+			deserializeMonster(buffer, static_cast<MonsterPacket*>(packet));
+		break;
+		case SerialPacketType::TEXT_BROADCAST:
+		case SerialPacketType::JOIN_REJECTION:
+		case SerialPacketType::LOGIN_REJECTION:
+		case SerialPacketType::REGION_REJECTION:
+		case SerialPacketType::CHARACTER_REJECTION:
+		case SerialPacketType::MONSTER_REJECTION:
+		case SerialPacketType::SHUTDOWN_REJECTION:
+			deserializeText(buffer, static_cast<TextPacket*>(packet));
+		break;
+	}
+}

common/network/serial_utility.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.
+*/
+#ifndef SERIALIZEUTILITY_HPP_
+#define SERIALIZEUTILITY_HPP_
+
+#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);
+
+#endif

common/network/udp_network_utility.cpp

@@ -0,0 +1,225 @@
+/* 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 "udp_network_utility.hpp"
+
+#include "serial_packet.hpp"
+#include "serial_utility.hpp"
+
+#include <stdexcept>
+
+//DOCS: memset() is used before sending a packet to remove old data; you don't want to send sensitive data over the network
+//NOTE: don't confuse SerialPacketBase with UDPpacket
+
+void UDPNetworkUtility::Open(int port) {
+	socket = SDLNet_UDP_Open(port);
+	packet = SDLNet_AllocPacket(PACKET_BUFFER_SIZE);
+	if (!socket || !packet) {
+		Close();
+		throw(std::runtime_error("Failed to open UDPNetworkUtility"));
+	}
+}
+
+void UDPNetworkUtility::Close() {
+	SDLNet_UDP_Close(socket);
+	SDLNet_FreePacket(packet);
+	socket = nullptr;
+	packet = nullptr;
+}
+
+//-------------------------
+//bind to a channel
+//-------------------------
+
+int UDPNetworkUtility::Bind(const char* ip, int port, int channel) {
+	IPaddress add;
+	if (SDLNet_ResolveHost(&add, ip, port) == -1) {
+		throw(std::runtime_error("Failed to resolve a host"));
+	}
+
+	return Bind(add, channel);
+}
+
+int UDPNetworkUtility::Bind(IPaddress add, int channel) {
+	int ret = SDLNet_UDP_Bind(socket, channel, &add);
+
+	if (ret < 0) {
+		throw(std::runtime_error("Failed to bind to a channel"));
+	}
+
+	return ret;
+}
+
+void UDPNetworkUtility::Unbind(int channel) {
+	SDLNet_UDP_Unbind(socket, channel);
+}
+
+//-------------------------
+//send a buffer
+//-------------------------
+
+int UDPNetworkUtility::SendTo(const char* ip, int port, void* data, int len) {
+	IPaddress add;
+	if (SDLNet_ResolveHost(&add, ip, port) == -1) {
+		throw(std::runtime_error("Failed to resolve a host"));
+	}
+
+	SendTo(add, data, len);
+}
+
+int UDPNetworkUtility::SendTo(IPaddress add, void* data, int len) {
+	if (len > packet->maxlen) {
+		throw(std::runtime_error("The buffer is to large for the UDPpacket"));
+	}
+	memset(packet->data, 0, packet->maxlen);
+	memcpy(packet->data, data, len);
+	packet->len = len;
+	packet->address = add;
+
+	int ret = SDLNet_UDP_Send(socket, -1, packet);
+
+	if (ret <= 0) {
+		throw(std::runtime_error("Failed to send a packet"));
+	}
+
+	return ret;
+}
+
+int UDPNetworkUtility::SendTo(int channel, void* data, int len) {
+	if (len > packet->maxlen) {
+		throw(std::runtime_error("The buffer is to large for the UDPpacket"));
+	}
+	memset(packet->data, 0, packet->maxlen);
+	memcpy(packet->data, data, len);
+	packet->len = len;
+
+	int ret = SDLNet_UDP_Send(socket, channel, packet);
+
+	if (ret <= 0) {
+		throw(std::runtime_error("Failed to send a packet"));
+	}
+
+	return ret;
+}
+
+int UDPNetworkUtility::SendToAllChannels(void* data, int len) {
+	if (len > packet->maxlen) {
+		throw(std::runtime_error("The buffer is to large for the UDPpacket"));
+	}
+	memset(packet->data, 0, packet->maxlen);
+	memcpy(packet->data, data, len);
+	packet->len = len;
+
+	int sent = 0;
+
+	//send to all bound channels
+	for (int i = 0; i < SDLNET_MAX_UDPCHANNELS; i++) {
+		if (SDLNet_UDP_GetPeerAddress(socket, i)) {
+			sent += SDLNet_UDP_Send(socket, i, packet);
+		}
+	}
+
+	return sent;
+}
+
+//TODO: put a void* and int* parameter list here
+int UDPNetworkUtility::Receive() {
+	memset(packet->data, 0, packet->maxlen);
+	int ret = SDLNet_UDP_Recv(socket, packet);
+
+	if (ret < 0) {
+		throw(std::runtime_error("Unknown network error occured"));
+	}
+
+	return ret;
+}
+
+//-------------------------
+//send a SerialPacketBase
+//-------------------------
+
+int UDPNetworkUtility::SendTo(const char* ip, int port, SerialPacketBase* serialPacket) {
+	IPaddress add;
+	if (SDLNet_ResolveHost(&add, ip, port) == -1) {
+		throw(std::runtime_error("Failed to resolve a host"));
+	}
+
+	SendTo(add, serialPacket);
+}
+
+int UDPNetworkUtility::SendTo(IPaddress add, SerialPacketBase* serialPacket) {
+	memset(packet->data, 0, packet->maxlen);
+	serializePacket(packet->data, serialPacket);
+	packet->len = PACKET_BUFFER_SIZE;
+	packet->address = add;
+
+	int ret = SDLNet_UDP_Send(socket, -1, packet);
+
+	if (ret <= 0) {
+		throw(std::runtime_error("Failed to send a packet"));
+	}
+
+	return ret;
+}
+
+int UDPNetworkUtility::SendTo(int channel, SerialPacketBase* serialPacket) {
+	memset(packet->data, 0, packet->maxlen);
+	serializePacket(packet->data, serialPacket);
+	packet->len = PACKET_BUFFER_SIZE;
+
+	int ret = SDLNet_UDP_Send(socket, channel, packet);
+
+	if (ret <= 0) {
+		throw(std::runtime_error("Failed to send a packet"));
+	}
+
+	return ret;
+}
+
+int UDPNetworkUtility::SendToAllChannels(SerialPacketBase* serialPacket) {
+	memset(packet->data, 0, packet->maxlen);
+	serializePacket(packet->data, serialPacket);
+	packet->len = PACKET_BUFFER_SIZE;
+
+	int sent = 0;
+
+	//send to all bound channels
+	for (int i = 0; i < SDLNET_MAX_UDPCHANNELS; i++) {
+		if (SDLNet_UDP_GetPeerAddress(socket, i)) {
+			sent += SDLNet_UDP_Send(socket, i, packet);
+		}
+	}
+
+	return sent;
+}
+
+int UDPNetworkUtility::Receive(SerialPacketBase* serialPacket) {
+	memset(packet->data, 0, packet->maxlen);
+	int ret = SDLNet_UDP_Recv(socket, packet);
+	deserializePacket(packet->data, serialPacket);
+	serialPacket->srcAddress = packet->address;
+
+	if (ret < 0) {
+		throw(std::runtime_error("Unknown network error occured"));
+	}
+
+	return ret;
+}

common/network/udp_network_utility.hpp

@@ -0,0 +1,77 @@
+/* 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.
+*/
+#ifndef UDPNETWORKUTILITY_HPP_
+#define UDPNETWORKUTILITY_HPP_
+
+//common
+#include "serial_packet_base.hpp"
+#include "singleton.hpp"
+
+//APIs
+#include "SDL/SDL_net.h"
+
+class UDPNetworkUtility : public Singleton<UDPNetworkUtility> {
+public:
+	void Open(int port);
+	void Close();
+
+	//bind to a channel
+	int Bind(const char* ip, int port, int channel = -1);
+	int Bind(IPaddress add, int channel = -1);
+	void Unbind(int channel);
+
+	IPaddress* GetIPAddress(int channel) {
+		return SDLNet_UDP_GetPeerAddress(socket, channel);
+	}
+
+	//send a buffer
+	int SendTo(const char* ip, int port, void* data, int len);
+	int SendTo(IPaddress add, void* data, int len);
+	int SendTo(int channel, void* data, int len);
+	int SendToAllChannels(void* data, int len);
+	int Receive();
+
+	//send a SerialPacketBase
+	int SendTo(const char* ip, int port, SerialPacketBase* serialPacket);
+	int SendTo(IPaddress add, SerialPacketBase* serialPacket);
+	int SendTo(int channel, SerialPacketBase* serialPacket);
+	int SendToAllChannels(SerialPacketBase* serialPacket);
+	int Receive(SerialPacketBase* serialPacket);
+
+	//accessors
+	UDPpacket* GetPacket() const {
+		return packet;
+	}
+	UDPsocket GetSocket() const {
+		return socket;
+	}
+private:
+	friend Singleton<UDPNetworkUtility>;
+
+	UDPNetworkUtility() = default;
+	~UDPNetworkUtility() = default;
+
+	UDPsocket socket = nullptr;
+	UDPpacket* packet = nullptr;
+};
+
+#endif

common/ui/button.cpp

@@ -0,0 +1,81 @@
+/* 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>
+
+Button::State Button::MouseMotion(SDL_MouseMotionEvent const& motion) {
+	return CalcState(motion.x, motion.y, motion.state & SDL_BUTTON_LMASK);
+}
+
+Button::State Button::MouseButtonDown(SDL_MouseButtonEvent const& button) {
+	if (button.button == SDL_BUTTON_LEFT) {
+		return CalcState(button.x, button.y, true);
+	}
+	return state;
+}
+
+Button::State Button::MouseButtonUp(SDL_MouseButtonEvent const& button) {
+	if (button.button == SDL_BUTTON_LEFT) {
+		return CalcState(button.x, button.y, false);
+	}
+	return state;
+}
+
+void Button::DrawTo(SDL_Surface* const dest) {
+	if (!image || !font) {
+		throw(std::runtime_error("Surface not set for Button"));
+	}
+	image->SetClipY(state * image->GetClipH());
+	image->DrawTo(dest, x, y);
+	font->DrawStringTo(text, dest, textX + x, textY + y);
+}
+
+std::string Button::SetText(std::string t) {
+	if (!image || !font) {
+		throw(std::runtime_error("Surface not set for Button"));
+	}
+	//one line, cache the position
+	text = t;
+	textX = (image->GetClipW() / 2) - (font->GetCharW() * text.size() / 2);
+	textY = (image->GetClipH() / 2) - (font->GetCharH() / 2);
+	return text;
+}
+
+Button::State Button::CalcState(Sint16 i, Sint16 j, bool leftPressed) {
+	if (!image || !font) {
+		throw(std::runtime_error("Surface not set for Button"));
+	}
+	//if out of bounds
+	if (i < x || i >= (x + image->GetClipW()) ||
+		j < y || j >= (y + image->GetClipH())
+		) {
+		return state = State::NORMAL;
+	}
+
+	if (leftPressed) {
+		return state = State::PRESSED;
+	}
+	else {
+		return state = State::HOVER;
+	}
+}

common/ui/button.hpp

@@ -0,0 +1,94 @@
+/* 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.
+*/
+#ifndef BUTTON_HPP_
+#define BUTTON_HPP_
+
+#include "image.hpp"
+#include "raster_font.hpp"
+
+#include <string>
+
+/* 3-phases, no toggle, centred text
+ * This class uses the size of the provided image as its bounds. Also,
+ * The provided image should be formatted correctly.
+ *
+ * The button's image should be divided into 3 sections virtucally,
+ * which act as the different button images. The clip width & height of the
+ * Image should be set manually, and the height should be 1/3 of the total
+ * graphical data.
+*/
+class Button {
+public:
+	enum State {
+		NORMAL = 0, HOVER = 1, PRESSED = 2
+	};
+
+	Button() = default;
+	~Button() = default;
+
+	//handle input
+	State MouseMotion(SDL_MouseMotionEvent const&);
+	State MouseButtonDown(SDL_MouseButtonEvent const&);
+	State MouseButtonUp(SDL_MouseButtonEvent const&);
+
+	//yet another draw function
+	void DrawTo(SDL_Surface* const);
+
+	//accessors and mutators
+	Image* SetImage(Image* const ptr) { return image = ptr; }
+	Image* GetImage() { return image; }
+	RasterFont* SetFont(RasterFont* const ptr) { return font = ptr; }
+	RasterFont* GetFont() { return font; }
+
+	Sint16 SetX(Sint16 i) { return x = i; }
+	Sint16 SetY(Sint16 i) { return y = i; }
+	Sint16 GetX() const { return x; }
+	Sint16 GetY() const { return y; }
+
+	Sint16 SetTextX(Sint16 i) { return textX = i; }
+	Sint16 SetTextY(Sint16 i) { return textY = i; }
+	Sint16 GetTextX() const { return textX; }
+	Sint16 GetTextY() const { return textY; }
+
+	State SetState(State s) { return state = s; }
+	State GetState() const { return state; }
+
+	std::string SetText(std::string);
+	std::string GetText() const { return text; }
+
+private:
+	State CalcState(Sint16 x, Sint16 y, bool leftPressed);
+
+	//point to the provided external objects
+	Image* image = nullptr;
+	RasterFont* font = nullptr;
+
+	//positions
+	Sint16 x = 0, y = 0;
+	Sint16 textX = 0, textY = 0;
+
+	//
+	State state = State::NORMAL;
+	std::string text;
+};
+
+#endif

common/ui/makefile

@@ -0,0 +1,37 @@
+#config
+INCLUDES+=. ../graphics
+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)/,libcommon.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 $@ $<
+
+clean:
+	$(RM) *.o *.a *.exe
+
+rebuild: clean all

common/ui/menu_bar.cpp

@@ -0,0 +1,139 @@
+/* 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 "menu_bar.hpp"
+
+#include <stdexcept>
+#include <sstream>
+
+void MenuBar::DrawTo(SDL_Surface* const dest) {
+	for (auto& i : entries) {
+		i.DrawTo(dest);
+	}
+}
+
+void MenuBar::MouseMotion(SDL_MouseMotionEvent const& motion) {
+	for (auto& i : entries) {
+		i.MouseMotion(motion);
+	}
+}
+
+void MenuBar::MouseButtonDown(SDL_MouseButtonEvent const& button) {
+	for (auto& i : entries) {
+		i.MouseButtonDown(button);
+	}
+}
+
+void MenuBar::MouseButtonUp(SDL_MouseButtonEvent const& button, int* entry, int* butt) {
+	*entry = *butt = -1;
+	int ret = -1;
+	for (auto& i : entries) {
+		ret = i.MouseButtonUp(button);
+
+		if (ret != -1) {
+			*entry = (&i - entries.data());
+			*butt = ret;
+		}
+	}
+}
+
+void MenuBar::SetEntries(std::vector<std::vector<std::string>> info) {
+	if (!image || !font) {
+		throw(std::runtime_error("Surfaces not loaded into the menu bar"));
+	}
+
+	entries.clear();
+	for (int i = 0; i < info.size(); i++) {
+		//create the entry & the main button
+		entries.push_back(MenuBarEntry());
+		entries[i].mainButton.SetImage(image);
+		entries[i].mainButton.SetFont(font);
+		entries[i].mainButton.SetText(info[i][0]);
+		entries[i].mainButton.SetX(i * image->GetClipW());
+		entries[i].mainButton.SetY(0);
+		for (int j = 0; j < info[i].size()-1; j++) {
+			//create each drop button in this entry
+			entries[i].dropButtons.push_back(Button());
+			entries[i].dropButtons[j].SetImage(image);
+			entries[i].dropButtons[j].SetFont(font);
+			entries[i].dropButtons[j].SetText(info[i][j+1]);
+			entries[i].dropButtons[j].SetX(i * image->GetClipW());
+			entries[i].dropButtons[j].SetY((j+1) * image->GetClipH());
+		}
+	}
+}
+
+void MenuBar::MenuBarEntry::DrawTo(SDL_Surface* const dest) {
+	//only draw the dropButtons in the user has this menu open
+	mainButton.DrawTo(dest);
+
+	if (!open) {
+		return;
+	}
+
+	for (auto& i : dropButtons) {
+		i.DrawTo(dest);
+	}
+}
+
+void MenuBar::MenuBarEntry::MouseMotion(SDL_MouseMotionEvent const& motion) {
+	//open the menu
+	bool o = mainButton.MouseMotion(motion) == Button::State::PRESSED;
+
+	if (!(open |= o)) {
+		return;
+	}
+
+	for (auto& i : dropButtons) {
+		//dragging down the menu
+		o |= i.MouseMotion(motion) == Button::State::PRESSED;
+	}
+
+	open = o;
+}
+
+void MenuBar::MenuBarEntry::MouseButtonDown(SDL_MouseButtonEvent const& button) {
+	//open the menu
+	if (!(open = mainButton.MouseButtonDown(button) == Button::State::PRESSED)) {
+		return;
+	}
+
+	//update the others anyway
+	for (auto& i : dropButtons) {
+		i.MouseButtonDown(button);
+	}
+}
+
+int MenuBar::MenuBarEntry::MouseButtonUp(SDL_MouseButtonEvent const& button) {
+	int ret = -1;
+	mainButton.MouseButtonUp(button);
+
+	for (auto& i : dropButtons) {
+		//the user just released this button
+		if (i.GetState() != i.MouseButtonUp(button) && i.GetState() == Button::State::HOVER && open) {
+			//get this button's index
+			ret = (&i - dropButtons.data());
+		}
+	}
+
+	open = false;
+	return ret;
+}

common/ui/menu_bar.hpp

@@ -0,0 +1,92 @@
+/* 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.
+*/
+#ifndef MENUBAR_HPP_
+#define MENUBAR_HPP_
+
+#include "image.hpp"
+#include "raster_font.hpp"
+#include "button.hpp"
+
+#include <string>
+#include <vector>
+
+/* I've redesigned this so that the contents of the menu bar can't change during run time.
+ * This is more restrictive but I'm focusing on getting this working first.
+ * The Image and Font pointers must be set before the text data is entered.
+ * 
+ * This class needs a rewrite.
+*/
+
+//TODO: This thing is fucking terrible, fix it and the button class
+class MenuBar {
+public:
+	MenuBar() = default;
+	~MenuBar() = default;
+
+	//yet another draw function
+	void DrawTo(SDL_Surface* const dest);
+
+	//user inputs
+	void MouseMotion(SDL_MouseMotionEvent const&);
+	void MouseButtonDown(SDL_MouseButtonEvent const&);
+	void MouseButtonUp(SDL_MouseButtonEvent const&, int* entry, int* button);
+
+	//manage the entries & buttons
+	void SetEntries(std::vector<std::vector<std::string>> info);
+	void ClearEntries() { entries.clear(); }
+
+	//Accessors and mutators
+	Image* SetImage(Image* const ptr) { return image = ptr; }
+	Image* GetImage() { return image; }
+	RasterFont* SetFont(RasterFont* const ptr) { return font = ptr; }
+	RasterFont* GetFont() { return font; }
+
+private:
+	class MenuBarEntry;
+
+	std::vector<MenuBarEntry> entries;
+
+	Image* image = nullptr;
+	RasterFont* font = nullptr;
+};
+
+class MenuBar::MenuBarEntry {
+public:
+	MenuBarEntry() = default;
+	~MenuBarEntry() = default;
+
+	void DrawTo(SDL_Surface* const dest);
+
+	void MouseMotion(SDL_MouseMotionEvent const&);
+	void MouseButtonDown(SDL_MouseButtonEvent const&);
+	int MouseButtonUp(SDL_MouseButtonEvent const&);
+
+private:
+	Button mainButton;
+
+	std::vector<Button> dropButtons;
+	bool open = false;
+
+	friend class MenuBar;
+};
+
+#endif

common/ui/raster_font.cpp

@@ -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.
+*/
+#include "raster_font.hpp"
+
+#include <stdexcept>
+
+/* It might be more efficient to render to a different surface (like an Image)
+ * rather than calling this function with all of it's '%' and '/'.
+*/
+
+void RasterFont::DrawStringTo(std::string s, SDL_Surface* const dest, Sint16 x, Sint16 y) {
+	if (!image.GetSurface()) {
+		throw(std::runtime_error("RasterFont not loaded"));
+	}
+	const Uint16 w = image.GetClipW();
+	const Uint16 h = image.GetClipH();
+	for (int i = 0; i < s.size(); i++) {
+		image.SetClipX(s[i] % 16 * w);
+		image.SetClipY(s[i] / 16 * h);
+		image.DrawTo(dest, x + i * w, y);
+	}
+}
+
+/* Note: This class can only take a raster font with 16*16 characters, and the
+ * indevidual characters must have the same dimensions. Overall this class is too
+ * restrictive; I suggest using a 3rd party library.
+*/
+
+SDL_Surface* RasterFont::LoadSurface(std::string fname) {
+	image.LoadSurface(fname);
+	image.SetClipW(image.GetSurface()->w/16);
+	image.SetClipH(image.GetSurface()->h/16);
+	return image.GetSurface();
+}
+
+SDL_Surface* RasterFont::SetSurface(SDL_Surface* p) {
+	image.SetSurface(p);
+	image.SetClipW(image.GetSurface()->w/16);
+	image.SetClipH(image.GetSurface()->h/16);
+	return image.GetSurface();
+}

common/ui/raster_font.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.
+*/
+#ifndef RASTERFONT_HPP_
+#define RASTERFONT_HPP_
+
+#include "image.hpp"
+
+class RasterFont {
+public:
+	RasterFont() = default;
+	RasterFont(RasterFont const& rhs) { *this = rhs; }
+	RasterFont(RasterFont&& rhs) { *this = std::move(rhs); }
+	RasterFont(std::string fname) { LoadSurface(fname); }
+	RasterFont(SDL_Surface* p) { SetSurface(p); }
+	~RasterFont() = default;
+
+	RasterFont& operator=(RasterFont const& rhs) { image = rhs.image; }
+	RasterFont& operator=(RasterFont&& rhs) { image = std::move(rhs.image); }
+
+	void DrawStringTo(std::string, SDL_Surface* const, Sint16 x, Sint16 y);
+
+	//Accessors and Mutators
+	SDL_Surface* LoadSurface(std::string);
+	SDL_Surface* SetSurface(SDL_Surface*);
+	SDL_Surface* GetSurface() const { return image.GetSurface(); }
+	void FreeSurface() { image.FreeSurface(); }
+
+	Uint16 GetCharW() const { return image.GetClipW(); }
+	Uint16 GetCharH() const { return image.GetClipH(); }
+
+private:
+	Image image;
+};
+
+#endif

common/utilities/bounding_box.hpp

@@ -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.
+*/
+#ifndef BOUNDINGBOX_HPP_
+#define BOUNDINGBOX_HPP_
+
+#include "vector2.hpp"
+
+#include <type_traits>
+#include <algorithm>
+
+class BoundingBox {
+public:
+	//This is explicitly a POD
+	int x, y;
+	int w, h;
+
+	BoundingBox() = default;
+	BoundingBox(int i, int j, int k, int l): x(i), y(j), w(k), h(l) {};
+	~BoundingBox() = default;
+	BoundingBox& operator=(BoundingBox const&) = default;
+
+	int Size() {
+		return (w-x) * (h-y);
+	}
+
+	bool CheckCollision(BoundingBox rhs) {
+		return !(
+			x >= rhs.x + rhs.w ||
+			y >= rhs.y + rhs.h ||
+			rhs.x >= x + w ||
+			rhs.y >= y + h);
+	}
+
+	Vector2 CalcShift(BoundingBox rhs) {
+		if (!CheckCollision(rhs)) {
+			return {0, 0};
+		}
+
+		//DOCS: Given two BoundingBox objects, how does the other have to move so that they are no longer colliding?
+		Vector2 horizontal = {0, 0};
+		Vector2 vertical = {0, 0};
+
+		horizontal.x = std::abs(x + w - rhs.x) < std::abs(rhs.x + rhs.w - x) ? x + w - rhs.x -1 : -(rhs.x + rhs.w - x -1);
+		vertical.y = std::abs(y + h - rhs.x) < std::abs(rhs.y + rhs.h - y) ? y + h - rhs.y -1 : -(rhs.y + rhs.h - y -1);
+
+		return std::abs(vertical.y) < std::abs(horizontal.x) ? vertical : horizontal;
+	}
+};
+
+//This is explicitly a POD
+static_assert(std::is_pod<BoundingBox>::value, "BoundingBox is not a POD");
+
+//operators
+inline BoundingBox operator+(BoundingBox b, Vector2 v) {
+	return {b.x + (int)v.x, b.y + (int)v.y, b.w, b.h};
+}
+inline BoundingBox operator+(Vector2 v, BoundingBox b) {
+	return b + v;
+}
+
+#endif

common/utilities/config_utility.cpp

@@ -0,0 +1,188 @@
+/* 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 "config_utility.hpp"
+
+#include <cstdlib>
+#include <cstring>
+#include <fstream>
+#include <sstream>
+#include <stdexcept>
+
+void ConfigUtility::Load(std::string fname, bool skipMissingFile, int argc, char* argv[]) {
+	//clear the stored configuration
+	configMap.clear();
+
+	//use the default file
+	if (argc < 2) {
+		configMap = Read(fname, skipMissingFile);
+		return;
+	}
+
+	//some variables to use
+	table_t redirectedFile;
+	table_t cmdLineParams;
+	char key[256], val[256];
+	bool redirectUsed = false;
+
+	//reading from the command line
+	for (int i = 1; i < argc; ++i) {
+		//read from a specified config file
+		if (!strncmp(argv[i], "-config=", 8)) {
+			//older specified files take precedence
+			table_t tmp = Read(argv[i] + 8, skipMissingFile);
+			redirectedFile.insert(tmp.begin(), tmp.end());
+			redirectUsed = true;
+			continue;
+		}
+
+		//set some specific values
+		if (!strncmp(argv[i], "-", 1)) {
+			//wipe the variables
+			memset(key, 0, 256);
+			memset(key, 0, 256);
+
+			//read the key-value pair
+			if (sscanf(argv[i], "-%[^=]=%[^\0]", key, val) != 2) {
+				std::ostringstream os;
+				os << "Failed to read a command line config argument (expected -%s=%s):" << std::endl;
+				os << "\targv[" << i << "]: " << argv[i] << std::endl;
+				os << "\tkey: " << key << std::endl;
+				os << "\tval: " << val << std::endl;
+				throw(std::runtime_error( os.str() ));
+			}
+			cmdLineParams[key] = val;
+		}
+	}
+
+	//finally, construct the final config table
+	if (!redirectUsed) {
+		redirectedFile = Read(fname, skipMissingFile);
+	}
+	configMap.insert(cmdLineParams.begin(), cmdLineParams.end());
+	configMap.insert(redirectedFile.begin(), redirectedFile.end());
+}
+
+ConfigUtility::table_t ConfigUtility::Read(std::string fname, bool skipMissingFile) {
+	//read in and return this file's data
+	table_t retTable;
+	std::ifstream is(fname);
+
+	if (!is.is_open()) {
+		if (skipMissingFile) {
+			return {}; //empty table
+		}
+		std::ostringstream os;
+		os << "Failed to open a config file: " << fname;
+		throw(std::runtime_error( os.str() ));
+	}
+
+	std::string key, val;
+
+	while(true) { //forever
+		//eat whitespace
+		while(isspace(is.peek())) {
+			is.ignore();
+		}
+
+		//end of file
+		if (is.eof()) {
+			break;
+		}
+
+		//skip comment lines
+		if (is.peek() == '#') {
+			while(is.peek() != '\n' && !is.eof()) {
+				is.ignore();
+			}
+			continue;
+		}
+
+		//read in the pair
+		getline(is, key,'=');
+		getline(is, val);
+
+		//eat the whitespace at the start & end
+		while(key.size() && isspace( *key.begin() )) {
+			key.erase(0, 1);
+		}
+		while(val.size() && isspace( *val.begin() )) {
+			val.erase(0, 1);
+		}
+
+		while(key.size() && isspace( *(key.end()-1) )) {
+			key.erase(key.end() - 1);
+		}
+		while(val.size() && isspace( *(val.end()-1) )) {
+			val.erase(val.end() - 1);
+		}
+
+		//disallow empty/wiped pairs
+		if (key.size() == 0 || val.size() == 0) {
+			continue;
+		}
+
+		//save the pair
+		retTable[key] = val;
+	}
+
+	is.close();
+
+	//load in any subordinate config files
+	if (retTable.find("config.next") != retTable.end()) {
+		table_t subTable = Read(retTable["config.next"], skipMissingFile);
+		retTable.insert(subTable.begin(), subTable.end());
+	}
+
+	return retTable;
+}
+
+//-------------------------
+//Convert to a type
+//-------------------------
+
+std::string& ConfigUtility::String(std::string s) {
+	return configMap[s];
+}
+
+int ConfigUtility::Integer(std::string s) {
+	table_t::iterator it = configMap.find(s);
+	if (it == configMap.end()) {
+		return 0;
+	}
+	return atoi(it->second.c_str());
+}
+
+double ConfigUtility::Double(std::string s) {
+	table_t::iterator it = configMap.find(s);
+	if (it == configMap.end()) {
+		return 0.0;
+	}
+	return atof(it->second.c_str());
+}
+
+bool ConfigUtility::Boolean(std::string s) {
+	table_t::iterator it = configMap.find(s);
+	if (it == configMap.end()) {
+		return false;
+	}
+	return it->second == "true";
+}