https://github.com/Ogmo-Editor-3/OgmoEditor3-CE

The Community Edition of Ogmo Editor 3
https://github.com/Ogmo-Editor-3/OgmoEditor3-CE

Last synced: 3 months ago
JSON representation

The Community Edition of Ogmo Editor 3

• Host: GitHub
• URL: https://github.com/Ogmo-Editor-3/OgmoEditor3-CE
• Owner: Ogmo-Editor-3
• License: mit
• Created: 2019-04-11T22:04:18.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-01T18:22:05.000Z (7 months ago)
• Last Synced: 2024-05-28T12:51:12.908Z (6 months ago)
• Language: Haxe
• Homepage: https://ogmo-editor-3.github.io
• Size: 3 MB
• Stars: 484
• Watchers: 11
• Forks: 49
• Open Issues: 73
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
 


  



### Open Source 2D level editor written in Haxe!

For more information, check out the [Ogmo 3 homepage](https://ogmo-editor-3.github.io/). Or just go straight to the [downloads page](https://ogmoeditor.itch.io/editor)! If you need a build for 32 bit Windows, @vontoGH has graciously made them [available here](https://github.com/vontoGH/OgmoEditor3-CE/releases)!

# Getting Started

This project requires Haxe v4.0.0 or later, Node v10+, and various dependencies for each of them.

### Node

* Install [Node](https://nodejs.org/)

### Haxe

* Install [Haxe](https://haxe.org/download/)

* Run the following commands:

```

haxelib setup

haxelib install electron 12.0.4

haxelib install jQueryExtern

haxelib install haxe-loader

```

## Build

```

npm i

npm run build

```

This builds the App and puts it in the `bin` directory. You can then start the app by running `npm start`, or by starting electron in the directory.

## Development

Speed up development by using Webpack's dev server! Running `npm run dev` builds the app, starts a server that will watch for changes in the project, then starts electron. If changes are found, Webpack will rebuild the source and refresh the app. If there are errors, they will show up in the app's DevTools.

While running the dev server, all code that is within `#if debug` conditionals are added in.

NOTES: 

  * Changes to `App.hx` are not watched, and the app will need to manually be rebuilt if changes are made there.

  * The app will need to be rebuilt normally (`npm run build`) in order to run it again after using the dev server.

## Packaging

```

npm i

npm run build

npm run dist

```

This builds, then packages the App into an executable.

# Credits

 - Created by [Maddy Thorson](https://twitter.com/MaddyThorson) and [Noel Berry](https://twitter.com/noelfb)

 - Icons & Logo by [Kyle Pulver](https://twitter.com/kylepulver)

 - Ported to Haxe and extended by [Caleb Cornett](https://twitter.com/thespydog), [Will Blanton](https://twitter.com/x01010111), and [Austin East](https://twitter.com/austinweast)