Multiple templates to start a game

Some basic to advance templates are provided to be use as base code for
new games

5 files changed, 465 insertions, 0 deletions

diff --git a/templates/simple_game/makefile b/templates/simple_game/makefile
new file mode 100644
index 00000000..418df1a3
--- /dev/null
+++ b/templates/simple_game/makefile
@@ -0,0 +1,98 @@
+#**************************************************************************************************
+#
+#   raylib - Simple Game
+#
+#   makefile to compile simple game
+#
+#   Copyright (c) 2014 Ramon Santamaria (Ray San - raysan@raysanweb.com)
+#    
+#   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 raylib platform (by default, compile for RPI)
+# Other possible platform: PLATFORM_DESKTOP
+PLATFORM ?= PLATFORM_RPI
+
+# define compiler: gcc for C program, define as g++ for C++
+CC = gcc
+
+# define compiler flags:
+#  -O2         defines optimization level
+#  -Wall       turns on most, but not all, compiler warnings
+#  -std=c99    use standard C from 1999 revision
+ifeq ($(PLATFORM),PLATFORM_RPI)
+    CFLAGS = -O2 -Wall -std=gnu99 -fgnu89-inline
+else
+    CFLAGS = -O2 -Wall -std=c99
+endif
+#CFLAGSEXTRA = -Wextra -Wmissing-prototypes -Wstrict-prototypes
+
+# define any directories containing required header files
+ifeq ($(PLATFORM),PLATFORM_RPI)
+    INCLUDES = -I. -I../../src -I/opt/vc/include -I/opt/vc/include/interface/vcos/pthreads
+else
+    INCLUDES = -I. -I../../src
+endif
+
+# define library paths containing required libs
+LFLAGS = -L. -L../../src -L/opt/vc/lib
+
+# define any libraries to link into executable
+# if you want to link libraries (libname.so or libname.a), use the -lname
+ifeq ($(PLATFORM),PLATFORM_RPI)
+    # libraries for Raspberry Pi compiling
+    # NOTE: OpenAL Soft library should be installed (libopenal1 package)
+    LIBS = -lraylib -lGLESv2 -lEGL -lm -lbcm_host -lopenal
+else
+    # libraries for Windows desktop compiling
+    # NOTE: GLFW3 and OpenAL Soft libraries should be installed
+    LIBS = -lraylib -lglfw3 -lglew32 -lopengl32 -lopenal32 -lgdi32
+endif
+
+# define additional parameters and flags for windows
+ifeq ($(PLATFORM),PLATFORM_DESKTOP)
+    # resources file contains windows exe icon
+    # -Wl,--subsystem,windows hides the console window
+    WINFLAGS = ../../src/resources -Wl,--subsystem,windows
+endif
+
+# typing 'make' will invoke the first target entry in the file,
+# in this case, the 'default' target entry is simple_game
+default: simple_game
+
+# compile template - simple_game
+simple_game: simple_game.c screens.o
+	$(CC) -o $@ $< screens.o $(CFLAGS) $(INCLUDES) $(LFLAGS) $(LIBS) -D$(PLATFORM) $(WINFLAGS)
+
+# compile screens
+screens.o: screens.c
+	$(CC) -c $< $(CFLAGS) $(INCLUDES) -D$(PLATFORM)
+
+# clean everything
+clean:
+ifeq ($(PLATFORM),PLATFORM_RPI)
+	rm -f *.o
+#	find . -executable -delete
+else
+	del *.o *.exe
+endif
+	@echo Cleaning done
+
+# instead of defining every module one by one, we can define a pattern
+# this pattern below will automatically compile every module defined on $(OBJS)
+#%.exe : %.c
+#	$(CC) -o $@ $< $(CFLAGS) $(INCLUDES) $(LFLAGS) $(LIBS) -D$(PLATFORM)
diff --git a/templates/simple_game/screens.c b/templates/simple_game/screens.c
new file mode 100644
index 00000000..742cf6f8
--- /dev/null
+++ b/templates/simple_game/screens.c
@@ -0,0 +1,195 @@
+/**********************************************************************************************
+*
+*   raylib - Simple Game template
+*
+*   Screens Functions Definitions (Init, Update, Draw, Unload)
+*
+*   Copyright (c) 2014 Ramon Santamaria (Ray San - raysan@raysanweb.com)
+*
+*   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 "raylib.h"
+#include "screens.h"
+
+//----------------------------------------------------------------------------------
+// Global Variables Definition (visible to other modules)
+//----------------------------------------------------------------------------------
+GameScreen currentScreen = LOGO;
+
+//----------------------------------------------------------------------------------
+// Global Variables Definition (local to this module)
+//----------------------------------------------------------------------------------
+
+// Logo screen global variables
+static int framesCounter;
+
+// Title screen global variables
+
+// Gameplay screen global variables
+
+// Ending screen global variables
+
+//----------------------------------------------------------------------------------
+// Logo Screen Functions Definition
+//----------------------------------------------------------------------------------
+
+// Logo Screen Initialization logic
+void InitLogoScreen(void)
+{
+    // TODO: Initialize LOGO screen variables here!
+    framesCounter = 0;
+}
+
+// Logo Screen Update logic
+void UpdateLogoScreen(void)
+{
+    // TODO: Update LOGO screen variables here!
+
+    framesCounter++;    // Count frames
+
+    // Wait for 2 seconds (120 frames) before jumping to TITLE screen
+    if (framesCounter > 120)
+    {
+        currentScreen = TITLE;
+    }
+}
+
+// Logo Screen Draw logic
+void DrawLogoScreen(void)
+{
+    // TODO: Draw LOGO screen here!
+    DrawText("LOGO SCREEN", 20, 20, 40, LIGHTGRAY);
+    DrawText("WAIT for 2 SECONDS...", 290, 220, 20, GRAY);
+}
+
+// Logo Screen Unload logic
+void UnloadLogoScreen(void)
+{
+    // TODO: Unload LOGO screen variables here!
+}
+
+//----------------------------------------------------------------------------------
+// Title Screen Functions Definition
+//----------------------------------------------------------------------------------
+
+// Title Screen Initialization logic
+void InitTitleScreen(void)
+{
+    // TODO: Initialize TITLE screen variables here!
+}
+
+// Title Screen Update logic
+void UpdateTitleScreen(void)
+{
+    // TODO: Update TITLE screen variables here!
+
+    // Press enter to change to GAMEPLAY screen
+    if (IsKeyPressed(KEY_ENTER))
+    {
+        currentScreen = GAMEPLAY;
+    }
+}
+
+// Title Screen Draw logic
+void DrawTitleScreen(void)
+{
+    // TODO: Draw TITLE screen here!
+    DrawRectangle(0, 0, GetScreenWidth(), GetScreenHeight(), GREEN);
+    DrawText("TITLE SCREEN", 20, 20, 40, DARKGREEN);
+    DrawText("PRESS ENTER to JUMP to GAMEPLAY SCREEN", 160, 220, 20, DARKGREEN);
+}
+
+// Title Screen Unload logic
+void UnloadTitleScreen(void)
+{
+    // TODO: Unload TITLE screen variables here!
+}
+
+//----------------------------------------------------------------------------------
+// Gameplay Screen Functions Definition
+//----------------------------------------------------------------------------------
+
+// Gameplay Screen Initialization logic
+void InitGameplayScreen(void)
+{
+    // TODO: Initialize GAMEPLAY screen variables here!
+}
+
+// Gameplay Screen Update logic
+void UpdateGameplayScreen(void)
+{
+    // TODO: Update GAMEPLAY screen variables here!
+
+    // Press enter to change to ENDING screen
+    if (IsKeyPressed(KEY_ENTER))
+    {
+        currentScreen = ENDING;
+    }
+}
+
+// Gameplay Screen Draw logic
+void DrawGameplayScreen(void)
+{
+    // TODO: Draw GAMEPLAY screen here!
+    DrawRectangle(0, 0, GetScreenWidth(), GetScreenHeight(), PURPLE);
+    DrawText("GAMEPLAY SCREEN", 20, 20, 40, MAROON);
+    DrawText("PRESS ENTER to JUMP to ENDING SCREEN", 170, 220, 20, MAROON);
+}
+
+// Gameplay Screen Unload logic
+void UnloadGameplayScreen(void)
+{
+    // TODO: Unload GAMEPLAY screen variables here!
+}
+
+//----------------------------------------------------------------------------------
+// Ending Screen Functions Definition
+//----------------------------------------------------------------------------------
+
+// Ending Screen Initialization logic
+void InitEndingScreen(void)
+{
+    // TODO: Initialize ENDING screen variables here!
+}
+
+// Ending Screen Update logic
+void UpdateEndingScreen(void)
+{
+    // TODO: Update ENDING screen variables here!
+
+    // Press enter to return to TITLE screen
+    if (IsKeyPressed(KEY_ENTER))
+    {
+        currentScreen = TITLE;
+    }
+}
+
+// Ending Screen Draw logic
+void DrawEndingScreen(void)
+{
+    // TODO: Draw ENDING screen here!
+    DrawRectangle(0, 0, GetScreenWidth(), GetScreenHeight(), BLUE);
+    DrawText("ENDING SCREEN", 20, 20, 40, DARKBLUE);
+    DrawText("PRESS ENTER to RETURN to TITLE SCREEN", 160, 220, 20, DARKBLUE);
+}
+
+// Ending Screen Unload logic
+void UnloadEndingScreen(void)
+{
+    // TODO: Unload ENDING screen variables here!
+}
\ No newline at end of file
diff --git a/templates/simple_game/screens.h b/templates/simple_game/screens.h
new file mode 100644
index 00000000..7afaebeb
--- /dev/null
+++ b/templates/simple_game/screens.h
@@ -0,0 +1,74 @@
+/**********************************************************************************************
+*
+*   raylib - Simple Game template
+*
+*   Screens Functions Declarations (Init, Update, Draw, Unload)
+*
+*   Copyright (c) 2014 Ramon Santamaria (Ray San - raysan@raysanweb.com)
+*
+*   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 SCREENS_H
+#define SCREENS_H
+
+//----------------------------------------------------------------------------------
+// Types and Structures Definition
+//----------------------------------------------------------------------------------
+typedef enum GameScreen { LOGO, TITLE, GAMEPLAY, ENDING } GameScreen;
+
+#ifdef __cplusplus
+extern "C" {            // Prevents name mangling of functions
+#endif
+
+//----------------------------------------------------------------------------------
+// Logo Screen Functions Declaration
+//----------------------------------------------------------------------------------
+void InitLogoScreen(void);
+void UpdateLogoScreen(void);
+void DrawLogoScreen(void);
+void UnloadLogoScreen(void);
+
+//----------------------------------------------------------------------------------
+// Title Screen Functions Declaration
+//----------------------------------------------------------------------------------
+void InitTitleScreen(void);
+void UpdateTitleScreen(void);
+void DrawTitleScreen(void);
+void UnloadTitleScreen(void);
+
+//----------------------------------------------------------------------------------
+// Gameplay Screen Functions Declaration
+//----------------------------------------------------------------------------------
+void InitGameplayScreen(void);
+void UpdateGameplayScreen(void);
+void DrawGameplayScreen(void);
+void UnloadGameplayScreen(void);
+
+//----------------------------------------------------------------------------------
+// Ending Screen Functions Declaration
+//----------------------------------------------------------------------------------
+void InitEndingScreen(void);
+void UpdateEndingScreen(void);
+void DrawEndingScreen(void);
+void UnloadEndingScreen(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // SCREENS_H
\ No newline at end of file
diff --git a/templates/simple_game/screens.o b/templates/simple_game/screens.o
new file mode 100644
index 00000000..7ed0860c
--- /dev/null
+++ b/templates/simple_game/screens.o
diff --git a/templates/simple_game/simple_game.c b/templates/simple_game/simple_game.c
new file mode 100644
index 00000000..b4d75719
--- /dev/null
+++ b/templates/simple_game/simple_game.c
@@ -0,0 +1,98 @@
+/*******************************************************************************************
+*
+*   raylib - Simple Game template
+*
+*   <Game title>
+*   <Game description>
+*
+*   This game has been created using raylib (www.raylib.com)
+*   raylib is licensed under an unmodified zlib/libpng license (View raylib.h for details)
+*
+*   raylib - Copyright (c) 2014 Ramon Santamaria (Ray San - raysan@raysanweb.com)
+*
+********************************************************************************************/
+
+#include "raylib.h"
+
+#include "screens.h"
+
+//----------------------------------------------------------------------------------
+// Global Variables Defined in other modules
+//----------------------------------------------------------------------------------
+extern GameScreen currentScreen;    // Defined in screens.c
+
+//----------------------------------------------------------------------------------
+// Main entry point
+//----------------------------------------------------------------------------------
+int main(void)
+{
+	// Initialization
+	//---------------------------------------------------------
+    const int screenWidth = 800;
+    const int screenHeight = 450;
+	const char windowTitle[30] = "<game name goes here>";
+
+    InitWindow(screenWidth, screenHeight, windowTitle);
+
+    // Initialize all screens
+    InitLogoScreen();
+    InitTitleScreen();
+    InitGameplayScreen();
+    InitEndingScreen();
+
+    // Define first screen
+    currentScreen = LOGO;
+    
+	SetTargetFPS(60);
+	//----------------------------------------------------------
+
+    // Main game loop
+    while (!WindowShouldClose())    // Detect window close button or ESC key
+    {
+        // Update
+        //----------------------------------------------------------------------------------
+        switch(currentScreen) 
+        {
+            case LOGO:      UpdateLogoScreen(); break;      // Update LOGO currentScreen
+            case TITLE:     UpdateTitleScreen(); break;     // Update TITLE currentScreen
+            case GAMEPLAY:  UpdateGameplayScreen(); break;  // Update GAMEPLAY currentScreen
+            case ENDING:    UpdateEndingScreen(); break;       // Update END currentScreen
+            default: break;
+        }
+        //----------------------------------------------------------------------------------
+        
+        // Draw
+        //----------------------------------------------------------------------------------
+        BeginDrawing();
+        
+            ClearBackground(RAYWHITE);
+            
+            switch(currentScreen) 
+            {
+                case LOGO:      DrawLogoScreen(); break;        // Draw LOGO currentScreen
+                case TITLE:     DrawTitleScreen(); break;       // Draw TITLE currentScreen
+                case GAMEPLAY:  DrawGameplayScreen(); break;    // Draw GAMEPLAY currentScreen
+                case ENDING:    DrawEndingScreen(); break;         // Draw END currentScreen
+                default: break;
+            }
+        
+            DrawFPS(screenWidth - 100, 20);
+        
+        EndDrawing();
+        //----------------------------------------------------------------------------------
+    }
+
+    // De-Initialization
+    //--------------------------------------------------------------------------------------
+    
+    // Unload all loaded data (textures, fonts, audio)
+    UnloadLogoScreen();
+    UnloadTitleScreen();
+    UnloadGameplayScreen();
+    UnloadEndingScreen();
+    
+    CloseWindow();        // Close window and OpenGL context
+    //--------------------------------------------------------------------------------------
+	
+    return 0;
+}
\ No newline at end of file