Housing as Industry - Readme
-----------------------------------

Contents:

1 About
2 Usage and Parameters
3 Building from source
4 Credits
5 License



-------
1 About
-------

This NewGRF adds a variety of apartment complexes buildable as industries, which generate passengers and mail and can be used to boost passenger generation or as eyecandy.

----------------------
2 Usage and Parameters
----------------------

The industry must be placed near towns, but you can use it to boost the numbers at passenger stations. Apartment complexes appear in a variety of styles and layouts, at random. They will not appear automatically on new maps but can be funded at any time.
If the setting "enable multiple similar industries per town" is enabled, many apartment complexes can be built close together, though be warned that will swamp you with too many passengers.

This GRF should be compatible with ECS, FIRS and most other industry sets. If you encounter any bugs or conflicts please report them to the development thread.

----------------------
3 Building from source
----------------------

Makefiles are hard, so this set does not yet have a proper makefile setup. Simply compile housing-ind.nml using the included batch file for now.

The source code is obtainable from the tt-forums development thread: https://www.tt-forums.net/viewtopic.php?f=26&t=56489


---------
4 Credits
---------

Coded by Emperor Jake

Graphics kindly provided by the team from Total Town Replacement Set v3, including graphics by Zimmlock, George, Tycoonez com:munity, Oz, Red*Star, Purno and PikkaBird. Some graphics modified by Emperor Jake.

---------------
5 License
---------------

Housing as Industry (c) 2017 Emperor Jake

This program 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 2 of the License, or
(at your option) any later version.

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