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

https://github.com/HellRok/Taylor

A simple game engine built using raylib and mruby
https://github.com/HellRok/Taylor

2d-game-engine game game-engine indiegame mruby raylib ruby

Last synced: 3 months ago
JSON representation

A simple game engine built using raylib and mruby

Awesome Lists containing this project

README

          






Taylor logo


Made for Games

> [!CAUTION]
> Taylor is currently going through a major refactor, see
> https://github.com/HellRok/Taylor/issues/35 for the current progress.

![GitHub Release](https://img.shields.io/github/v/release/HellRok/Taylor)
[![Build status](https://badge.buildkite.com/0cb81ca8e3b8f43a2998bc15f90323a2eb8429669e819b7697.svg)](https://buildkite.com/oequacki/taylor)
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/HellRok/Taylor/total?label=total%20downloads)
![GitHub License](https://img.shields.io/github/license/HellRok/Taylor)

[Website](https://www.taylormadetech.dev) | [Cheat Sheet](https://www.taylormadetech.dev/documentation/tutorials/cheat_sheet/) | [Documentation](https://www.taylormadetech.dev/documentation/taylor/latest/) | [Try it Out Online](https://www.taylormadetech.dev/playground/)

## What's This?

Taylor is a game engine I've built using [mruby](https://mruby.org/) and
[raylib](https://www.raylib.com/). I'm trying to build a very simple way for
people to get into game development. This is trying to replicate the simplicity
of [QBasic](https://wikipedia.org/wiki/QBasic) but with a more of a modern approach.

## Getting Started

Check out my tutorial over on the [official Taylor
website](https://www.taylormadetech.dev/documentation/tutorials/getting_started/).

## Examples

If you'd like to see some examples, check them out on the [online playground!](https://www.taylormadetech.dev/playground/)

## Compile Yourself!

> [!NOTE]
> Currently there are no instructions for Windows and OSX.

### Linux

1. Install the build dependencies:

Fedora

```console
$ sudo dnf groupinstall "Development Tools" "Development Libraries"; sudo dnf install ruby
```


Ubuntu/Debian

```console
$ sudo apt-get install build-essential ruby
```

3. You should now be able to just run `rake` and wait a few seconds. Once the compilation finalises, the
binary will be located on `dist/linux/debug/taylor`.
4. **Optional**: if you want the nice command line interface, you'll need to run this script:
```console
$ ./dist/linux/debug/taylor ./cli-tool/cli.rb
```

Additionally, You may want to add the Taylor executable to your PATH so you can call it from anywhere. You can
use the following shell script as a base, it'll also run the CLI for you:

```shell
#!/usr/bin/env bash
TAYLOR_PATH=/home/sean/code/taylor/ # Change to where you cloned the repo

"$TAYLOR_PATH/dist/linux/debug/taylor" "$TAYLOR_PATH/cli-tool/cli.rb" "$@"
```

Save it as `taylor` and make it executable (`chmod +x taylor`), then add this on the end of your `.bashrc`:

```bash
export PATH="$HOME/code/taylor:$PATH" # Change the path to where you saved the shell script
```

## Docker

To build all the Docker images you can run the following command:

```
$ bundle exec rake docker:build:all
```

If you also want to compile the mruby and raylib dependencies yourself there are
Docker images for that too, just run:

```
$ bundle exec rake docker:build:{mruby,raylib}
```

## License

Taylor is free and open-source, licensed under the [MIT license](https://github.com/HellRok/Taylor/blob/main/LICENSE).