-
Notifications
You must be signed in to change notification settings - Fork 2
Breakout meets PONG
License
plaimi/bweakfwu
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
About bweakfwu =============== bweakfwu is a crossover between Pong and Breakout with retro (shit) graphics. It features local two-player. The controls are up/down arrow for moving the right paddle, and left arrow for launching its ball. For the right paddle, use 'u'/'j' for moving the paddle, and 'k' for launching the ball. Space pauses the game. We do not have control remapping support yet, but you can change it in src/bweakfwu/Handle.hs. For a more detailed explanation of features see the design document in doc/design.txt. For an explanation of how these features are implemented see the Haddock-generated documentation. Dependencies ============ The only library that is required is gloss >= 1.8.0. The game is built using ghc. Cabal is optional, but it makes building and installing a lot easier. Installing and Running ====================== NOTE: This repository is for developers. If you are a regular user, you should refer to <https://secure.plaimi.net/games/bweakfwu/>. Build instructions for developers --------------------------------- # Configure cabal, making sure you have the dependencies, etc $ cabal configure # Build the game, puts a binary in ./dist/build/bweakfwu/ $ cabal build # Make the documentation, puts html in ./dist/doc/htm/bweakfwu/bweakfwu/ # You can view the documentation for the latest git commit online as well, at: # <https://secure.plaimi.net/games/bweakfwu/doc/frames.html> $ cabal haddock --executables --hyperlink-source To install the game use $ cabal install This will add the binary "bweakfwu" to your cabal binaries. Licensing and Legalese ======================= bweakfwu is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. bweakfwu is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with bweakfwu. If not, see <http://www.gnu.org/licenses/>. Contributing To the Project =========================== If you want to report a bug, use <https://secure.plaimi.net/bugs>. Bug reports may also be enhancements, i.e. feature requests. If you want to otherwise discuss the game use <https://secure.plaimi.net/mailing.php>. If you want to contribute code, upload a patch to the corresponding bug on Bugzilla -- or, if there is none, send it to the mailing list linked above. Make sure you update doc/design.txt in your patch! /* vim: set textwidth=78 et spell formatoptions=actw2 autoindent: */