Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
NotMyWing authored Jun 21, 2019
1 parent 7002f15 commit 027d6d8
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
# StarfallEX-Moonpanel
It's a panel, written in moon language. As inspired by The Witness, a game by Thekla Inc.

Currently supports suns, colors, triangles, hexagons and disjoints. Allows for symmetry puzzles.
Important notice: this panel DOES NOT support negative polyominoes. All other elements, including polyominoes, Y-symbols, coloured squares, suns and triangles, are supported. You can also import [The Windmill puzzles](https://windmill.thefifthmatt.com) if you want to! Currently this requires a bit of preparation though.

Right now it doesn't understand neither the Polyomino rule, nor the Y-symbol rule. This is yet to be implemented in future!
![hi](https://media.discordapp.net/attachments/403032923508310017/591472190914822154/unknown.png?width=1087&height=678)

![hi](https://media.discordapp.net/attachments/439029143078830081/587952524376408080/unknown.png)
# How do I X?

To install, get Node.js, and run `npm install` in this directory.
Make sure you have gulp-cli installed globally.
Obviously, the first thing you'll need is [StarfallEx](https://github.com/thegrb93/StarfallEx). I haven't tested it with vanilla Starfall, but if you do, let me know if it works.

To build, run `gulp moon`.
To watch, run `gulp watch`.
If you want to just screw around, navigate to Releases section and steal the latest release. Unzip the archive somewhere, navigate to your garry's mod folder, search for the `/garrysmod/data/starfall` directory and plop the `moonpanel` folder there.

To run, copy the entire `moonpanel` directory into your garrysmod/data/starfall folder, load a test panel and try it out.
If you want some presets, there is a bunch of them in the `moonpanelPresets` folder. Drop it into the starfall directory as well and spawn a chip.

Thanks to Bytewave for making the buildscript.
I guess.
# How do I X: Advanced stuff

To get started, install Node.js, and run `npm install` in this directory. Either via cmd, or bash, or you using a shell of your choice.

To download a puzzle from The Windmill, type `node windmillDownloader.js`.

If you want to contribute, run `gulp moon` to compile the code, and just `gulp` to watch.

0 comments on commit 027d6d8

Please sign in to comment.