2023-09-10 14:43:20 +02:00
|
|
|
/**
|
2023-09-16 22:52:03 +02:00
|
|
|
game: this file implements the backend of a complete, actually playable
|
|
|
|
game, and is meant to be included and used by specific frontends (which
|
2023-09-10 14:43:20 +02:00
|
|
|
will handle each platform's hardware details and I/O).
|
2024-09-06 00:58:32 +02:00
|
|
|
|
|
|
|
TODO: more documentation
|
|
|
|
|
|
|
|
UNITS: There are various kinds of units used to ensure independence of the
|
|
|
|
game modules. Here is a summary:
|
|
|
|
|
|
|
|
- LCR_GameUnit: data type, abstract unit of the game (racing module). One map
|
|
|
|
square is LCR_GAME_UNITs long, a full angle is also LCR_GAME_UNITs.
|
|
|
|
- LCR_GAME_UNIT: Size of one game square and full angle in LCR_GameUnits.
|
|
|
|
- S3L_Unit: data type, small3dlib's unit. May change with renderer change.
|
|
|
|
- S3L_FRACTIONS_PER_UNIT: small3dlib's value representing 1.0.
|
|
|
|
- LCR_RENDERER_UNIT: for the renderer one map square is this many S3L_Units.
|
|
|
|
- TPE_Unit: tinyphysicsengine's unit. May change with phys. engine change.
|
|
|
|
- TPE_FRACTIONS_PER_UNIT: tinyphysicsengine's value representing value 1.0.
|
|
|
|
- LCR_PHYSICS_UNIT: for the phys. eng. one map square is this many TPE_Units.
|
|
|
|
|
|
|
|
COORDINATE SYSTEM AND ROTATIONS: The game itself (racing module) is
|
|
|
|
independent of rendering and physics libraries, but out of convenient adopts
|
|
|
|
their coordinate system (X right, Y up, Z forward) and rotations (Euler
|
|
|
|
angles, by Z, then by X, then Y).
|
|
|
|
|
|
|
|
|
2023-09-10 14:43:20 +02:00
|
|
|
*/
|
|
|
|
|
2023-07-21 21:17:49 +02:00
|
|
|
#ifndef _LCR_GAME_H
|
|
|
|
#define _LCR_GAME_H
|
|
|
|
|
2023-09-10 14:43:20 +02:00
|
|
|
#define LCR_KEY_UP 0x00
|
|
|
|
#define LCR_KEY_RIGHT 0x01
|
|
|
|
#define LCR_KEY_DOWN 0x02
|
|
|
|
#define LCR_KEY_LEFT 0x03
|
|
|
|
#define LCR_KEY_A 0x04 ///< confirm, restart race
|
|
|
|
#define LCR_KEY_B 0x05 ///< cancel, open menu
|
|
|
|
|
|
|
|
#define LCR_KEYS_TOTAL 6
|
|
|
|
|
|
|
|
/*
|
|
|
|
FOR FRONTENDS:
|
|
|
|
- Implement the below described functions according to their description.
|
|
|
|
- Implement the main program and game loop.
|
|
|
|
- Call the below described functions as described.
|
|
|
|
*/
|
2023-08-08 20:34:21 +02:00
|
|
|
|
2023-09-10 14:43:20 +02:00
|
|
|
/**
|
|
|
|
Implement this in your frontend. Returns 1 if given key is pressed or 0
|
|
|
|
otherwise.
|
|
|
|
*/
|
2023-08-08 20:34:21 +02:00
|
|
|
uint8_t LCR_keyPressed(uint8_t key);
|
|
|
|
|
2023-09-10 14:43:20 +02:00
|
|
|
/**
|
|
|
|
Implement this in your frontend. This function pauses program execution for
|
|
|
|
given amount of milliseconds and relieves the CPU usage. On platforms that
|
|
|
|
don't support this the function may simply do nothing.
|
|
|
|
*/
|
2023-08-08 20:34:21 +02:00
|
|
|
void LCR_sleep(uint16_t timeMs);
|
|
|
|
|
2023-09-10 14:43:20 +02:00
|
|
|
/**
|
|
|
|
Implement this in your frontend. This function draws a pixel of given color
|
|
|
|
to the screen back buffer (i.e. NOT directly to screen, back buffer shall
|
|
|
|
only be copied to front buffer once the LCR_gameStep function finishes all
|
|
|
|
rendering). This function should NOT check for out-of-screen coordinates, this
|
|
|
|
is handled by the game internals and out-of-screen pixels will never be drawn.
|
|
|
|
The color value depends on game settings but is normally an RGB565 value.
|
|
|
|
*/
|
2024-07-22 01:16:16 +02:00
|
|
|
void LCR_drawPixel(unsigned long index, uint16_t color);
|
2023-08-08 20:34:21 +02:00
|
|
|
|
2024-08-02 00:05:03 +02:00
|
|
|
/**
|
|
|
|
Implement this in your frontend. This function will be called to log what the
|
|
|
|
program is doing. If you want to ignore logging, simply make the function do
|
|
|
|
nothing.
|
|
|
|
*/
|
|
|
|
void LCR_log(const char *str);
|
|
|
|
|
2023-08-08 20:34:21 +02:00
|
|
|
/**
|
2023-09-10 14:43:20 +02:00
|
|
|
Call this function in your frontend at the start of the program.
|
2023-08-08 20:34:21 +02:00
|
|
|
*/
|
|
|
|
void LCR_gameInit(void);
|
|
|
|
|
|
|
|
/**
|
2023-09-10 14:43:20 +02:00
|
|
|
Call this function in your frontend right before program end.
|
2023-08-08 20:34:21 +02:00
|
|
|
*/
|
|
|
|
void LCR_gameEnd(void);
|
|
|
|
|
|
|
|
/**
|
2023-09-10 14:43:20 +02:00
|
|
|
Call this function in your frontend repeatedly inside the main loop, pass the
|
|
|
|
current time as the number of milliseconds since program start. This function
|
|
|
|
will perform the game step AND other things such as checking the input states,
|
|
|
|
rendering or sleeping (all using the above functions you should implement).
|
|
|
|
Returns 0 if program should end, otherwise 1.
|
2023-08-08 20:34:21 +02:00
|
|
|
*/
|
|
|
|
uint8_t LCR_gameStep(uint32_t timeMs);
|
|
|
|
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
|
2024-09-05 22:51:11 +02:00
|
|
|
struct
|
|
|
|
{
|
|
|
|
uint32_t nextRenderFrameTime;
|
|
|
|
uint32_t nextRacingTickTime;
|
|
|
|
} LCR_game;
|
2023-09-17 13:21:19 +02:00
|
|
|
|
2024-07-22 01:16:16 +02:00
|
|
|
void LCR_drawPixelXYUnsafe(unsigned int x, unsigned int y,
|
|
|
|
uint16_t color);
|
2023-09-10 14:43:20 +02:00
|
|
|
|
|
|
|
/**
|
2023-09-13 20:51:07 +02:00
|
|
|
Internal pixel drawing function that checks for out-of-screen coordinates. Use
|
|
|
|
this if the pixel can potentially lie of screen (however if you know it won't,
|
|
|
|
use the normal unsafe function in sake of performance).
|
2023-09-10 14:43:20 +02:00
|
|
|
*/
|
2024-07-22 01:16:16 +02:00
|
|
|
static inline void LCR_drawPixelXYSafe(unsigned int x, unsigned int y,
|
2023-09-13 20:51:07 +02:00
|
|
|
uint_fast16_t color);
|
|
|
|
|
2023-09-16 22:52:03 +02:00
|
|
|
#include "racing.h"
|
2023-09-13 20:51:07 +02:00
|
|
|
#include "assets.h"
|
|
|
|
#include "renderer.h"
|
|
|
|
|
2024-07-22 01:16:16 +02:00
|
|
|
uint8_t LCR_keyStates[LCR_KEYS_TOTAL]; /**< Assures unchanging key states
|
2024-09-05 22:51:11 +02:00
|
|
|
during a single frame. */
|
2023-09-13 20:51:07 +02:00
|
|
|
|
2024-07-22 01:16:16 +02:00
|
|
|
void LCR_drawPixelXYUnsafe(unsigned int x, unsigned int y,
|
|
|
|
uint16_t color)
|
2023-09-10 14:43:20 +02:00
|
|
|
{
|
2023-09-11 20:56:04 +02:00
|
|
|
#if LCR_SETTING_RESOLUTION_SUBDIVIDE == 1
|
2024-07-22 01:16:16 +02:00
|
|
|
LCR_drawPixel(y * LCR_SETTING_RESOLUTION_X + x,color);
|
2023-09-11 20:56:04 +02:00
|
|
|
#else
|
2024-07-22 01:16:16 +02:00
|
|
|
// TODO
|
2023-09-11 20:56:04 +02:00
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
2024-07-22 01:16:16 +02:00
|
|
|
static inline void LCR_drawPixelXYSafe(unsigned int x, unsigned int y,
|
2023-09-11 20:56:04 +02:00
|
|
|
uint_fast16_t color)
|
|
|
|
{
|
|
|
|
if (x < LCR_EFFECTIVE_RESOLUTION_X && y < LCR_EFFECTIVE_RESOLUTION_Y)
|
2024-07-22 01:16:16 +02:00
|
|
|
LCR_drawPixelXYUnsafe(x,y,color);
|
2023-09-10 14:43:20 +02:00
|
|
|
}
|
|
|
|
|
2023-08-08 20:34:21 +02:00
|
|
|
void LCR_gameInit(void)
|
|
|
|
{
|
2024-08-02 00:05:03 +02:00
|
|
|
LCR_log("initializing");
|
|
|
|
|
2023-09-10 14:43:20 +02:00
|
|
|
for (int i = 0; i < LCR_KEYS_TOTAL; ++i)
|
2024-07-22 01:16:16 +02:00
|
|
|
LCR_keyStates[i] = 0;
|
|
|
|
|
|
|
|
LCR_mapLoad(map1);
|
2023-09-16 20:35:01 +02:00
|
|
|
LCR_rendererInit();
|
2024-09-04 23:26:05 +02:00
|
|
|
LCR_racingInit();
|
2024-09-05 22:51:11 +02:00
|
|
|
|
|
|
|
LCR_game.nextRenderFrameTime = 0;
|
|
|
|
LCR_game.nextRacingTickTime = 0;
|
2023-08-08 20:34:21 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
void LCR_gameEnd(void)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
uint8_t LCR_gameStep(uint32_t time)
|
|
|
|
{
|
2023-09-10 14:43:20 +02:00
|
|
|
for (int i = 0; i < LCR_KEYS_TOTAL; ++i)
|
2024-07-22 01:16:16 +02:00
|
|
|
LCR_keyStates[i] = LCR_keyPressed(i);
|
2023-09-10 14:43:20 +02:00
|
|
|
|
2023-09-17 13:21:19 +02:00
|
|
|
uint32_t sleep = 0;
|
|
|
|
|
2024-09-05 22:51:11 +02:00
|
|
|
while (time >= LCR_game.nextRacingTickTime)
|
2023-09-17 13:21:19 +02:00
|
|
|
{
|
2024-09-05 22:51:11 +02:00
|
|
|
unsigned int input = 0;
|
|
|
|
|
|
|
|
if (LCR_keyStates[LCR_KEY_B])
|
|
|
|
input =
|
|
|
|
(LCR_keyStates[LCR_KEY_UP] ? LCR_RACING_INPUT_FORW : 0) |
|
|
|
|
(LCR_keyStates[LCR_KEY_RIGHT] ? LCR_RACING_INPUT_RIGHT : 0) |
|
|
|
|
(LCR_keyStates[LCR_KEY_DOWN] ? LCR_RACING_INPUT_BACK : 0) |
|
|
|
|
(LCR_keyStates[LCR_KEY_LEFT] ? LCR_RACING_INPUT_LEFT : 0);
|
|
|
|
|
|
|
|
LCR_racingStep(input);
|
|
|
|
LCR_game.nextRacingTickTime += LCR_RACING_TICK_MS;
|
|
|
|
}
|
2024-09-04 23:26:05 +02:00
|
|
|
|
|
|
|
|
2024-09-05 22:51:11 +02:00
|
|
|
if (time >= LCR_game.nextRenderFrameTime)
|
|
|
|
{
|
|
|
|
LCR_GameUnit carTransform[6];
|
|
|
|
LCR_racingGetCarTransform(carTransform,carTransform + 3);
|
|
|
|
LCR_rendererSetCarTransform(carTransform,carTransform + 3);
|
2024-09-04 23:26:05 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
2023-09-17 13:21:19 +02:00
|
|
|
LCR_rendererDraw();
|
|
|
|
|
2024-09-04 23:26:05 +02:00
|
|
|
|
|
|
|
LCR_GameUnit sss[7];
|
|
|
|
LCR_rendererGetCameraTransform(sss,sss + 3,sss + 6);
|
|
|
|
LCR_physicsDebugDraw(sss,sss + 3,sss[6]);
|
|
|
|
|
|
|
|
|
2024-09-05 22:51:11 +02:00
|
|
|
LCR_game.nextRenderFrameTime += 1000 / LCR_SETTING_FPS;
|
2023-09-17 13:21:19 +02:00
|
|
|
|
2024-09-04 23:26:05 +02:00
|
|
|
LCR_GameUnit offsets[5];
|
2023-09-17 13:21:19 +02:00
|
|
|
|
|
|
|
for (int i = 0; i < 5; ++i)
|
|
|
|
offsets[i] = 0;
|
|
|
|
|
2024-07-22 01:16:16 +02:00
|
|
|
if (LCR_keyStates[LCR_KEY_A])
|
2023-09-17 13:21:19 +02:00
|
|
|
{
|
2024-07-22 01:16:16 +02:00
|
|
|
if (LCR_keyStates[LCR_KEY_UP])
|
2023-09-17 15:42:46 +02:00
|
|
|
offsets[4] = LCR_FREE_CAMERA_TURN_STEP;
|
2024-07-22 01:16:16 +02:00
|
|
|
else if (LCR_keyStates[LCR_KEY_DOWN])
|
2023-09-17 15:42:46 +02:00
|
|
|
offsets[4] -= LCR_FREE_CAMERA_TURN_STEP;
|
2023-09-17 13:21:19 +02:00
|
|
|
|
2024-07-22 01:16:16 +02:00
|
|
|
if (LCR_keyStates[LCR_KEY_RIGHT])
|
2023-09-17 15:42:46 +02:00
|
|
|
offsets[3] -= LCR_FREE_CAMERA_TURN_STEP;
|
2024-07-22 01:16:16 +02:00
|
|
|
else if (LCR_keyStates[LCR_KEY_LEFT])
|
2023-09-17 15:42:46 +02:00
|
|
|
offsets[3] = LCR_FREE_CAMERA_TURN_STEP;
|
2023-09-17 13:21:19 +02:00
|
|
|
}
|
2024-09-05 22:51:11 +02:00
|
|
|
else if (!LCR_keyStates[LCR_KEY_B])
|
2023-09-17 13:21:19 +02:00
|
|
|
{
|
2024-07-22 01:16:16 +02:00
|
|
|
if (LCR_keyStates[LCR_KEY_UP])
|
2023-09-17 13:21:19 +02:00
|
|
|
offsets[0] = LCR_FREE_CAMERA_STEP;
|
2024-07-22 01:16:16 +02:00
|
|
|
else if (LCR_keyStates[LCR_KEY_DOWN])
|
2023-09-17 13:21:19 +02:00
|
|
|
offsets[0] -= LCR_FREE_CAMERA_STEP;
|
|
|
|
|
2024-07-22 01:16:16 +02:00
|
|
|
if (LCR_keyStates[LCR_KEY_RIGHT])
|
2023-09-17 13:21:19 +02:00
|
|
|
offsets[1] = LCR_FREE_CAMERA_STEP;
|
2024-07-22 01:16:16 +02:00
|
|
|
else if (LCR_keyStates[LCR_KEY_LEFT])
|
2023-09-17 13:21:19 +02:00
|
|
|
offsets[1] -= LCR_FREE_CAMERA_STEP;
|
|
|
|
}
|
|
|
|
|
|
|
|
LCR_rendererMoveCamera(offsets,offsets + 3);
|
|
|
|
}
|
|
|
|
else
|
2024-09-05 22:51:11 +02:00
|
|
|
sleep = LCR_game.nextRenderFrameTime - time;
|
2023-09-17 13:21:19 +02:00
|
|
|
|
|
|
|
if (sleep)
|
|
|
|
LCR_sleep(sleep);
|
2023-09-10 14:43:20 +02:00
|
|
|
|
|
|
|
return 1;
|
2023-08-08 20:34:21 +02:00
|
|
|
}
|
|
|
|
|
2023-07-21 21:17:49 +02:00
|
|
|
#endif // guard
|