Code Monkey home page Code Monkey logo

azure-mystery-mansion-js's Introduction

Azure Mystery Mansion

Getting set up with development

In general, this project uses Em's dev-focused Twine workflow.

Getting set up with Tweego

If you want to compile and test locally, you'll need the tweego app. You can download a precompiled binary from the releases at https://github.com/tmedwards/tweego.git, but I'd recommend compiling from source:

  • Make sure you have golang installed (brew install go if you're on a Mac)
  • Make sure your GOPATH is part of your system PATH: export PATH="$(go env GOPATH)/bin:$PATH"
  • Run go get https://github.com/tmedwards/tweego.git

From here, you should be able to just run tweego as a CLI tool.

Actually working on the game

Once you have a functioning Tweego binary, you're good to go!

  • The game itself lives in mysterymansion.twee. I personally use VS Code (you can download a Twee syntax highlighter).
  • To live-compile the game, run tweego -w mysterymansion.twee -o index.html. Run a web server of your choice (e.g. python -m SimpleHTTPServer from within the project dir), and index.html will update whenever you save the Twee file. It's possible images will be broken; I get that's annoying, but it won't be broken on production.
  • If you would rather edit in the visual Twine editor, you can import that index.html file into a downloaded copy of Twine 2. You should convert it back into a Twee file before committing changes to git; tweego -d index.html -o mysterymansion.twee will do that.
  • Pull request in your changes!
  • When your code hits master on GitHub, a GitHub Action is responsible for compiling the Twee file into a website, doing some file munging to make our microsoft.com redirect work properly, and then deploy the latest version of the code to Azure.
  • Up for discussion: the code might be cleaner if we let ourselves split it out into separate files via Twee imports. This would break the ability to edit the game in the Twine editor. I think this may be a positive tradeoff, but I'm not going to make that executive decision right now.

azure-mystery-mansion-js's People

Contributors

jlooper avatar lazerwalker avatar

Forkers

sweetgoomba

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.