feat: revision 0.0.17 (#8)

* fix: change background color

* fix: correct colors RGB

* fix: wrap draw rect

* fix: wrap font size

* docs: update links in README.md

* style: refact rect wrap

* docs: bump version

* feat: add again FPS_MODE config

* feat: todo geoclip_line

* feat: better debug game/engine lua script

* feat: start support love2d

* feat: new logos for love and core native

* feat: colorize gly engine logo

* feat: alias for love samples in cmake

* feat: change splashscreen in cmake

* feat: add flag FPS_MODE to cmake

* feat: add flag FPS_DELTA to cmake

* docs: mainpage in doxygen

* docs: add params in lua api

* docs: link for gly type

* docs: create .gitattributes to ignore lua

Author: RodrigoDornelles

.gitattributes

@@ -0,0 +1 @@
+*.lua linguist-generated

.github/workflows/DOCS.yml

@@ -23,7 +23,7 @@ jobs:
         uses: actions/checkout@master
       - 
         run: |
-          docker run --rm -v $(pwd):/app -w /app rodrigodornelles/doxygen doxygen
+          docker run --rm -v $(pwd):/app -w /app rodrigodornelles/doxygen:lua doxygen
       - 
         uses: actions/configure-pages@v3
       -

CMakeLists.txt

@@ -80,15 +80,29 @@ list(REMOVE_ITEM lua_files "${LUA_DIR}/onelua.c")
 add_library(lua-static STATIC ${lua_files})
 find_program(LUAC lua PATHS ${LUA_DIR} REQUIRED NO_DEFAULT_PATH)
 
+# Loading / Splash Screen
+if(DEFINED ENGINE AND ENGINE STREQUAL "@love")
+    set(ENGINE_LOGO 2 CACHE STRING "" FORCE)
+elseif(DEFINED ENGINE AND ENGINE MATCHES "^\\@")
+    set(ENGINE_LOGO 1 CACHE STRING "" FORCE)
+else()
+    set(ENGINE_LOGO 3 CACHE STRING "" FORCE)
+endif()
+target_compile_definitions(${PROJECT_NAME} PRIVATE ENGINE_LOGO=${ENGINE_LOGO})
+
 # Engine
 set(ENGINE_VERSION "0.0.16")
 set(ENGINE_DIR "${CMAKE_SOURCE_DIR}/vendor/engine")
 set(ENGINE_CLI "${ENGINE_DIR}/src/cli/main.lua")
 set(ENGINE_DOWNLOAD "https://github.com/gamelly/gly-engine/archive/refs/tags/${ENGINE_VERSION}.tar.gz")
 set(ENGINE_HEADER "${ENGINE_DIR}/bytecode.h")
+set(ENGINE_LOVE_DIR1 "${ENGINE_DIR}/love")
+set(ENGINE_LOVE_DIR2 "${CMAKE_SOURCE_DIR}/vendor/love")
+set(ENGINE_LOVE_DOWNLOAD "https://github.com/gamelly/love-engine/archive/refs/heads/main.zip")
 if(NOT EXISTS ${ENGINE_HEADER})
     FetchContent_Populate(dep_engine URL ${ENGINE_DOWNLOAD} SOURCE_DIR ${ENGINE_DIR})
     file(MAKE_DIRECTORY "${ENGINE_DIR}/lite")
+    file(MAKE_DIRECTORY "${ENGINE_DIR}/love")
     file(MAKE_DIRECTORY "${ENGINE_DIR}/native")
     file(MAKE_DIRECTORY "${ENGINE_DIR}/samples/template")
     execute_process(
@@ -108,6 +122,11 @@ if(NOT EXISTS ${ENGINE_HEADER})
     set(ENGINE "@lite")
 endif()
 if(DEFINED ENGINE)
+    if (ENGINE STREQUAL "@love" AND NOT EXISTS "${ENGINE_LOVE_DIR1}/main.lua")
+        message(WARNING "currently LOVE2D is experimental.")
+        FetchContent_Populate(dep_love URL ${ENGINE_LOVE_DOWNLOAD} SOURCE_DIR ${ENGINE_LOVE_DIR2})
+        file(COPY "${ENGINE_LOVE_DIR2}/src/main.lua" DESTINATION "${ENGINE_LOVE_DIR1}")
+    endif()
     if (ENGINE MATCHES "^\\@")
         string(SUBSTRING "${ENGINE}" 1 -1 ENGINE)
         set(ENGINE "${ENGINE_DIR}/${ENGINE}/main.lua")
@@ -126,6 +145,10 @@ endif()
 # Game
 string(LENGTH "${GAME}" GAME_LENGTH)
 set(GAME_HEADER "${CMAKE_SOURCE_DIR}/vendor/game/bytecode.h")
+if (DEFINED GAME AND GAME_LENGTH AND GAME MATCHES "^\\@love:")
+    string(SUBSTRING "${GAME}" 6 -1 GAME)
+    set(GAME "${ENGINE_LOVE_DIR2}/samples/${GAME}/main.lua")
+endif()
 if (DEFINED GAME AND GAME_LENGTH AND GAME MATCHES "^\\@")
     string(SUBSTRING "${GAME}" 1 -1 GAME)
     set(GAME "${ENGINE_DIR}/samples/${GAME}/game.lua")
@@ -155,5 +178,13 @@ if(LUA_OPTMIZE)
     )
 endif()
 
+# CFGs
+if(DEFINED FPS_MODE)
+    target_compile_definitions(${PROJECT_NAME} PRIVATE FPS_MODE=${FPS_MODE})
+endif()
+if(DEFINED FPS_DELTA)
+    target_compile_definitions(${PROJECT_NAME} PRIVATE FPS_DELTA=${FPS_DELTA})
+endif()
+
 target_link_libraries(${PROJECT_NAME} lua-static)
 target_link_libraries(${PROJECT_NAME} m)

Doxyfile

@@ -1,7 +1,7 @@
 # Custom Configs
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = "Core Native GBA"
-PROJECT_NUMBER         = 0.0.12
+PROJECT_NUMBER         = 0.0.17
 PROJECT_BRIEF          = "create your own game-engine with just lua for nitendo game boy advance console."
 PROJECT_LOGO           = 
 OUTPUT_DIRECTORY       = .
@@ -13,12 +13,12 @@ HAVE_DOT               = YES
 EXTRACT_ALL            = YES
 USE_MATHJAX            = YES
 EXTRACT_STATIC         = YES
-SHORT_NAMES            = YES
+SHORT_NAMES            = NO
 OPTIMIZE_OUTPUT_FOR_C  = YES
 INLINE_GROUPED_CLASSES = YES
 INLINE_SIMPLE_STRUCTS  = YES
 TYPEDEF_HIDES_STRUCT   = YES
-SOURCE_BROWSER         = NO
+SOURCE_BROWSER         = YES
 VERBATIM_HEADERS       = NO
 PREDEFINED             = DOXYGEN=
 PLANTUML_JAR_PATH      = $(PLANTUML_JAR_PATH)
@@ -27,7 +27,9 @@ PLANTUML_INCLUDE_PATH  =
 OUTPUT_LANGUAGE        = English
 FILE_PATTERNS          = *.c *.h
 EXTENSION_MAPPING      = h=c 
-INPUT                  = src
+FILTER_PATTERNS        = *.md="lua mainpage.lua"
+INPUT                  = README.md src
+USE_MDFILE_AS_MAINPAGE = README.md
 MARKDOWN_ID_STYLE      = GITHUB
 # Theme: https://jothepro.github.io/doxygen-awesome-css/
 GENERATE_TREEVIEW      = YES

README.md

@@ -3,42 +3,48 @@
 [<img align="right" height="168px" src="https://raw.githubusercontent.com/RodrigoDornelles/RodrigoDornelles/refs/heads/master/media/pong-gba-gly-engine.gif">](#core-native-gba)
 
 This project is a basic micro-gameengine to run lua in the **Nintendo Game Boy Advanced**,
-which can be expanded to a custom engine, such as [Gly Engine](https://github.com/gamelly/gly-engine).
+which can be expanded to a custom engine, such as [Gly Engine](https://github.com/gamelly/gly-engine) or [Love2d](https://github.com/gamelly/love-engine).
 
  * [online ide](https://playground.gamely.com.br)
- * [limitations](https://docs.gamely.com.br/a00232#limits-in-gameboy-advanced)
- * [documentation](https://docs.gamely.com.br/a00188.html)
+ * [limitations](https://docs.gamely.com.br/limits#limits-in-gameboy-advanced)
+ * [documentation](https://docs.gamely.com.br/group__homebrew#nintendo_gba)
 
 <br/>
 
 | :warning: Attention |
 | :------------------ |
 | there is no sanitization, error handling or observation of resource consumption, all of this takes up precious CPU time, bad code will make the game crash with a black screen.<br><br>**Developing a multiplatform game with desktop support is recommended, especially for testing Lua code!** |
 
-## How to build
+## Building: [Pong](https://github.com/gamelly/gly-engine/blob/main/samples/pong/game.lua) Example with `Gly Engine`
 
-use [devkitpro/devkitarm](https://hub.docker.com/r/devkitpro/devkitarm) container if you do not have [devkitpro](https://devkitpro.org/wiki/devkitPro_pacman) installed.
-
-### Clone repo
- 
+```sql
+cmake -Bbuild -H. -DGAME=@pong
 ```
-git clone https://github.com/gamelly/core-native-gba
+
+```sql
+make -C build
 ```
 
-### Configure project
+## Building: [Pong](https://github.com/gamelly/love-engine/blob/main/samples/pong/main.lua) Example with `Love2D`
 
+```sql
+cmake -Bbuild -H. -DGAME=@love:pong -DENGINE=@love
 ```
-cmake -Bbuild -H. -DGAME=vendor/engine/examples/pong/game.lua
+
+```sql
+make -C build
 ```
 
-### Build cartbridge rom `.gba`
+## Building: Your Own Game with a Self-Made Engine
 
+```sql
+cmake -Bbuild -H. -DGAME=path/game.lua -DENGINE=path/engine.lua
 ```
+
+```sql
 make -C build
 ```
 
-## Run
+---
 
-```
-VisualBoyAdvance build/bin/game.gba
-```
+:whale: use [devkitpro/devkitarm](https://hub.docker.com/r/devkitpro/devkitarm) docker image if you do not have [devkitpro](https://devkitpro.org/wiki/devkitPro_pacman) installed.

mainpage.lua

@@ -10,6 +10,9 @@ static int native_draw_flush(lua_State *L)
     return 0;
 }
 
+/**
+ * @param[in] color @c int
+ */
 static int native_draw_clear(lua_State *L)
 {
     color_t t = { .pixel2 = luaL_checkinteger(L, 1) };
@@ -19,6 +22,9 @@ static int native_draw_clear(lua_State *L)
     return 0;
 }
 
+/**
+ * @param[in] color @c int
+ */
 static int native_draw_color(lua_State *L)
 {
     color_t t = { .pixel2 = luaL_checkinteger(L, 1) };
@@ -28,30 +34,57 @@ static int native_draw_color(lua_State *L)
     return 0;
 }
 
+/**
+ * @param[in] mode @c int
+ * @param[in] x @c double
+ * @param[in] y @c double
+ * @param[in] width @c double
+ * @param[in] height @c double
+ */
 static int native_draw_rect(lua_State *L)
 {
     uint8_t mode = luaL_checkinteger(L, 1);
-    uint8_t posx = luaL_checknumber(L, 2);
-    uint8_t posy = luaL_checknumber(L, 3);
-    uint8_t width = luaL_checknumber(L, 4);
-    uint8_t height = luaL_checknumber(L, 5);
-    draw_queue_push(48, mode, 0, 1, 0);
-    draw_queue_push(50, posx, posy, width, height);
+    int32_t posx = luaL_checknumber(L, 2);
+    int32_t posy = luaL_checknumber(L, 3);
+    int32_t width = luaL_checknumber(L, 4);
+    int32_t height = luaL_checknumber(L, 5);
+
+    if (geoclip_rect(&posx, &posy, &width, &height)) {
+        draw_queue_push(48, mode, 0, 1, 0);
+        draw_queue_push(50, (uint8_t) posx, (uint8_t) posy, (uint8_t) width, (uint8_t) height);
+    }
+
     lua_settop(L, 0);
     return 0;
 }
 
+/**
+ * @param[in] x1 @c double
+ * @param[in] y1 @c double
+ * @param[in] x2 @c double
+ * @param[in] y2 @c double
+ */
 static int native_draw_line(lua_State *L)
 {
-    uint8_t x1 = luaL_checknumber(L, 1);
-    uint8_t y1 = luaL_checknumber(L, 2);
-    uint8_t x2 = luaL_checknumber(L, 3);
-    uint8_t y2 = luaL_checknumber(L, 4);
-    draw_queue_push(51, x1, y1, x2, y2);
+    int32_t x1 = luaL_checknumber(L, 1);
+    int32_t y1 = luaL_checknumber(L, 2);
+    int32_t x2 = luaL_checknumber(L, 3);
+    int32_t y2 = luaL_checknumber(L, 4);
+
+    if (geoclip_line(&x1, &y1, &x2, &y2)) {
+        draw_queue_push(51, (uint8_t) x1, (uint8_t) y1, (uint8_t) x2, (uint8_t) y2);
+    }
+
     lua_settop(L, 0);
     return 0;
 }
 
+
+/**
+ * @param[in] source @c string
+ * @param[in] x @c double
+ * @param[in] y @c double
+ */
 static int native_draw_image(lua_State *L) {
     uint8_t x = luaL_checknumber(L, 2);
     uint8_t y = luaL_checknumber(L, 3);

src/draw.c

@@ -10,18 +10,27 @@ uint8_t draw_mode;
 void draw_cmd_color(uint8_t r, uint8_t g, uint8_t b, uint8_t a)
 {
     if (draw_mode != 3) {
-        tint.c16.color.r = r;
-        tint.c16.color.g = g;
-        tint.c16.color.b = b;
+        tint.c16.color.r = r>>3;
+        tint.c16.color.g = g>>3;
+        tint.c16.color.b = b>>3;
     } else {
-        clear.c16.color.r = r;
-        clear.c16.color.g = g;
-        clear.c16.color.b = b;
+        clear.c16.color.r = r>>3;
+        clear.c16.color.g = g>>3;
+        clear.c16.color.b = b>>3;
     }
 
     if (flush_mode) {
+        static const uint32_t *end = (uint32_t *) (0x06000000 + (240 * 160 * 2));
+        static uint16_t old_clear = 0;
         draw_color.arr[0] = clear.pixel;
         draw_color.arr[1] = clear.pixel;
+        if (old_clear != clear.pixel) {
+            uint32_t *i = (uint32_t *) 0x06000000;
+            while (i < end) {
+                *i++ = draw_color.pixel2;
+            }
+            old_clear = clear.pixel;
+        }
     } else {
         draw_color.arr[0] = tint.pixel;
         draw_color.arr[1] = tint.pixel;

src/draw_color.c

@@ -1,26 +1,64 @@
 #include "zeebo.h"
 
 #ifndef ENGINE_LOGO
-#define ENGINE_LOGO 1
+#error invalid ENGINE_LOGO
 #endif
 
+/**
+ * https://github.com/gamelly/gly-type
+ */
 extern void gly_type_render(uint8_t, uint8_t, uint8_t, char*, void*);
 
 void draw_logo()
 {
-#if ENGINE_LOGO != 0
+#if ENGINE_LOGO > 0
     draw_queue_page(1);
-    draw_queue_push(49, 0xFF, 0xFF, 0xFF, 0);
     draw_queue_push(48, 3, 0, 1, 0);
     draw_queue_push(49, 0, 0, 0, 0);
 #if ENGINE_LOGO == 1
+    static const uint8_t ver_x = 97;
+    static const uint8_t ver_y = 80;
+    draw_queue_push(48, 0, 0, 1, 0);
+    draw_queue_push(49, 0x00, 0x00, 0xFF, 0);
+    draw_queue_push(50, 90, 45, 50, 15);
+    draw_queue_push(49, 0x00, 0xFF, 0x67, 0);
+    draw_queue_push(50, 90, 45+15, 50, 5);
+    draw_queue_push(49, 0xFF, 0xe7, 0x00, 0);
+    draw_queue_push(50, 90, 45+20, 50, 5);
+    draw_queue_push(49, 0xFF, 0x76, 0x00, 0);
+    draw_queue_push(50, 90, 45+25, 50, 5);
+    draw_queue_push(49, 0xFF, 0x00, 0x00, 0);
+    draw_queue_push(50, 90, 45+30, 50, 5);
+    draw_queue_push(49, 0xFF, 0x00, 0xFF, 0);
+    draw_queue_push(50, 90, 45+35, 50, 10);
+    draw_queue_push(48, 1, 0, 1, 0);
+    draw_queue_push(49, 0xFF, 0xFF, 0xFF, 0);
+    gly_type_render(95, 56, 12, "gly", draw_queue_clojure(51));
+    gly_type_render(95, 72, 5, "engine", draw_queue_clojure(51));
+    draw_queue_push(50, 90, 45, 50, 45);
+#elif ENGINE_LOGO == 2
+    static const uint8_t ver_x = 97;
+    static const uint8_t ver_y = 84;
+    draw_queue_push(48, 0, 0, 1, 0);
+    draw_queue_push(49, 0x80, 0xC0, 0xFF, 0);
+    draw_queue_push(50, 90, 45, 50, 22);
+    draw_queue_push(49, 0xFF, 0x80, 0x80, 0);
+    draw_queue_push(50, 90, 45+22, 50, 23);
+    draw_queue_push(48, 1, 0, 1, 0);
+    draw_queue_push(49, 0xFF, 0xFF, 0xFF, 0);
+    gly_type_render(95, 67-5, 9, "LOVE", draw_queue_clojure(51));
+    draw_queue_push(51, 90+40, 45+2, 90+48, 45+2);
+    draw_queue_push(51, 90+48, 45+2, 90+48, 45+6);
     draw_queue_push(50, 90, 45, 50, 45);
-    gly_type_render(95, 60, 12, "gly", draw_queue_clojure(51));
-#else
-    gly_type_render(95, 67, 5, "native", draw_queue_clojure(51));
+#elif ENGINE_LOGO == 3
+    static const uint8_t ver_x = 107;
+    static const uint8_t ver_y = 80;
+    gly_type_render(95, 50, 5, "GameBoy", draw_queue_clojure(51));
+    gly_type_render(95, 56, 4, "advanced", draw_queue_clojure(51));
+    gly_type_render(95, 62, 10, "CORE", draw_queue_clojure(51));
+    gly_type_render(95, 74, 5, "native", draw_queue_clojure(51));
 #endif
-    gly_type_render(95, 74, 5, "engine", draw_queue_clojure(51));
-    gly_type_render(97, 80, 4, "0.0.16", draw_queue_clojure(51));
+    gly_type_render(ver_x, ver_y, 4, "0.0.17", draw_queue_clojure(51));
     draw_queue_burn(1);
 #endif
 }