ScapoLite

Version, currently main branch1 version
  • main branchlatestMay 18, 2022

github.com/Anyolite/ScapoLite

An Anyolite demo game, playable on the terminal

7 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  ScapoLite:
    github: Anyolite/ScapoLite
    branch: main

main is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
>= 0.34.0
License
MIT
Author
Hadeweka

Dependencies

Runtime Dependencies

  • anyolite1.0.0github: Anyolite/anyolite, branch: main

README

# ScapoLite

## Introduction

ScapoLite is a demo game, which is designed to show the capabilities of Anyolite.

Link to Anyolite: https://github.com/Anyolite/Anyolite.

![grafik](https://github.com/Anyolite/ScapoLite/blob/main/screenshots/Screenshot.png)

## Information

In this game, you play a gem-loving hamster named Jacinth.
Currently, there is not much to do yet, but at least you can collect some of the gems.

However, the main purpose of ScapoLite is not to play some simple Rogue-like.
ScapoLite aims to demonstrate how easily Anyolite can be embedded into a project.

Play around with this project as much as you want! 

Every single class and public function can be accessed from the embedded mruby interpreter,
so the test script can be expanded in many ways.

Try the following things in the test script (without changing anything in the Crystal files):
* Change the field size or the hamster starting position
* Add more objects to the field
* Add a custom entity or tile to the field
* Add different collectibles with different symbols and score
* Add a teleporter entity which teleports the hamster to a linked portal (and back)

## Controls

Control the hamster with WASD or arrow keys. Quit the game with ESCAPE, Q or CTRL+C.

## Installation and running

Make sure to have Crystal installed (including shards). Then, run `shards install`,
compile the game using `crystal build main.cr` and finally run `./main` to start it.

## Roadmap

### Version 0.1.0

#### Features

* [X] Basic structure

#### Known bugs

* [ ] Characters might leak out of the field if keys are pressed down