README

About Limbs Off
===============

Limbs Off is a gratis free software computer fighting game.


Dependencies
============

The game is built using GNU AutoTools, libtool, pkg-config and gcc.

The dependencies below are listed with the oldest versions that are confirmed 
to work. Older versions *might* work. If they do, please report it to 
<alexander@plaimi.net>, so that we can update this file.

-fontconfig >= 2.8
-libpng >= 1.2
-libsdl >= 1.2
-opengl >= 7
-sdl-ttf >= 2.0.10


Installing and Running
======================

NOTE: This repository is for developers. If you are a regular user, you should 
refer to <https://plaimi.net/games/limbs-off/>.

General instructions
--------------------

Limbs Off uses the GNU build system. It can be successfully installed on most 
systems with:

$ autoreconf -i && ./configure && make && sudo make install

See INSTALL for more detailed instructions. Run the game with:

$ limbs-off

Gentoo
------

If you are on a Gentoo system you can install the game via the Sunrise 
overlay, or by downloading our ebuild, and using a local overlay.

To use Sunrise (recommended), refer to 
<http://www.gentoo.org/proj/en/overlays/userguide.xml> to add the overlay.

Next are the instructions for using our ebuild in a local overlay (not 
recommended). (Skip this section if you are using Sunrise.) Skip steps where 
appropriate.

# mkdir -p /usr/local/portage/games-misc/limbs-off
# cd /usr/local/portage/games-misc/limbs-off
# wget https://secure.plaimi.net/games/limbs-off/limbs-off-9999.ebuild
# ebuild limbs-off-9999.ebuild digest
# echo 'PORTDIR_OVERLAY=/usr/local/portage $PORTDIR_OVERLAY' >> /etc/make.conf

Limbs Off will likely be masked on your Gentoo system (if not, skip this 
section). This is because live ebuilds are considered dangerous. You need to 
unmask it. Refer to 
<http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=3&chap=3>. When 
you have done this, you can install Limbs Off.

# emerge limbs-off


You may then run the game via your desktop environment's menu, in the games 
section - or via a terminal emulator.

# limbs-off


Licensing and Legalese
=======================

Limbs Off 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.

Limbs Off 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 Limbs Off.  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>.  If you 
want to discuss the game, give us suggestions, etc. -- use 
<https://secure.plaimi.net/mailing.php>.  If you want to contribute code, see 
HACKING for coding style guidelines, submission information and more. See TODO 
for information on what needs to be done.

/* vim: set textwidth=78 formatoptions=actw2 autoindent: */