https://github.com/mattjennings/merlyn

A meta framework for Excalibur.js
https://github.com/mattjennings/merlyn

Last synced: about 8 hours ago
JSON representation

A meta framework for Excalibur.js

• Host: GitHub
• URL: https://github.com/mattjennings/merlyn
• Owner: mattjennings
• Created: 2022-06-02T01:27:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-13T23:24:53.000Z (about 2 years ago)
• Last Synced: 2023-03-05T14:08:59.172Z (over 1 year ago)
• Language: TypeScript
• Size: 56.2 MB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE/LICENSE

Awesome Lists containing this project

README

        
# Merlyn

A meta framework for creating [Excalibur.js games](https://excaliburjs.com). Like Next.js to React, or SvelteKit to Svelte.

This is still in the very early stages. There are no docs and everything is subject to change and break frequently. Use at your own risk.

## Features

- File-based routing for scenes

  - `src/scenes/level1.ts` -> a scene named `level1`

- Loaders are implemented as Scenes

  - this allows you to use actors and other Excalibur objects in your loading screens

- Automatic resource loading. Loader will be populated and loaded when Scene is navigated to.

  ```js

  // equivalent to ex.ImageSource('/player.png')

  const sprite = $res('/player.png').toSprite()

  actor.graphics.use(sprite)

  // can safely be used inline

  $res('/jump.mp3').play()

  // asset can be referenced inline multiple times - it will only be loaded once

  $res('/jump.mp3').play(0.5)

  ```

## Development

This is a monorepo that uses pnpm.

```

pnpm install

cd packages/merlyn

pnpm run dev

```

In another terminal, you can go to the examples and run `pnpm run dev`

## Contributing

Unless you are willing to contribute, please refrain from creating issues as this is not ready for general usage. I am still exploring what this framework can/will do, and in order to get this to a usable state I am focusing on my own needs for this project for now.

## Credits

Merlyn is heavily inspired by [SvelteKit](https://kit.svelte.dev) (in fact, it originally began as a fork of it). As such, some of its code was copied and used. You can find the license for SvelteKit [here](/LICENSE/LICENSE-SvelteKit).