<!--
SPDX-FileCopyrightText: 2024 vivi developers <vivi-ui@tuta.io>
SPDX-License-Identifier: MIT
-->

# GameFrog

GameFrog is a retro game library 🕹️ for GB styled games written in Rust 🦀,
TypeScript or JavaScript. Inspired by [pico8](https://www.lexaloffle.com/pico-8.php).

## Specifications

- `Display`: 160x144px 4 colors
- `Sprites`: 256 8x8 sprites
- `Map`: 128x64 tiles
- `Framerate`: ~60fps

## Features

- Develop games with Rust 🦀, TypeScript or JavaScript
- built-in sprite editor
- built-in map editor
- 3 different colors palettes (gray, green, red)
- Desktop and web support

## Planned features

- audio editor
- no_std support
- mobile support

## Differences to pico8

- Rust, TypeScript or JavaScript instead of Lua
- No built-in code editor (maybe in the future)
- No built-in terminal (maybe in the future)
- No built-in catalogue (maybe in the future)
- Code changes need to be recompiled (hot reloading maybe in the future)

## Controls

- Buttons
  - `A`: (A on keyboard)
  - `B`: (S on keyboard)
  - `Select`: (Space on keyboard)
  - `Start`: (Enter on keyboard)
  - `Mouse`: (Mouse left or right)
  - `Left`: (Left arrow key on keyboard)
  - `Right`: (Right arrow key on keyboard)
  - `Up`: (Up arrow key on keyboard)
  - `Down`: (Down arrow key on keyboard)
- Keys
  - `Escape`: switch between game and editor on debug build
  - `CTRL-P`: switch color palette
  - `CTRL-S`: saves sprite-map and tile-map on debug build
  - `CTRL-R`: restart game

## Examples

- [adventure](./examples/adventure/): minimal adventure example with sprites and
  map (rust 🦀 | wip).
- [confetti](./examples/confetti/): shows how to implement practical system
  (rust 🦀). Ported from [runty8](https://github.com/jjant/runty8).
- [adventure_deno](./examples/adventure_deno/): minimal adventure example with
  sprites and map (TypeScript | wip)
- [confetti_deno](./examples/confetti_deno/): shows how to implement practical
  system. Ported from [runty8](https://github.com/jjant/runty8). (TypeScript |
  wip)

## Crates

- [game_frog](./game_frog/): api library part, use this crate to implement you game.
- [game_frog_core](./game_frog_core/): base components for input, drawing and api.
- [game_frog_emu](./game_frog_emu/): GB emulator frontend for
  [rgy](https://github.com/YushiOMOTE/rgy).
- [game_frog_runtime](./game_frog_runtime/): runtime environment of game_frog.
- [game_frog_deno](./game_frog_deno/): api library part for TypeScript/JavaScript based on
  deno and wasm.

## Implementation details

- games and emulator are drawn to a virtual display
- for draw operations `embedded-graphics` is used
- the editor is also a `game_frog::Game`
- [MVC pattern](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller)
  on runtime

## Notable dependencies

- [embedded-graphics](https://github.com/embedded-graphics/embedded-graphics):
  Embedded graphics library for small hardware displays.

## Donation

`GameFrog` will always be free and you don't have to pay for it. But if you like the project and you want support its development with a donation feel free to use Librepay.

<a href="https://liberapay.com/vivi-ui/donate"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a>

## License

The source code of game_frog available under the terms of MIT license. (See
[LICENSE-MIT](./LICENSES/MIT.txt) for details.)