Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jmickle66666666 authored Dec 28, 2018
1 parent b22f807 commit 391d405
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,15 @@ JZBuilder is a map editor for Doom, built for the web!

# why

Good question. It's fun!
While the various existing Doom map editors are fantastic at what they do, they have various levels of inaccesibility and techinical limitations as to what is possible with them. JZBuilder is built with typescript and doesn't work with Doom map data directly, allowing many new possibilities when it comes to creating maps.

Using a javascript-based approach means extending the editor is as simple as opening the console. Since javascript is the most commonly used language in use today, this allows many more contributors to extend or work with the project.

Using a compeletely separated data representation from Doom's map data allows a huge range of possibilities with editor functionality. The already-introduced Edge Modifiers, and non-destructive would not be possible without an explicit compilation/export step. Hopefully over time even more exciting features will be created because of this, too.

# goals

I aim to keep the project setup as simple as possible, so that people can dive in quickly and easily, and play around with the app. Using typescript instead of pure javascript is a decision to aide development at the cost of having a compile step. I think for an application of this complexity I believe it is a good balance between ease of use and ease of setup.

# how

Expand All @@ -20,4 +28,4 @@ Load up `index.html` to try it out! It runs locally just fine.

# license

no license yet. wad-js is under the MIT license.
no license yet. three.min.js and wad-js are under the MIT license.

0 comments on commit 391d405

Please sign in to comment.