Setup guide for complete newbies

fogmike
Having never used Github, Python or Markdown before, I'm a bit overwhelmed by how to even set this up. Can someone who does know what they're doing walk me through:
- What exactly I need to download
- How to create a Squiffy file
- How to play a test version, ie how to locally run it

Think I get the second part - create your file in any text editor, save it as name.squiffy, then run squiffy.py name.squiffy to compile it...is that right? But I'm not 100% sure how even to do that...

If anyone has the time to provide a step by step guide to getting started, I (and I imagine many others) would be extremely grateful!

(Also, are Squiffy files currently uploadable/playable on the main TA site?)

Alex
This will all become much easier when Squiffy is properly released, as there will be easily downloadable binaries for Windows and Mac OS X. Eventually there will be a web-based editor - before that, I'll probably create a simple online service where you can upload a Squiffy file and then download the generated game.

Until then, here's what to do:

- if you're using Windows, you need to install Python from https://www.python.org/downloads/. Either Python 2 or Python 3 should work - I've been mostly testing with Python 2. If you're using a Mac, you already have Python 2.
- install pip. If you're using Python 3 you've already got this (apparently). Otherwise follow the instructions at https://pip.pypa.io/en/latest/installing.html
- install the Markdown package by typing this at a command prompt or Terminal window: pip install markdown
- download Squiffy by clicking "Download ZIP" at the bottom of the right-hand column on https://github.com/textadventures/squiffy, and unzip it somewhere.

You can create a Squiffy file in any text editor - Notepad, Sublime Text, TextEdit etc. It's probably easiest to make a new folder inside your Squiffy folder and put it there.

e.g. if your new folder is called "mygame" and your Squiffy file is "mygame.squiffy" then you can go to a command prompt and type:


python squiffy.py mygame/mygame.squiffy


If it all works then you'll get some files written into your "mygame" folder. Double-click index.html to play the game.

You can zip the files up and upload to textadventures.co.uk.

fogmike
Bug report - index.html is showing me a blank screen for IE11.0.9 where my input should be, though the restart button exists.

But the file compiled correctly and works in Chrome, thanks very much! Now to get writing...

Alex
Glad it's working!

Thanks for the bug report - I've logged it here https://github.com/textadventures/squiffy/issues/24 so will take a look. Please log any other bugs you find on GitHub!

fogmike
Will do!

This topic is now closed. Topics are closed after 180 days of inactivity.

Support

Forums