https://github.com/wolfadex/elmgine
An exploration of a game engine & editor build in Elm
https://github.com/wolfadex/elmgine
Last synced: 8 months ago
JSON representation
An exploration of a game engine & editor build in Elm
- Host: GitHub
- URL: https://github.com/wolfadex/elmgine
- Owner: wolfadex
- Created: 2021-08-07T06:24:49.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-09T23:08:25.000Z (almost 5 years ago)
- Last Synced: 2025-02-07T18:15:04.821Z (over 1 year ago)
- Language: Elm
- Size: 16.7 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Elmgine
A modification of [erkal/elm-3d-playground-exploration](https://github.com/erkal/elm-3d-playground-exploration) where a GUI is provided for writing code, modifying configurations, and a WYSIWYG editor for the game world.
# ⚠ This is an experiment! Expect frequent breaking changes poor performance. ⚠
## For Development
First [install yarn](https://classic.yarnpkg.com/en/docs/install/#mac-stable) if you don't have it already.
Clone the repository
```bash
git clone https://github.com/wolfadex/elmgine.git
```
and navigate into it:
```bash
cd elmgine
```
To install all dependencies, type and run
```bash
yarn
```
To compile the editor in dev mode run
```bash
yarn dev
```
To start the editor run
```bash
yarn start
```
## Example
Once the editor is running, paste
```elm
module UserGame exposing (view)
import Html exposing (Html)
view : Html msg
view =
Html.text "G g g game TIME!!"
```
into the editor and click `Compile`. The running version of your game will display below the code editor.
**Note: To escape the code editor with the keyboard press `Esc` and the either `Tab` or `Shift + Tab`. This allows you to use the `Tab` key to insert correct indentation in the code editor.