https://github.com/patrickswijgman/ridder
A straightforward game engine for simple data-driven games in JavaScript
https://github.com/patrickswijgman/ridder
canvas data-driven data-oriented-design game-development game-library gamedev html5-game-development javascript typescript
Last synced: 8 months ago
JSON representation
A straightforward game engine for simple data-driven games in JavaScript
- Host: GitHub
- URL: https://github.com/patrickswijgman/ridder
- Owner: patrickswijgman
- Archived: true
- Created: 2024-06-20T09:06:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-29T11:32:55.000Z (11 months ago)
- Last Synced: 2025-06-06T15:06:41.072Z (8 months ago)
- Topics: canvas, data-driven, data-oriented-design, game-development, game-library, gamedev, html5-game-development, javascript, typescript
- Language: TypeScript
- Homepage:
- Size: 535 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ridder
A zero-dependency and simple data-oriented game engine for JavaScript that has everything you need to get started and to get things done.
There won't be extensive documentation as the game engine is intended to be simple, the documentation in the code and the [examples](#examples) below should get you in the right direction.
## Getting started
You can get started instantly by copying the Ridder template [repo](https://github.com/patrickswijgman/ridder-template) with the following command, be sure to replace `` with the name of your game.
```shell
npx degit patrickswijgman/ridder-template#main
cd
npm ci
npm start
```
Or install manually in your own project with the following command.
```shell
npm install ridder
```
## Examples
See the table below for the code of each example or play it instantly (using Github Pages).
| | Play | Code | Keywords |
| -------------- | ------------------------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------- |
| input | [link](https://patrickswijgman.github.io/ridder/input/dist/index.html) | [link](examples/input/index.ts) | `keyboard` `mouse` |
| font | [link](https://patrickswijgman.github.io/ridder/font/dist/index.html) | [link](examples/font/index.ts) | `ttf` |
| mobile | [link](https://patrickswijgman.github.io/ridder/mobile/dist/index.html) | [link](examples/mobile/index.ts) | `vectors` `mouse` `transforms` |
| platformer | [link](https://patrickswijgman.github.io/ridder/platformer/dist/index.html) | [link](examples/platformer/index.ts) | `collision` `gravity` `camera` `transforms` |
| polygon | [link](https://patrickswijgman.github.io/ridder/polygon/dist/index.html) | [link](examples/polygon/index.ts) | `hitbox` `mouse` |
| render-texture | [link](https://patrickswijgman.github.io/ridder/render-texture/dist/index.html) | [link](examples/render-texture/index.ts) | `render-texture` `transforms` |
| sprite | [link](https://patrickswijgman.github.io/ridder/sprite/dist/index.html) | [link](examples/sprite/index.ts) | `sprite` `animation` `transforms` |
| top-down | [link](https://patrickswijgman.github.io/ridder/top-down/dist/index.html) | [link](examples/top-down/index.ts) | `vectors` `depth-sorting` `render-texture` `camera` `camera-shake` `transforms` |
| tween | [link](https://patrickswijgman.github.io/ridder/tween/dist/index.html) | [link](examples/tween/index.ts) | `animation` |
Or you can clone this project and run an example from the [examples folder](/examples) like so:
```shell
# make sure to install the dependencies first, you only need to do this once:
npm ci
# run an example
npm start -w # e.g. npm start -w platformer
```