aBase Readme - 32bpp Graphics Base Set for OpenTTD

==============================
Current Version: aBase 2016-05-12 (5976:3a0c62540e12M)
==============================

Contents
1 About aBase
2 Downloading aBase
3 Installing aBase
3.1 Installation or update via Online Content service
3.2 Manual installation
4 Reporting bugs and Contributing
5 Building of aBase
    5.1 Notes for package maintainers
    5.2 Note on the xcf and psd files
6 License
    6.1 Obtaining the source
7 Credits


1 About aBase
===============

The aBase is a fork of zBase - an open source graphics base set designed to be 
used by OpenTTD.

aBase as a descendant of zBase set provides free and open source base graphics, 
for OpenTTD.


2 Downloading aBase
=====================

aBase is available from a few locations. This readme will only cover the
official download locations.

We cannot support third party download locations and we cannot refund your money
if you have paid money for aBase.

- If you're new to OpenTTD and you do not want to have OpenGFX or the original
  TTD files installed, you'll have to follow the manual installation procedure.
  This is really not as difficult as it may sound, so don't worry too much about
  it.
- If you already have OpenTTD up and running using the original TTD base
  graphics, installing aBase using the Online Content Service is the easy way to
  obtain aBase.

If you want to check the integrity of your grf or check whether your
self-compiled grf is the same as it should be, have a look at 


3 Installing aBase
=============================

3.1 Installation or update via Online Content service
-----------------------------------------------------

This method uses the Online content service (BaNaNaS) to download aBase. In
order to use this aBase version, you need a working OpenTTD and again at least
OpenTTD version 1.2.0 or a recent nightly.

1. Start OpenTTD and on the main menu click the Check Online Content button. A
   new window will pop up. If OpenTTD doesn't start, follow the manual installation
   procedure.
2. Find the aBase entry from the list at the left. You can use the search box
   in the upper right corner of the window.
3. Click the little square in front of the aBase entry in order to mark it for
   download.
4. Click the Download button in the bottom right corner. After download, close
   the open windows.
5. In the main menu of the game, click the Game Options button. The Game
   Options dialog will appear.
6. Select aBase from the drop-down list below Base graphics set if that's
   not selected already (bottom left of window). Close the window using the × in
   the upper left corner.


3.2 Manual installation
-----------------------

1. First, make sure that you downloaded and installed at least OpenTTD version
1.2.0 or later.

2. Next, download the latest aBase package, which is available at the 
following address: [BitBucket REPO ADDRESS GOES HERE]

3. Unpack the zip file into the OpenTTD's baseset directory (see section 4.2 of the
OpenTTD readme for a detailed treatise on all data dirs OpenTTD recognizes).
There's no need to unpack the tar, so just leave it as it is.
- An OpenTTD folder in your user account's home directory:
    Windows: C:\My Documents\OpenTTD\baseset (95, 98, ME)
             C:\Documents and Settings\<username>\My Documents\OpenTTD\baseset (2000, XP)
             C:\Users\<username>\Documents\OpenTTD\baseset (Vista, 7)
    Mac OSX: ~/Documents/OpenTTD/baseset
    Linux:   ~/.openttd/baseset
- The baseset dir in OpenTTD installation directory.

4. Run OpenTTD. 

5. In the main menu of the game, click the Game Options button. The Game
Options dialog will appear.

6. Select aBase from the drop-down list below Base graphics set if that's
not selected already (bottom left of window). Close the window using the × in
the upper left corner.
- If you did not install the original TTD base graphics during the installation
  of OpenTTD, you can skip this step.
- If you installed the original TTD base graphics as well, this is where you can
  switch base graphic sets.

If you're having trouble getting aBase to work, please file a detailed 
report on what you did, what error messages you got and where you got stuck in 
the aBase release topic at TT-Forums: 
    http://www.tt-forums.net/viewtopic.php?f=36&t=40162 


4 Reporting bugs and contributing
=================================

If you spot any graphical bugs or glitches in the available graphics, please let
me know via the provided addressess.
Please make sure that you're using the latest available version before reporting
a bug. You can check the issue tracker to see if the bug you've found is already
reported (or even fixed).

If you have made yourself improvements to either graphics or the source code
itself, and wish for it to be included in the aBase set you may contact me
the same way - I will consider your work for inclusion.


5 Building aBase
=========================================

The aBase source is available in a Mercurial repository or as gzip'ed tarball.
You can do an anonymous checkout from https://bitbucket.org/luke1985m/abase-main .
e.g. using the following command in your bash shell:
    hg clone https://bitbucket.org/luke1985m/abase-main


Prerequisites to building aBase are the same as for aBase, that is:
- gcc (the pre-processor is needed)
- NML 0.3 (default / development branch)
  (available from http://bundles.openttdcoop.org/nml/ )
- grfid from the grfcodec package
  (available from http://www.openttd.org/download-grfcodec )
- some gnu utils: make, cat, sed, awk
  and you might additionally want a text editor of your choice and a graphics
  programme suitable to handle palettes.
- Mercurial (only when not building from a tarball, available from
  http://mercurial.selenic.com/wiki/Download?action=show&redirect=BinaryPackages)

Optionally, required to re-generated all graphics files from their layered source
  files after executing 'maintainer-clean':
- GIMP 2.4 or later

The installation steps of these packageswon't be covered here, since you, as a 
developer should be already familiar with your envirnment.

Once all tools are installed, get a checkout of the repository and you can build
aBase using make. The following targets are available:
- all: builds all grfs and the obg file
- install: build and then copy aBase in your OpenTTD data directory. Use
  Makefile.local to specify a different path.
- clean: cleans all generated files
- mrproper: also cleans generated directories
- maintainer-clean: clean also the graphics files can be re-generated via GIMP
- bundle_src: create a source tarball
- bundle_zip: create a zip archive of aBase
- bundle_bz2: create a bzip2 archive of aBase
- bundle_tar: create a tar archive of aBase
- check: checks the md5 sums of the built grf and obg files against those of
  the official release versions

Given the usual case that you modify something within aBase and want to test
that, a simple 'make install' should suffice and you can immediately test the
changes ingame. Given default paths, a 'make install' will overwrite a 
previous nightly version of aBase. Mind to re-start OpenTTD as it needs to 
re-read the grf files.

5.1 Notes for package maintainers:
---------------------------------
- Checking for build success: The source releases contain an additional file
  aBase-<version>.md5 which indicates the md5 sums of the generated files as
  released in the binary release. You can check your build by running
  'make check'. Mind that you'll overwrite the file with the original md5 sums,
  if you call 'make bundle_src' or 'make md5'.
- The source release also contains a Makefile.local and a slightly appended
  Makefile.def, both supplying additional variable definitions which otherwise
  would be determined by accessing repository properties.
- The variable which supplies the install path changed for the sake of
  consistency and better readability to INSTALL_DIR. The old INSTALLDIR still
  works but is deprecated.


5.2 Note on the xcf and psd files
---------------------------------
The repository contains a few xcf2png files which indicate which png files can
be generated from the source xcf or psd files. This will only be used, if GIMP
is found. Calling 'maintainer-clean' will delete the png files which can be
re-generated from a xcf or psd file.


6 License
=========

The copyright holders of the original version(zBase) are the 
zBase team (see the credits section). The copyright holder of elements newly
introduced in this version is:
          lukasz1985 (Łukasz Michalczyk). 
          
This version is licensed under the same license as the original - the 
      GNU General Public License version 2 
  as published by the Free Software Foundation.

This program 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
this program; if not, write to the Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.


7 Credits
=========

The person credited for changes and reworking of graphics in this set
is lukasz1985 (Łukasz Michalczyk).

the credits of the original set upon which this work is based on goes to the 
developers of zBase, that is:

zBase's 32 bits graphics are created by:
* Zephyris (Richard Wheeler)

zBase's 8 bits graphics are from OpenGFX and created
by the following people (in reverse alphabetical order):
* Zuu (Leif Linse)
* Zephyris (Richard Wheeler)
* Varivar
* V453000 (Vaclav Benc)
* uzurpator
* Spaz O Mataz
* Soeb (Stanislaw Gackowski)
* Snail (Jacopo Coletto)
* skidd13 (Benedikt Brüggemeier)
* Rubidium (Remko Bijker)
* Roujin (Manuel Wolf)
* Red*Star (David Krebs)
* Raumkraut (Mel Collins)
* Purno (Mark Leppen)
* planetmaker (Ingo von Borstel)
* PikkaBird (David Dallaston)
* PaulC (Paul Charlesworth)
* orudge (Owen Rudge)
* oberhuemer
* northstar2
* Mr. X
* mph (Matthew Haines)
* molace (Zoltán Molnár)
* michi_cc (Michael Lutz)
* mb (Michael Blunck)
* mart3p
* Lawton27 (Jack Lawton)
* LordAzamath (Johannes Madis Aasmäe)
* lead@inbox (Serge Saphronov)
* Jonha
* Irwe (Alexander Irwe)
* Gen.Sniper
* frosch (Christoph Elsenhans)
* Froix
* FooBar (Jasper Vries)
* erikjanp
* EdorFaus (Frode Austvik)
* drginaldee
* DJ Nekkid (Thomas Mjelva)
* DanMacK (Dan MacKellar)
* buttercup
* bubersson (Petr Mikota)
* Born Acorn (Chris Jones)
* Bilbo
* BenK
* Ben_Robbins_ (Ben Robbins)
* athanasios (Athanasios Arthur Palaiologos)
* andythenorth (Andrew Parkhouse)
* AndersI (Anders Isaksson)
* Ammler (Marcel Gmür)
* 2006TTD (Anthony Lam)

* The monospaced characters are generated from the font Liberation Mono:
    https://www.redhat.com/promo/fonts/ created by Pravin Satpute and
    Caius Chance, released under GPL v2.


Contact: lukasz_michalczyk_1985@wp.pl


