Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zsotroav/fok-gyem-tetris-native
Native Tetris game for FOK-GYEM with detachable game engine
https://github.com/zsotroav/fok-gyem-tetris-native
fok-gyem multiplatform szig-fok-gyem tetris-engine
Last synced: 18 days ago
JSON representation
Native Tetris game for FOK-GYEM with detachable game engine
- Host: GitHub
- URL: https://github.com/zsotroav/fok-gyem-tetris-native
- Owner: zsotroav
- License: gpl-3.0
- Created: 2024-08-30T13:23:28.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-10-14T11:19:34.000Z (3 months ago)
- Last Synced: 2024-11-06T06:15:49.705Z (2 months ago)
- Topics: fok-gyem, multiplatform, szig-fok-gyem, tetris-engine
- Language: C++
- Homepage: https://discord.gg/dMrwaAkEcv
- Size: 124 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FOK-GYEM Tetris - Arduino native
Multiplatform tetris clone for SZIG-FOK-GYEM controlles and other devices.
This project contains a considerable amount of platform specific code, part of
which are handled automatically via preprocessor statements, but most are split
into different files marked with suffixes. For more info see the
[compiling](#Compiling) section.
## Requirements
- SzIG-FOK-GYEM driver controller board
- controller keypad with 7 buttons
OR
- Windows/Linux computer with a keyboard and terminal
## Cloning
The driver for the controller is included as a submodule, as such recursive
cloning is required for compiling for Arduino.
### Cloning commands
#### Without sparse checkout
```sh
git clone --recurse-submodules https://github.com/zsotroav/FOK-GYEM-Tetris-native
cd FOk-GYEM-Tetris-native
```
#### With sparse checkout
This is was previously required to avoid conflicting `setup` and `loop`
functions, but is no longer neccesary because of a new layout in
[main.cpp](./src/main.cpp).
```sh
git clone https://github.com/zsotroav/FOK-GYEM-Tetris-native
cd FOK-GYEM-Tetris-native
git submodule update --init --recursive
cd lib/fgy-driver
git sparse-checkout init --no-cone
git sparse-checkout set /* !src/main.cpp
git sparse-checkout reapply
cd ../..
```
## Compiling
This game can be compiled for both Arduino and PC systems (mainly for debugging
and testing purposes). Platform specific instructions:
| Action | PC | Arduino |
|------------------------------------------|----|---------|
| Define `NONARDUINO` macro | X | - |
| Compile source files with pc suffix | X | - |
| Compile source files with arduino suffix | - | X |
| Include `lib/econio` in build | X | - |
| Include `lib/fgy-driver` in build | - | X |
*Note: The `NONARDUINO` macro is planned to be removed to make the code
completely modular and work based only on which files are compiled and linked.*
### Pre-made compiler settings
- For PC, use the proviced [CMakeLists](./CMakeLists.txt) file.
- For Arduino, usage of [PlatformIO](https://platformio.org/) with
[Visual Stuio Code](https://code.visualstudio.com) is recommended with the
[example pio ini](./platformio.ini.example) file.