Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alxm/faur

⚒️✨ My personal C games framework. 2D graphics, sound, inputs, states, ECS, and misc utils for data, files, math, memory, strings, time, and more. Builds for Linux, Windows, Web, and embedded devices.
https://github.com/alxm/faur

2d-game-framework 2d-graphics arduino arduino-library c c99 caanoo emscripten game-development gamebuino-meta gamedev gamedev-framework gp2x gp2x-wiz linux mingw odroid-go pandora-console sdl sdl2

Last synced: 6 days ago
JSON representation

Host: GitHub
URL: https://github.com/alxm/faur
Owner: alxm
License: gpl-3.0
Created: 2011-07-10T23:01:28.000Z (over 13 years ago)
Default Branch: master
Last Pushed: 2024-10-21T03:10:23.000Z (3 months ago)
Last Synced: 2025-01-07T21:09:18.011Z (14 days ago)
Topics: 2d-game-framework, 2d-graphics, arduino, arduino-library, c, c99, caanoo, emscripten, game-development, gamebuino-meta, gamedev, gamedev-framework, gp2x, gp2x-wiz, linux, mingw, odroid-go, pandora-console, sdl, sdl2
Language: C
Homepage: https://www.alxm.org
Size: 4.76 MB
Stars: 83
Watchers: 4
Forks: 12
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # [![Faur](./media/faur.png "Faur")](https://www.alxm.org)

*Faur* is my personal C framework for my [hobby video games](https://www.alxm.org).

Features include software or accelerated 2D graphics, abstractions for inputs and sound, application state management, entity-component-system model, and utilities to help with data, files, math, memory, strings, time, and more.

Faur builds native on Linux and cross-compiles for Web, Windows, and some embedded devices like the GP2X and Gamebuino handhelds. The build system uses GNU Make 4.1 and Python 3.6 or later.

## Install on Debian and Create a New Project

```sh

$ sudo apt install build-essential git

$ sudo apt install python3 python3-pil

$ sudo apt install libpng-dev libsdl2-dev libsdl2-mixer-dev

$

$ cd $HOME

$ git clone https://github.com/alxm/faur.git

$

$ export FAUR_PATH=$HOME/faur

$ export PATH=$PATH:$FAUR_PATH/bin

$

$ faur-new --name hello

$ cd hello/build/make/

$ make run

```

![Hello, World screenshot](./media/hello.gif "Hello, World screenshot")
*Move the square with the arrow keys or with a game controller.*

### Generated Project Files

```sh

$ tree hello/

hello/

├── build/

│   └── make/

│       └── Makefile

└── src/

    └── main.c

```

#### hello/src/main.c

```c

#include 

void f_main(void)

{

    static struct {

        int x, y;

        FButton *up, *down, *left, *right;

    } context;

    F_STATE_INIT

    {

        context.x = f_screen_sizeGetWidth() / 2;

        context.y = f_screen_sizeGetHeight() / 2;

        context.up = f_button_new();

        f_button_bindKey(context.up, F_KEY_UP);

        f_button_bindButton(context.up, F_BUTTON_UP);

        context.down = f_button_new();

        f_button_bindKey(context.down, F_KEY_DOWN);

        f_button_bindButton(context.down, F_BUTTON_DOWN);

        context.left = f_button_new();

        f_button_bindKey(context.left, F_KEY_LEFT);

        f_button_bindButton(context.left, F_BUTTON_LEFT);

        context.right = f_button_new();

        f_button_bindKey(context.right, F_KEY_RIGHT);

        f_button_bindButton(context.right, F_BUTTON_RIGHT);

    }

    F_STATE_TICK

    {

        if(f_button_pressGet(context.up)) context.y--;

        if(f_button_pressGet(context.down)) context.y++;

        if(f_button_pressGet(context.left)) context.x--;

        if(f_button_pressGet(context.right)) context.x++;

    }

    F_STATE_DRAW

    {

        f_color_colorSetHex(0xaaff88);

        f_draw_fill();

        f_color_colorSetHex(0xffaa44);

        f_draw_rectangle(context.x - 40, context.y - 40, 80, 80);

    }

    F_STATE_FREE

    {

        f_button_free(context.up);

        f_button_free(context.down);

        f_button_free(context.left);

        f_button_free(context.right);

    }

}

```

#### hello/build/make/Makefile

```make

F_CONFIG_APP_AUTHOR := 

F_CONFIG_APP_NAME := hello

include $(FAUR_PATH)/make/default.mk

```

## Cross-Compile for Other Platforms

I started Faur by collecting my [GP2X games'](https://www.alxm.org/games/gamepark.html) shared code into a static library. Over time I added support for more platforms:

Target | Host | Toolchain | Dependencies | More Info

--- | --- | --- | --- | ---

***Desktop***

Linux (SDL 2) | Linux | OS build tools | Debian: `libsdl2-dev` `libsdl2-mixer-dev` `libpng-dev` `valgrind`

Fedora: `SDL2-devel` `SDL2_mixer-devel` `libpng-devel` `libubsan` `valgrind`

Linux (SDL 1.2) | Linux | OS build tools | Debian: `libsdl1.2-dev` `libsdl-mixer1.2-dev` `libpng-dev` `valgrind`

Fedora: `sdl12-compat-devel` `SDL_mixer-devel` `libpng-devel` `libubsan` `valgrind`

FreeBSD | FreeBSD | OS build tools | `gmake` `devel/sdl20 audio/sdl2_mixer` | [Building on FreeBSD](https://www.alxm.org/notes/a2x-freebsd.html)

Windows | Linux | MinGW-w64 | Debian: `mingw-w64` `libz-mingw-w64-dev` and local builds of `SDL2` `SDL2_mixer` `libpng`

Fedora: `mingw64-gcc` `mingw64-gcc-c++` `mingw64-SDL2` `mingw64-SDL2_mixer` `mingw64-libpng` `mingw64-zlib` | [Cross-compiling with MinGW](https://www.alxm.org/notes/a2x-mingw.html)

Web (Wasm) | Linux | Emscripten 3.1.66 | | [Emscripten Notes](https://www.alxm.org/notes/emscripten.html)

***Embedded Linux***

GP2X, GP2X Wiz | Linux | Open2x SDK | Debian: `ia32-libs` | [Open2x Project](https://sourceforge.net/p/open2x/code/HEAD/tree/)

Caanoo | Linux | GPH SDK | Debian: `ia32-libs` | [Caanoo SDK for Linux](https://dl.openhandhelds.org/cgi-bin/caanoo.cgi?0,0,0,0,17,631)

Open Pandora | Linux | Pandora SDK | Debian: `ia32-libs libxml2-utils` | [Open Pandora Forums](https://pyra-handheld.com/boards/)

***Arduino***

Gamebuino META | Linux | Arduino 1.8.19, Arduino SAMD Boards 1.8.11, Gamebuino META Boards 1.2.2 | Arduino: `Gamebuino META 1.3`

Debian: `ffmpeg`

Fedora: `ffmpeg-free` | [Gamebuino META Makefile](https://www.alxm.org/notes/gamebuino-meta-makefile.html)

ODROID-GO | Linux | Arduino 1.8.19, Arduino-ESP32 1.0.6 | Arduino: `ODROID-GO 1.0.0`

Debian: `python3-serial` `python-is-python3`

Fedora: `python3-pyserial` | [ODROID Wiki](https://wiki.odroid.com/odroid_go/arduino/01_arduino_setup)

The default toolchain paths are in `make/global/sdk.mk`, and they can be overridden in a project Makefile or globally in `~/.config/faur/sdk.mk`. To build for different targets, change `include $(FAUR_PATH)/make/default.mk` to use other files from `$(FAUR_PATH)/make`.

## License

Copyright 2010-2024 Alex Margarit ([email protected])

* Source code licensed under [GNU GPL 3.0](https://www.gnu.org/licenses/gpl.html) (file `LICENSE`)

* Other content licensed under [CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/) (file `media/CC-BY-NC-ND`)

Faur is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. The project is named after the old Romanian word *faur*, sometimes used in fables to mean *wizard blacksmith*. ⚒️✨

### Contributing

This is my personal framework and ideas playground, a solo project. You are welcome to check it out and use it under the terms of the license, but I do not take pull requests to this repo.