Initial commit, read more

After a few days of work, I'm committing what i've done so far. Mostly
I've cherry picked the best parts of the multiplayer branch's modules, and
adapted them for use here. I've written a few new components, and I've
learnt a few things along the way. I may continue with this branch for a
while, before moving the changes into the main branch. Alternatively, it
might turn out that this single player version is more fun. We'll see.

I've swapped the config system for a pure lua version instead. This is
actually fairly flexible. I've also changed the map system and it's API a
great deal. The tile sheet can be loaded from lua, and the save directory
isn't hard coded anymore. I think this would be a good testbed for a lot
of different systems, including the collision system, however the current
system (using vectors) is inadequate. I'll have to dig up the old BBox,
possilby.

This branch will piggy back on the main repo for a while.

src/application.cpp

@@ -0,0 +1,171 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ * 
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial Applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ * 
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ * 
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ * 
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+*/
+#include "application.hpp"
+
+#include <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 "in_world.hpp"
+
+//-------------------------
+//Public access members
+//-------------------------
+
+void Application::Init(int argc, char** argv) {
+	std::cout << "Beginning " << argv[0] << std::endl;
+
+	//-------------------------
+	//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 lua
+	lua = luaL_newstate();
+	if (!lua) {
+		throw(std::runtime_error("Failed to initialize lua"));
+	}
+	luaL_openlibs(lua);
+	std::cout << "Initialized lua" << std::endl;
+
+	if (luaL_dofile(lua, "rsc\\setup.lua")) {
+		throw(std::runtime_error("Failed to initialize lua's startup script"));
+	}
+	std::cout << "Initialized lua's setup script" << std::endl;
+
+	//-------------------------
+	//Setup the screen
+	//-------------------------
+
+	lua_getglobal(lua, "config");
+	lua_getfield(lua, 1, "screen");
+	lua_getfield(lua, 2, "width");
+	lua_getfield(lua, 2, "height");
+	lua_getfield(lua, 2, "fullscreen");
+
+	int w = lua_tointeger(lua, 3);
+	int h = lua_tointeger(lua, 4);
+	int f = lua_toboolean(lua, 5);
+
+	lua_pop(lua, 5);
+
+	BaseScene::SetScreen(w ? w : 800, h ? h : 600, 0, f ? SDL_HWSURFACE|SDL_DOUBLEBUF|SDL_FULLSCREEN : SDL_HWSURFACE|SDL_DOUBLEBUF);
+	std::cout << "Initialized the screen" << std::endl;
+
+	//-------------------------
+	//finalize the startup
+	//-------------------------
+
+	std::cout << "Startup completed successfully" << std::endl;
+
+	//-------------------------
+	//debugging
+	//-------------------------
+
+	//...
+}
+
+void Application::Proc() {
+	LoadScene(SceneList::FIRST);
+
+	//prepare the time system
+	typedef std::chrono::steady_clock Clock;
+
+	std::chrono::duration<int, std::milli> delta(16);
+	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
+		while (simTime < realTime) {
+			//call each user defined function
+			activeScene->RunFrame(double(delta.count()) / std::chrono::duration<int, std::milli>::period::den);
+			simTime += delta;
+		}
+
+		//draw the game to the screen
+		activeScene->RenderFrame();
+	}
+
+	UnloadScene();
+}
+
+void Application::Quit() {
+	std::cout << "Shutting down" << std::endl;
+	lua_close(lua);
+	SDL_Quit();
+	std::cout << "Clean exit" << std::endl;
+}
+
+//-------------------------
+//Private access members
+//-------------------------
+
+void Application::LoadScene(SceneList sceneIndex) {
+	UnloadScene();
+	switch(sceneIndex) {
+		//add scene creation calls here
+		case SceneList::FIRST:
+		case SceneList::SPLASHSCREEN:
+			activeScene = new SplashScreen(lua);
+		break;
+		case SceneList::MAINMENU:
+			activeScene = new MainMenu(lua);
+		break;
+		case SceneList::OPTIONSMENU:
+			activeScene = new OptionsMenu(lua);
+		break;
+		case SceneList::INWORLD:
+			activeScene = new InWorld(lua);
+		break;
+		default:
+			throw(std::logic_error("Failed to recognize the scene index"));
+	}
+}
+
+void Application::UnloadScene() {
+	delete activeScene;
+	activeScene = nullptr;
+}

src/application.hpp

@@ -0,0 +1,49 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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 APPLICATION_HPP_
+#define APPLICATION_HPP_
+
+#include "scene_list.hpp"
+#include "base_scene.hpp"
+
+#include "lua/lua.hpp"
+
+class Application {
+public:
+	Application() = default;
+	~Application() = default;
+
+	void Init(int argc, char** argv);
+	void Proc();
+	void Quit();
+
+private:
+	//Private access members
+	void LoadScene(SceneList sceneIndex);
+	void UnloadScene();
+
+	BaseScene* activeScene = nullptr;
+
+	lua_State* lua = nullptr;
+};
+
+#endif

src/base_scene.cpp

@@ -0,0 +1,139 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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(double delta) {
+	FrameStart();
+	HandleEvents();
+	Update(delta);
+	FrameEnd();
+}
+
+void BaseScene::RenderFrame() {
+	SDL_FillRect(screen, 0, 0);
+	Render(screen);
+	SDL_Flip(screen);
+}
+
+//-------------------------
+//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
+}

src/base_scene.hpp

@@ -0,0 +1,74 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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(double delta);
+	virtual void RenderFrame();
+
+protected:
+	virtual void FrameStart() {}
+	virtual void HandleEvents();
+	virtual void Update(double delta) {}
+	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

src/character.cpp

@@ -0,0 +1,61 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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.hpp"
+
+void Character::Update(double delta) {
+	if (motion.x && motion.y) {
+		origin += motion * delta * CHARACTER_WALKING_MOD;
+	}
+	else if (motion != 0) {
+		origin += motion * delta;
+	}
+	sprite.Update(delta);
+}
+
+void Character::DrawTo(SDL_Surface* const dest, int camX, int camY) {
+	sprite.DrawTo(dest, origin.x - camX, origin.y - camY);
+}
+
+void Character::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);
+	}
+}

src/character.hpp

@@ -0,0 +1,72 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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 CHARACTER_HPP_
+#define CHARACTER_HPP_
+
+//components
+#include "vector2.hpp"
+
+//graphics
+#include "sprite_sheet.hpp"
+
+//std namespace
+#include <cmath>
+
+//the speeds that the characters move
+constexpr double CHARACTER_WALKING_SPEED = 140.0;
+constexpr double CHARACTER_WALKING_MOD = 1.0/sqrt(2.0);
+
+//the bounding boxes for the characters
+constexpr double CHARACTER_BOUNDS_WIDTH = 32.0;
+constexpr double CHARACTER_BOUNDS_HEIGHT = 32.0;
+
+class Character {
+public:
+	Character() = default;
+	~Character() = default;
+
+	void Update(double delta);
+
+	//graphics
+	void DrawTo(SDL_Surface* const, int camX, int camY);
+	void CorrectSprite();
+	SpriteSheet* GetSprite() { return &sprite; }
+
+	//accessors and mutators
+	Vector2 SetOrigin(Vector2 v) { return origin = v; }
+	Vector2 GetOrigin() const { return origin; }
+	Vector2 SetMotion(Vector2 v) { return motion = v; }
+	Vector2 GetMotion() const { return motion; }
+	Vector2 SetBounds(Vector2 v) { return bounds = v; }
+	Vector2 GetBounds() const { return bounds; }
+
+private:
+	//graphics
+	SpriteSheet sprite;
+
+	//position
+	Vector2 origin = {0.0,0.0};
+	Vector2 motion = {0.0,0.0};
+	Vector2 bounds = {CHARACTER_BOUNDS_WIDTH,CHARACTER_BOUNDS_HEIGHT};
+};
+
+#endif

src/graphics/image.cpp

@@ -0,0 +1,145 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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);
+}

src/graphics/image.hpp

@@ -0,0 +1,73 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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

src/graphics/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

src/graphics/sprite_sheet.cpp

@@ -0,0 +1,102 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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;
+}

src/graphics/sprite_sheet.hpp

@@ -0,0 +1,66 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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

src/in_world.cpp

@@ -0,0 +1,249 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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 "utility.hpp"
+#include "check_bounds.hpp"
+
+#include "region_pager_api.hpp"
+#include "tile_sheet_api.hpp"
+
+#include <iostream>
+
+//-------------------------
+//Public access members
+//-------------------------
+
+InWorld::InWorld(lua_State* L): lua(L) {
+	//register the pager
+	lua_pushstring(lua, TORTUGA_REGION_PAGER_PSEUDO_INDEX);
+	lua_pushlightuserdata(lua, &pager);
+	lua_settable(L, LUA_REGISTRYINDEX);
+
+	//register the tilesheet
+	lua_pushstring(lua, TORTUGA_TILE_SHEET_PSEUDO_INDEX);
+	lua_pushlightuserdata(lua, &tileSheet);
+	lua_settable(L, LUA_REGISTRYINDEX);
+
+	//setup the component objecrs
+	pager.SetLuaState(lua);
+
+	//get the config info
+	lua_getglobal(lua, "config");
+	lua_getfield(lua, -1, "dir");
+	lua_getfield(lua, -1, "fonts");
+	std::string fonts = lua_tostring(lua, -1);
+	lua_getfield(lua, -2, "interface");
+	std::string interface = lua_tostring(lua, -1);
+	lua_getfield(lua, -3, "sprites");
+	std::string sprites = lua_tostring(lua, -1);
+	lua_getfield(lua, -4, "scripts");
+	std::string scripts = lua_tostring(lua, -1);
+	lua_pop(lua, 6);
+
+	//run the additional scripts
+	if (luaL_dofile(lua, (scripts + "in_world.lua").c_str())) {
+		throw(std::runtime_error(std::string() + "Failed to run in_world.lua: " + lua_tostring(lua, -1) ));
+	}
+
+	//setup the utility objects
+	buttonImage.LoadSurface(interface + "button_menu.bmp");
+	buttonImage.SetClipH(buttonImage.GetClipH()/3);
+	font.LoadSurface(fonts + "pk_white_8.bmp");
+
+	//pass the utility objects
+	backButton.SetImage(&buttonImage);
+	backButton.SetFont(&font);
+
+	//set the button positions
+	backButton.SetX(50);
+	backButton.SetY(50 + buttonImage.GetClipH() * 0);
+
+	//set the button texts
+	backButton.SetText("Back");
+
+	//entities
+	character.GetSprite()->LoadSurface(sprites + "elliot2.bmp", 4, 4);
+
+	//setup the camera
+	camera.margin.x = GetScreen()->w / 2 - character.GetSprite()->GetImage()->GetClipW() / 2;
+	camera.margin.y = GetScreen()->h / 2 - character.GetSprite()->GetImage()->GetClipH() / 2;
+
+	//debug
+	//
+}
+
+InWorld::~InWorld() {
+	//unregister the map components
+	lua_pushstring(lua, TORTUGA_REGION_PAGER_PSEUDO_INDEX);
+	lua_pushstring(lua, TORTUGA_TILE_SHEET_PSEUDO_INDEX);
+	lua_pushnil(lua);
+	lua_settable(lua, LUA_REGISTRYINDEX);
+	lua_pushnil(lua);
+	lua_settable(lua, LUA_REGISTRYINDEX);
+}
+
+//-------------------------
+//Frame loop
+//-------------------------
+
+void InWorld::FrameStart() {
+	//
+}
+
+void InWorld::Update(double delta) {
+	//update the entities
+	character.Update(delta);
+
+	//check for collisions
+	for (int i = -6; i < 6; ++i) {
+		for (int j = -6; j < 6; ++j) {
+			Vector2 wallPoint = {
+				snapToBase(32.0, character.GetOrigin().x),
+				snapToBase(32.0, character.GetOrigin().y)
+			};
+			wallPoint.x += i * 32;
+			wallPoint.y += j * 32;
+
+			if (!pager.GetSolid(wallPoint.x / 32.0, wallPoint.y / 32.0)) {
+				continue;
+			}
+
+			if (checkOverlap(character.GetOrigin(), character.GetBounds(), wallPoint, {32.0, 32.0})) {
+				std::cout << "1";
+			}
+		}
+	}
+
+	//update the camera
+	camera.origin.x = character.GetOrigin().x - camera.margin.x;
+	camera.origin.y = character.GetOrigin().y - camera.margin.y;
+
+	//TODO: prune distant regions
+
+	//summon nearby unloaded regions
+	const int left = snapToBase(REGION_WIDTH, camera.origin.x / tileSheet.GetTileW());
+	const int top = snapToBase(REGION_HEIGHT, camera.origin.y / tileSheet.GetTileH());
+	const int right = snapToBase(REGION_WIDTH, (camera.origin.x + GetScreen()->w) / tileSheet.GetTileW());
+	const int bottom = snapToBase(REGION_HEIGHT, (camera.origin.y + GetScreen()->h) / tileSheet.GetTileH());
+
+	for (int i = left - REGION_WIDTH; i <= right + REGION_WIDTH; i += REGION_WIDTH) {
+		for (int j = top - REGION_HEIGHT; j <= bottom + REGION_HEIGHT; j += REGION_HEIGHT) {
+			pager.GetRegion(i, j);
+		}
+	}
+}
+
+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 all regions
+	for (std::list<Region>::iterator it = pager.GetContainer()->begin(); it != pager.GetContainer()->end(); it++) {
+		tileSheet.DrawRegionTo(screen, &(*it), camera.origin.x, camera.origin.y);
+	}
+
+	//draw the characters
+	character.DrawTo(screen, camera.origin.x, camera.origin.y);
+
+	//draw the UI
+	backButton.DrawTo(screen);
+	font.DrawStringTo(to_string_custom(fps.GetFrameRate()), screen, 0, 0);
+}
+
+//-------------------------
+//Event handlers
+//-------------------------
+
+void InWorld::QuitEvent() {
+	//exit the game
+	SetNextScene(SceneList::QUIT);
+}
+
+void InWorld::MouseMotion(SDL_MouseMotionEvent const& motion) {
+	backButton.MouseMotion(motion);
+}
+
+void InWorld::MouseButtonDown(SDL_MouseButtonEvent const& button) {
+	backButton.MouseButtonDown(button);
+}
+
+void InWorld::MouseButtonUp(SDL_MouseButtonEvent const& button) {
+	if (backButton.MouseButtonUp(button) == Button::State::HOVER) {
+		SetNextScene(SceneList::MAINMENU);
+	}
+}
+
+void InWorld::KeyDown(SDL_KeyboardEvent const& key) {
+	//player movement
+	Vector2 motion = character.GetMotion();
+	switch(key.keysym.sym) {
+		case SDLK_LEFT:
+			motion.x -= CHARACTER_WALKING_SPEED;
+		break;
+		case SDLK_RIGHT:
+			motion.x += CHARACTER_WALKING_SPEED;
+		break;
+		case SDLK_UP:
+			motion.y -= CHARACTER_WALKING_SPEED;
+		break;
+		case SDLK_DOWN:
+			motion.y += CHARACTER_WALKING_SPEED;
+		break;
+	}
+	if (character.GetMotion() != motion) {
+		character.SetMotion(motion);
+		character.CorrectSprite();
+	}
+}
+
+void InWorld::KeyUp(SDL_KeyboardEvent const& key) {
+	//player movement
+	Vector2 motion = character.GetMotion();
+	switch(key.keysym.sym) {
+		//NOTE: The use of min/max here are to prevent awkward movements
+		case SDLK_LEFT:
+			motion.x = std::min(motion.x + CHARACTER_WALKING_SPEED, 0.0);
+		break;
+		case SDLK_RIGHT:
+			motion.x = std::max(motion.x - CHARACTER_WALKING_SPEED, 0.0);
+		break;
+		case SDLK_UP:
+			motion.y = std::min(motion.y + CHARACTER_WALKING_SPEED, 0.0);
+		break;
+		case SDLK_DOWN:
+			motion.y = std::max(motion.y - CHARACTER_WALKING_SPEED, 0.0);
+		break;
+	}
+	if (character.GetMotion() != motion) {
+		character.SetMotion(motion);
+		character.CorrectSprite();
+	}
+}

src/in_world.hpp

@@ -0,0 +1,93 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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_
+
+//graphics & ui
+#include "image.hpp"
+#include "raster_font.hpp"
+#include "button.hpp"
+
+//map stuff
+#include "tile_sheet.hpp"
+#include "region_pager_lua.hpp"
+
+//entities
+#include "character.hpp"
+
+//utilities
+#include "frame_rate.hpp"
+
+//framework
+#include "base_scene.hpp"
+
+//APIs
+#include "lua/lua.hpp"
+
+class InWorld : public BaseScene {
+public:
+	//Public access members
+	InWorld(lua_State* L);
+	~InWorld();
+
+protected:
+	//Frame loop
+	void FrameStart();
+	void Update(double delta);
+	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&);
+
+	struct {
+		struct {
+			int x, y;
+		}origin, margin;
+	}camera;
+
+	//shared parameters
+	lua_State* lua = nullptr;
+
+	//graphics
+	Image buttonImage;
+	RasterFont font;
+
+	//map stuff
+	TileSheet tileSheet;
+	RegionPagerLua pager;
+
+	//entities
+	Character character;
+
+	//UI
+	Button backButton;
+	FrameRate fps;
+};
+
+#endif

src/linit.cpp

@@ -0,0 +1,85 @@
+/* $Id: linit.c,v 1.32, modified
+ * Initialization of libraries for lua.c and other clients
+ * See Copyright Notice in lua.h
+ * 
+ * If you embed Lua in your program and need to open the standard
+ * libraries, call luaL_openlibs in your program. If you need a
+ * different set of libraries, copy this file to your project and edit
+ * it to suit your needs.
+ * 
+ * Modified for use in Tortuga, renamed to linit.cpp
+ * Modifications are released under the zlib license:
+ * 
+ * Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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.
+*/
+#define linit_c
+#define LUA_LIB
+
+#include "lua/lua.hpp"
+
+#include "region_api.hpp"
+#include "region_pager_api.hpp"
+#include "tile_sheet_api.hpp"
+
+//these libs are loaded by lua.c and are readily available to any Lua program
+static const luaL_Reg loadedlibs[] = {
+	//Standard libs
+	{"_G", luaopen_base},
+	{LUA_LOADLIBNAME, luaopen_package},
+	{LUA_COLIBNAME, luaopen_coroutine},
+	{LUA_TABLIBNAME, luaopen_table},
+	{LUA_IOLIBNAME, luaopen_io},
+	{LUA_OSLIBNAME, luaopen_os},
+	{LUA_STRLIBNAME, luaopen_string},
+	{LUA_BITLIBNAME, luaopen_bit32},
+	{LUA_MATHLIBNAME, luaopen_math},
+	{LUA_DBLIBNAME, luaopen_debug},
+
+	//Tortuga's API
+	{TORTUGA_REGION_NAME, openRegionAPI},
+	{TORTUGA_REGION_PAGER_NAME, openRegionPagerAPI},
+	{TORTUGA_TILE_SHEET_NAME, openTileSheetAPI},
+
+	{NULL, NULL}
+};
+
+
+//these libs are preloaded and must be required before used
+static const luaL_Reg preloadedlibs[] = {
+	{NULL, NULL}
+};
+
+LUALIB_API void luaL_openlibs (lua_State *L) {
+	const luaL_Reg *lib;
+	//call open functions from 'loadedlibs' and set results to global table
+	for (lib = loadedlibs; lib->func; lib++) {
+		luaL_requiref(L, lib->name, lib->func, 1);
+		lua_pop(L, 1); //remove lib
+	}
+	//add open functions from 'preloadedlibs' into 'package.preload' table
+	luaL_getsubtable(L, LUA_REGISTRYINDEX, "_PRELOAD");
+	for (lib = preloadedlibs; lib->func; lib++) {
+		lua_pushcfunction(L, lib->func);
+		lua_setfield(L, -2, lib->name);
+	}
+	lua_pop(L, 1); //remove _PRELOAD table
+}

src/main.cpp

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

src/main_menu.cpp

@@ -0,0 +1,128 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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"
+
+//-------------------------
+//Public access members
+//-------------------------
+
+MainMenu::MainMenu(lua_State* L): lua(L) {
+	//get the config info
+	lua_getglobal(lua, "config");
+	lua_getfield(lua, -1, "dir");
+	lua_getfield(lua, -1, "interface");
+	std::string interface = lua_tostring(lua, -1);
+	lua_getfield(lua, -2, "fonts");
+	std::string fonts = lua_tostring(lua, -1);
+	lua_pop(lua, 4);
+
+	//setup the utility objects
+	image.LoadSurface(interface + "button_menu.bmp");
+	image.SetClipH(image.GetClipH()/3);
+	font.LoadSurface(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(double delta) {
+	//
+}
+
+void MainMenu::FrameEnd() {
+	//
+}
+
+void MainMenu::Render(SDL_Surface* const screen) {
+	startButton.DrawTo(screen);
+	optionsButton.DrawTo(screen);
+	quitButton.DrawTo(screen);
+}
+
+//-------------------------
+//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) {
+	if (startButton.MouseButtonUp(button) == Button::State::HOVER) {
+		SetNextScene(SceneList::INWORLD);
+	}
+	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) {
+	//
+}

src/main_menu.hpp

@@ -0,0 +1,64 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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"
+
+#include "lua/lua.hpp"
+
+class MainMenu : public BaseScene {
+public:
+	//Public access members
+	MainMenu(lua_State* L);
+	~MainMenu();
+
+protected:
+	//Frame loop
+	void FrameStart();
+	void Update(double delta);
+	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&);
+
+	//shared parameters
+	lua_State* lua = nullptr;
+
+	//members
+	Image image;
+	RasterFont font;
+	Button startButton;
+	Button optionsButton;
+	Button quitButton;
+};
+
+#endif

src/makefile

@@ -0,0 +1,41 @@
+#config
+INCLUDES+=. graphics map ui utilities
+LIBS+=libcommon.a -lmingw32 -lSDLmain -lSDL -llua
+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)/,jam)
+
+#targets
+all: $(OBJ) $(OUT)
+	$(MAKE) -C graphics
+	$(MAKE) -C map
+	$(MAKE) -C ui
+	$(MAKE) -C utilities
+	$(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

src/map/makefile

@@ -0,0 +1,37 @@
+#config
+INCLUDES+=. ../graphics ../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

src/map/region.cpp

@@ -0,0 +1,55 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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 "utility.hpp"
+
+#include <stdexcept>
+#include <cstring>
+
+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) {
+	return tiles[x][y][z] = v;
+}
+
+Region::type_t Region::GetTile(int x, int y, int z) {
+	return tiles[x][y][z];
+}
+
+bool Region::SetSolid(int x, int y, bool b) {
+	return solid[x * REGION_WIDTH + y] = b;
+}
+
+bool Region::GetSolid(int x, int y) {
+	return solid[x * REGION_WIDTH + y];
+}

src/map/region.hpp

@@ -0,0 +1,67 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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>
+#include <cmath>
+
+//the region's storage format
+constexpr int REGION_WIDTH = 20;
+constexpr int REGION_HEIGHT = 20;
+constexpr int REGION_DEPTH = 3;
+
+//the size of the solid map
+constexpr int REGION_SOLID_FOOTPRINT = ceil(REGION_WIDTH * REGION_HEIGHT / 8.0);
+
+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 { return x; }
+	int GetY() const { return y; }
+
+	std::bitset<REGION_WIDTH*REGION_HEIGHT>* GetSolidBitset() { return &solid; }
+private:
+	const int x;
+	const int y;
+
+	type_t tiles[REGION_WIDTH][REGION_HEIGHT][REGION_DEPTH];
+	std::bitset<REGION_WIDTH*REGION_HEIGHT> solid;
+};
+
+//the memory footprint of the tile and solid data; not including any metadata
+constexpr int REGION_FOOTPRINT = REGION_WIDTH * REGION_HEIGHT * REGION_DEPTH * sizeof(Region::type_t) + REGION_SOLID_FOOTPRINT;
+
+#endif

src/map/region_api.cpp

@@ -0,0 +1,122 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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 int load(lua_State* L) {
+	//EMPTY
+	lua_pushboolean(L, false);
+	return 1;
+}
+
+static int save(lua_State* L) {
+	//EMPTY
+	return 0;
+}
+
+static int create(lua_State* L) {
+	//EMPTY
+	return 0;
+}
+
+static int unload(lua_State* L) {
+	//EMPTY
+	return 0;
+}
+
+static const luaL_Reg regionLib[] = {
+	{"SetTile",setTile},
+	{"GetTile",getTile},
+	{"SetSolid",setSolid},
+	{"GetSolid",getSolid},
+	{"GetX",getX},
+	{"GetY",getY},
+	{"GetWidth",getWidth},
+	{"GetHeight",getHeight},
+	{"GetDepth",getDepth},
+	{"Load",load},
+	{"Save",save},
+	{"Create",create},
+	{"Unload",unload},
+	{nullptr, nullptr}
+};
+
+LUAMOD_API int openRegionAPI(lua_State* L) {
+	luaL_newlib(L, regionLib);
+	return 1;
+}

src/map/region_api.hpp

@@ -0,0 +1,30 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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/lua.hpp"
+
+#define TORTUGA_REGION_NAME "Region"
+LUAMOD_API int openRegionAPI(lua_State* L);
+
+#endif

src/map/region_pager_api.cpp

@@ -0,0 +1,115 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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"
+
+#include <string>
+
+static int getRegionPager(lua_State* L) {
+	lua_pushstring(L, TORTUGA_REGION_PAGER_PSEUDO_INDEX);
+	lua_gettable(L, LUA_REGISTRYINDEX);
+}
+
+//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));
+	pager->UnloadRegion(lua_tointeger(L, 2), lua_tointeger(L, 3));
+	return 0;
+}
+
+static const luaL_Reg regionPagerLib[] = {
+	{"GetRegionPager", getRegionPager},
+	{"SetTile", setTile},
+	{"GetTile", getTile},
+	{"SetSolid", setSolid},
+	{"GetSolid", getSolid},
+	{"GetRegion", getRegion},
+	{"LoadRegion", loadRegion},
+	{"SaveRegion", saveRegion},
+	{"CreateRegion", createRegion},
+	{"UnloadRegion", unloadRegion},
+	{nullptr, nullptr}
+};
+
+LUAMOD_API int openRegionPagerAPI(lua_State* L) {
+	luaL_newlib(L, regionPagerLib);
+	return 1;
+}

src/map/region_pager_api.hpp

@@ -0,0 +1,31 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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/lua.hpp"
+
+#define TORTUGA_REGION_PAGER_PSEUDO_INDEX "RegionPagerPseudoIndex"
+#define TORTUGA_REGION_PAGER_NAME "RegionPager"
+LUAMOD_API int openRegionPagerAPI(lua_State* L);
+
+#endif

src/map/region_pager_base.cpp

@@ -0,0 +1,100 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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 "utility.hpp"
+
+#include <stdexcept>
+#include <algorithm>
+
+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) {
+	//TODO: load the region if possible
+	return nullptr;
+}
+
+Region* RegionPagerBase::SaveRegion(int x, int y) {
+	//TODO: find & save the region
+	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::UnloadRegion(int x, int y) {
+	//custom loop, not FindRegion()
+	regionList.remove_if([x, y](Region& region) -> bool { return region.GetX() == x && region.GetY() == y; });
+}
+
+void RegionPagerBase::UnloadAll() {
+	regionList.clear();
+}

src/map/region_pager_base.hpp

@@ -0,0 +1,60 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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 <list>
+
+class RegionPagerBase {
+public:
+	RegionPagerBase() = default;
+	virtual ~RegionPagerBase() { UnloadAll(); };
+
+	//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 UnloadRegion(int x, int y);
+
+	virtual void UnloadAll();
+
+	//accessors & mutators
+	std::list<Region>* GetContainer() { return &regionList; }
+protected:
+	std::list<Region> regionList;
+};
+
+#endif

src/map/region_pager_lua.cpp

@@ -0,0 +1,123 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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 "utility.hpp"
+
+#include <stdexcept>
+
+Region* RegionPagerLua::LoadRegion(int x, int y) {
+	//load the region if possible
+
+	//something to work on
+	Region tmpRegion(x, y);
+
+	//API hook
+	lua_getglobal(lua, "Region");
+	lua_getfield(lua, -1, "Load");
+	lua_pushlightuserdata(lua, &tmpRegion);
+	if (lua_pcall(lua, 1, 1, 0) != LUA_OK) {
+		throw(std::runtime_error(std::string() + "Lua error: " + lua_tostring(lua, -1) ));
+	}
+	//success or failure
+	if (!lua_toboolean(lua, -1)) {
+		lua_pop(lua, 2);
+		return nullptr;
+	}
+	lua_pop(lua, 2);
+	regionList.push_front(tmpRegion);
+	return &regionList.front();
+}
+
+Region* RegionPagerLua::SaveRegion(int x, int y) {
+	//find & save the region
+	Region* ptr = FindRegion(x, y);
+	if (ptr) {
+		//API hook
+		lua_getglobal(lua, "Region");
+		lua_getfield(lua, -1, "Save");
+		lua_pushlightuserdata(lua, ptr);
+		if (lua_pcall(lua, 1, 0, 0) != LUA_OK) {
+			throw(std::runtime_error(std::string() + "Lua error: " + lua_tostring(lua, -1) ));
+		}
+		lua_pop(lua, 1);
+	}
+	return ptr;
+}
+
+Region* RegionPagerLua::CreateRegion(int x, int y) {
+	if (FindRegion(x, y)) {
+		throw(std::logic_error("Cannot overwrite an existing region"));
+	}
+
+	//something to work on
+	Region tmpRegion(x, y);
+
+	//API hook
+	lua_getglobal(lua, "Region");
+	lua_getfield(lua, -1, "Create");
+	lua_pushlightuserdata(lua, &tmpRegion);
+	//TODO: parameters
+	if (lua_pcall(lua, 1, 0, 0) != LUA_OK) {
+		throw(std::runtime_error(std::string() + "Lua error: " + lua_tostring(lua, -1) ));
+	}
+	lua_pop(lua, 1);
+	regionList.push_front(tmpRegion);
+	return &regionList.front();
+}
+
+void RegionPagerLua::UnloadRegion(int x, int y) {
+	lua_getglobal(lua, "Region");
+
+	regionList.remove_if([&](Region& region) -> bool {
+		if (region.GetX() == x && region.GetY() == y) {
+
+			//API hook
+			lua_getfield(lua, -1, "Unload");
+			lua_pushlightuserdata(lua, &region);
+			if (lua_pcall(lua, 1, 0, 0) != LUA_OK) {
+				throw(std::runtime_error(std::string() + "Lua error: " + lua_tostring(lua, -1) ));
+			}
+
+			return true;
+		}
+		return false;
+	});
+
+	lua_pop(lua, 1);
+}
+
+void RegionPagerLua::UnloadAll() {
+	lua_getglobal(lua, "Region");
+
+	for (auto& it : regionList) {
+		//API hook
+		lua_getfield(lua, -1, "Unload");
+		lua_pushlightuserdata(lua, &it);
+		if (lua_pcall(lua, 1, 0, 0) != LUA_OK) {
+			throw(std::runtime_error(std::string() + "Lua error: " + lua_tostring(lua, -1) ));
+		}
+	}
+
+	lua_pop(lua, 1);
+	regionList.clear();
+}

src/map/region_pager_lua.hpp

@@ -0,0 +1,51 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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/lua.hpp"
+
+#include <string>
+
+class RegionPagerLua : public RegionPagerBase {
+public:
+	RegionPagerLua() = default;
+	~RegionPagerLua() = default;
+
+	//region manipulation
+	Region* LoadRegion(int x, int y) override;
+	Region* SaveRegion(int x, int y) override;
+	Region* CreateRegion(int x, int y) override;
+	void UnloadRegion(int x, int y) override;
+
+	void UnloadAll() override;
+
+	//accessors & mutators
+	lua_State* SetLuaState(lua_State* L) { return lua = L; }
+	lua_State* GetLuaState() { return lua; }
+protected:
+	lua_State* lua = nullptr;
+};
+
+#endif

src/map/tile_sheet.cpp

@@ -0,0 +1,61 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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);
+			}
+		}
+	}
+}

src/map/tile_sheet.hpp

@@ -0,0 +1,54 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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

src/map/tile_sheet_api.cpp

@@ -0,0 +1,82 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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_api.hpp"
+
+#include "tile_sheet.hpp"
+
+static int getTileSheet(lua_State* L) {
+	lua_pushstring(L, TORTUGA_TILE_SHEET_PSEUDO_INDEX);
+	lua_gettable(L, LUA_REGISTRYINDEX);
+	return 1;
+}
+
+static int load(lua_State* L) {
+	TileSheet* sheet = reinterpret_cast<TileSheet*>(lua_touserdata(L, 1));
+	sheet->Load(lua_tostring(L, 2), lua_tointeger(L, 3), lua_tointeger(L, 4));
+	return 0;
+}
+
+static int unload(lua_State* L) {
+	TileSheet* sheet = reinterpret_cast<TileSheet*>(lua_touserdata(L, 1));
+	sheet->Unload();
+	return 0;
+}
+
+static int getXCount(lua_State* L) {
+	TileSheet* sheet = reinterpret_cast<TileSheet*>(lua_touserdata(L, 1));
+	lua_pushinteger(L, sheet->GetXCount());
+	return 1;
+}
+
+static int getYCount(lua_State* L) {
+	TileSheet* sheet = reinterpret_cast<TileSheet*>(lua_touserdata(L, 1));
+	lua_pushinteger(L, sheet->GetYCount());
+	return 1;
+}
+
+static int getTileW(lua_State* L) {
+	TileSheet* sheet = reinterpret_cast<TileSheet*>(lua_touserdata(L, 1));
+	lua_pushinteger(L, sheet->GetTileW());
+	return 1;
+}
+
+static int getTileH(lua_State* L) {
+	TileSheet* sheet = reinterpret_cast<TileSheet*>(lua_touserdata(L, 1));
+	lua_pushinteger(L, sheet->GetTileH());
+	return 1;
+}
+
+static const luaL_Reg tileSheetLib[] = {
+	{"GetTileSheet",getTileSheet},
+	{"Load",load},
+	{"Unload",unload},
+	{"GetXCount",getXCount},
+	{"GetYCount",getYCount},
+	{"GetTileW",getTileW},
+	{"GetTileH",getTileH},
+	{nullptr, nullptr}
+};
+
+LUAMOD_API int openTileSheetAPI(lua_State* L) {
+	luaL_newlib(L, tileSheetLib);
+	return 1;
+}

src/map/tile_sheet_api.hpp

@@ -0,0 +1,31 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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 TILESHEETAPI_HPP_
+#define TILESHEETAPI_HPP_
+
+#include "lua/lua.hpp"
+
+#define TORTUGA_TILE_SHEET_PSEUDO_INDEX "TileSheetPseudoIndex"
+#define TORTUGA_TILE_SHEET_NAME "TileSheet"
+LUAMOD_API int openTileSheetAPI(lua_State* L);
+
+#endif

src/options_menu.cpp

@@ -0,0 +1,105 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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"
+
+//-------------------------
+//Public access members
+//-------------------------
+
+OptionsMenu::OptionsMenu(lua_State* L): lua(L) {
+	//get the config info
+	lua_getglobal(lua, "config");
+	lua_getfield(lua, -1, "dir");
+	lua_getfield(lua, -1, "interface");
+	std::string interface = lua_tostring(lua, -1);
+	lua_getfield(lua, -2, "fonts");
+	std::string fonts = lua_tostring(lua, -1);
+	lua_pop(lua, 4);
+
+	//setup the utility objects
+	image.LoadSurface(interface + "button_menu.bmp");
+	image.SetClipH(image.GetClipH()/3);
+	font.LoadSurface(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(double delta) {
+	//
+}
+
+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) {
+	//
+}
+
+void OptionsMenu::KeyUp(SDL_KeyboardEvent const& key) {
+	//
+}

src/options_menu.hpp

@@ -0,0 +1,63 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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"
+
+#include "lua/lua.hpp"
+
+//TODO: The options screen needs to be USED
+class OptionsMenu : public BaseScene {
+public:
+	//Public access members
+	OptionsMenu(lua_State* L);
+	~OptionsMenu();
+
+protected:
+	//Frame loop
+	void FrameStart();
+	void Update(double delta);
+	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&);
+
+	//shared parameters
+	lua_State* lua = nullptr;
+
+	//members
+	Image image;
+	RasterFont font;
+	Button backButton;
+};
+
+#endif

src/scene_list.hpp

@@ -0,0 +1,38 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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,
+	INWORLD,
+};
+
+#endif

src/splash_screen.cpp

@@ -0,0 +1,58 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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 <string>
+
+//-------------------------
+//Public access members
+//-------------------------
+
+SplashScreen::SplashScreen(lua_State* L): lua(L) {
+	//get the config info
+	lua_getglobal(lua, "config");
+	lua_getfield(lua, -1, "dir");
+	lua_getfield(lua, -1, "logos");
+	std::string logos = lua_tostring(lua, -1);
+	lua_pop(lua, 3);
+
+	logo.LoadSurface(logos + "krstudios.bmp");
+	startTick = std::chrono::steady_clock::now();
+}
+
+SplashScreen::~SplashScreen() {
+	//
+}
+
+//-------------------------
+//Frame loop
+//-------------------------
+
+void SplashScreen::Update(double delta) {
+	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);
+}

src/splash_screen.hpp

@@ -0,0 +1,52 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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 "lua/lua.hpp"
+
+#include <chrono>
+
+class SplashScreen : public BaseScene {
+public:
+	//Public access members
+	SplashScreen(lua_State* L);
+	~SplashScreen();
+
+protected:
+	//Frame loop
+	void Update(double delta);
+	void Render(SDL_Surface* const);
+
+	//shared parameters
+	lua_State* lua = nullptr;
+
+	//members
+	std::chrono::steady_clock::time_point startTick;
+	Image logo;
+};
+
+#endif

src/ui/button.cpp

@@ -0,0 +1,81 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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;
+	}
+}

src/ui/button.hpp

@@ -0,0 +1,94 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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

src/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

src/ui/menu_bar.cpp

@@ -0,0 +1,139 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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;
+}

src/ui/menu_bar.hpp

@@ -0,0 +1,92 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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

src/ui/raster_font.cpp

@@ -0,0 +1,60 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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();
+}

src/ui/raster_font.hpp

@@ -0,0 +1,54 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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

src/utilities/check_bounds.cpp

@@ -0,0 +1,40 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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 "check_bounds.hpp"
+
+bool checkPoint(Vector2 const& origin, Vector2 const& bound, Vector2 const& point) {
+	return !(
+		point.x < origin.x ||
+		point.y < origin.y ||
+		point.x >= origin.x + bound.x ||
+		point.y >= origin.y + bound.y
+	);
+}
+
+bool checkOverlap(Vector2 const& originOne, Vector2 const& boundOne, Vector2 const& originTwo, Vector2 const& boundTwo) {
+	return !(
+		originOne.x >= originTwo.x + boundTwo.x ||
+		originOne.x + boundOne.x < originTwo.x ||
+		originOne.y >= originTwo.y + boundTwo.y ||
+		originOne.y + boundOne.y < originTwo.y
+	);
+}

src/utilities/check_bounds.hpp

@@ -0,0 +1,30 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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 CHECKBOUNDS_HPP_
+#define CHECKBOUNDS_HPP_
+
+#include "vector2.hpp"
+
+bool checkPoint(Vector2 const& origin, Vector2 const& bound, Vector2 const& point);
+bool checkOverlap(Vector2 const& originOne, Vector2 const& boundOne, Vector2 const& originTwo, Vector2 const& boundTwo);
+
+#endif

src/utilities/frame_rate.hpp

@@ -0,0 +1,48 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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 FRAMERATE_HPP_
+#define FRAMERATE_HPP_
+
+#include <chrono>
+
+class FrameRate {
+public:
+	typedef std::chrono::high_resolution_clock Clock;
+
+	FrameRate() = default;
+	int Calculate() {
+		frameCount++;
+		if (Clock::now() - tick >= std::chrono::duration<int>(1)) {
+			lastFrameRate = frameCount;
+			frameCount = 0;
+			tick = Clock::now();
+		}
+		return lastFrameRate;
+	}
+	int GetFrameRate() { return lastFrameRate; }
+private:
+	int frameCount = 0;
+	int lastFrameRate = 0;
+	Clock::time_point tick = Clock::now();
+};
+
+#endif

src/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)/,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

src/utilities/simple_rng.hpp

@@ -0,0 +1,42 @@
+/* Copyright: (c) Kayne Ruse 2014
+ * 
+ * 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 SIMPLERNG_HPP_
+#define SIMPLERNG_HPP_
+
+//a simple, stateless, random number generator
+class SimpleRNG {
+public:
+	SimpleRNG() { SetSeed(8891.0); }
+	SimpleRNG(double x) { SetSeed(x); }
+
+	double SetSeed(double s) { return seed = s; }
+	double GetSeed() { return seed; }
+
+	double operator()(double x) {
+		return (x + seed) * 11235.0 + 81321.0;
+	};
+
+private:
+	double seed;
+};
+
+#endif

src/utilities/utility.cpp

@@ -0,0 +1,63 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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 "utility.hpp"
+
+#include <algorithm>
+
+int snapToBase(int base, int x) {
+	//snap to a grid
+	if (x < 0) {
+		++x;
+		return x / base * base - base;
+	}
+	return x / base * base;
+}
+
+double snapToBase(double base, double x) {
+	return floor(x / base) * base;
+}
+
+std::string truncatePath(std::string pathname) {
+	return std::string(
+		std::find_if(
+			pathname.rbegin(),
+			pathname.rend(),
+			[](char ch) -> bool {
+				//windows only
+				return ch == '/' || ch == '\\';
+//				//unix only
+//				return ch == '/';
+			}).base(),
+		pathname.end());
+}
+
+std::string to_string_custom(int i) {
+	char buffer[20];
+	snprintf(buffer, 20, "%d", i);
+	return std::string(buffer);
+}
+
+int to_integer_custom(std::string s) {
+	int ret = 0;
+	sscanf(s.c_str(), "%d", &ret);
+	return ret;
+}

src/utilities/utility.hpp

@@ -0,0 +1,37 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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 UTILITY_HPP_
+#define UTILITY_HPP_
+
+#include <string>
+
+int snapToBase(int base, int x);
+double snapToBase(double base, double x);
+
+std::string truncatePath(std::string pathname);
+
+//fixing known bugs in g++
+std::string to_string_custom(int i);
+
+int to_integer_custom(std::string);
+
+#endif

src/utilities/vector2.hpp

@@ -0,0 +1,108 @@
+/* Copyright: (c) Kayne Ruse 2013, 2014
+ * 
+ * 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 VECTOR2_HPP_
+#define VECTOR2_HPP_
+
+#include <type_traits>
+#include <stdexcept>
+#include <cmath>
+
+class Vector2 {
+public:
+	double x, y;
+
+	Vector2() = default;
+	Vector2(double i, double j): x(i), y(j) {};
+	~Vector2() = default;
+	Vector2& operator=(Vector2 const&) = default;
+
+	double Length() const {
+		return sqrt(x*x+y*y);
+	}
+	double SquaredLength() const {
+		return x*x+y*y;
+	}
+	void Normalize() {
+		double l = Length();
+		x /= l;
+		y /= l;
+	}
+
+	//Arithmetic operators
+	Vector2 operator+(Vector2 v) const {
+		Vector2 ret;
+		ret.x = x + v.x;
+		ret.y = y + v.y;
+		return ret;
+	}
+	Vector2 operator-(Vector2 v) const {
+		Vector2 ret;
+		ret.x = x - v.x;
+		ret.y = y - v.y;
+		return ret;
+	}
+	Vector2 operator*(Vector2 v) const {
+		Vector2 ret;
+		ret.x = x * v.x;
+		ret.y = y * v.y;
+		return ret;
+	}
+	Vector2 operator*(double d) const {
+		Vector2 ret;
+		ret.x = x * d;
+		ret.y = y * d;
+		return ret;
+	}
+
+	Vector2 operator/(Vector2 v) {
+		if (!v.x || !v.y)
+			throw(std::domain_error("Divide by zero"));
+		Vector2 ret;
+		ret.x = x / v.x;
+		ret.y = y / v.y;
+		return ret;
+	}
+	Vector2 operator/(double d) {
+		if (!d)
+			throw(std::domain_error("Divide by zero"));
+		Vector2 ret;
+		ret.x = x / d;
+		ret.y = y / d;
+		return ret;
+	}
+
+	bool operator==(Vector2 v) { return (x == v.x && y == v.y); }
+	bool operator!=(Vector2 v) { return (x != v.x || y != v.y); }
+
+	//member templates (curry the above operators)
+	template<typename T> Vector2 operator+=(T t) { return *this = *this + t; }
+	template<typename T> Vector2 operator-=(T t) { return *this = *this - t; }
+	template<typename T> Vector2 operator*=(T t) { return *this = *this * t; }
+	template<typename T> Vector2 operator/=(T t) { return *this = *this / t; }
+	template<typename T> bool operator==(T t) { return (x == t && y == t); }
+	template<typename T> bool operator!=(T t) { return (x != t || y != t); }
+};
+
+//This is explicitly a POD
+static_assert(std::is_pod<Vector2>::value, "Vector2 is not a POD");
+
+#endif