Permalink
Browse files

Update documentation (#355)

* Add build instructions

* Update README with Markdown syntax
  • Loading branch information...
CapacitorSet authored and jacob1 committed Mar 20, 2017
1 parent 0832caa commit 74d67070f03cf799e30b543893954dbcbe465da6
Showing with 112 additions and 101 deletions.
  1. +0 −101 README
  2. +112 −0 README.md
101 README

This file was deleted.

Oops, something went wrong.
112 README.md
@@ -0,0 +1,112 @@
The Powder Toy - July 2016
==========================
Get the latest version here: http://powdertoy.co.uk/Download.html
To use online features such as saving, you need to register at: http://powdertoy.co.uk/Register.html
You can visit the official TPT fourm here: http://powdertoy.co.uk/Discussions/Categories/Index.html
Have you ever wanted to blow something up? Or maybe you always dreamt of operating an atomic power plant? Do you have a will to develop your own CPU? The Powder Toy lets you to do all of these, and even more!
The Powder Toy is a free physics sandbox game, which simulates air pressure and velocity, heat, gravity and a countless number of interactions between different substances! The game provides you with various building materials, liquids, gases and electronic components which can be used to construct complex machines, guns, bombs, realistic terrains and almost anything else. You can then mine them and watch cool explosions, add intricate wirings, play with little stickmen or operate your machine. You can browse and play thousands of different saves made by the community or upload your own - we welcome your creations!
There is a Lua API - you can automate your work or even make plugins for the game. The Powder Toy is free and the source code is distributed under the GNU General Public License, so you can modify the game yourself or help with development. TPT is compiled using scons.
Build instructions
===========================================================================
sudo apt-get install build-essential libsdl1.2-dev libbz2-dev zlib1g-dev liblua5.1.0-dev git scons libfftw3-dev
scons
For a list of flags for `scons`, see http://powdertoy.co.uk/Wiki/W/Scons_command_line_flags.html.
Thanks
===========================================================================
* Stanislaw K Skowronek - Designed the original
* Simon Robertshaw
* Skresanov Savely
* cracker64
* Catelite
* Bryan Hoyle
* Nathan Cousins
* jacksonmj
* Felix Wallin
* Lieuwe Mosch
* Anthony Boot
* Matthew "me4502"
* MaksProg
* jacob1
* mniip
Instructions
===========================================================================
Click on the elements with the mouse and draw in the field, like in MS Paint. The rest of the game is learning what happens next.
Controls
===========================================================================
| Key | Action |
| ----------------------- | --------------------------------------------------------------- |
| TAB | Switch between circle/square/triangle brush |
| Space | Pause |
| Q / Esc | Quit |
| Z | Zoom |
| S | Save stamp (+ Ctrl when STK2 is out) |
| L | Load last saved stamp |
| K | Stamp library |
| 1-9 | Set view mode |
| P / F2 | Save screenshot to .png |
| E | Bring up element search |
| F | Pause and go to next frame |
| G | Increase grid size |
| Shift + G | Decrease grid size |
| H | Show/Hide HUD |
| Ctrl + H / F1 | Show intro text |
| D / F3 | Debug mode (+ Ctrl when STK2 is out) |
| I | Invert Pressure and Velocity map |
| W | Toggle gravity modes (+ Ctrl when STK2 is out) |
| Y | Toggle air modes |
| B | Enter decoration editor menu |
| Ctrl + B | Toggle decorations on/off |
| N | Toggle Newtonian Gravity on/off |
| U | Toggle ambient heat on/off |
| Ctrl + I | Install powder toy, for loading saves/stamps by double clicking |
| ~ | Console |
| = | Reset pressure and velocity map |
| Ctrl + = | Reset Electricity |
| [ | Decrease brush size |
| ] | Increase brush size |
| Alt + [ | Decrease brush size by 1 |
| Alt + ] | Increase brush size by 1 |
| Ctrl + C/V/X | Copy/Paste/Cut |
| Ctrl + Z | Undo |
| Ctrl + Cursor drag | Rectangle |
| Shift + Cursor drag | Line |
| Middle click | Sample element |
| Alt + Left click | Sample element |
| Mouse scroll | Change brush size |
| Ctrl + Mouse scroll | Change vertical brush size |
| Shift + Mouse scroll | Change horizontal brush size |
| Shift + R | Horizontal mirror for selected area when pasting stamps |
| Ctrl + Shift + R | Vertical mirror for selected area when pasting stamps |
| R | Rotate selected area counterclockwise when pasting stamps |
Command Line
---------------------------------------------------------------------------
| Command | |
| ------------------------ | -------------------------------------------------------------- |
| scale:1 | Normal window resolution |
| scale:2 | Doubled window resolution |
| kiosk | Fullscreen mode |
| proxy:server[:port] | Proxy server to use [Example: proxy:wwwcache.lancs.ac.uk:8080] |
| open <file> | Opens the file as a stamp or game save |
| ddir <directory> | Directory used for saving stamps and preferences |
| ptsave:<save id>#[name] | [Example: ptsave:2198#Destroyable_city_5_wth_metro~dima-gord] |

0 comments on commit 74d6707

Please sign in to comment.