This is the open-source version of Free Enterprise 4.x. It contains the full functionality of Free Enterprise 4.x, with some omissions:

• The Z sprite and harp songs databases are not included, though the tools to generate assets in the correct format are.

• The dwarf job list is omitted; should you wish to create your own, this is a simple text file with one job per line.

• Passwords, encryption keys, and similar secrets used in the public deployment of Free Enterprise have been excluded.

Basic setup instructions are included here; for a more detailed guide, visit https://wiki.ff4fe.com/doku.php?id=dev:setup_guide

• Minimum requirements: Python 3.7
• Clone the repo.
• In the root directory, create a virtualenv and activate it.
• pip install -r requirements.txt
• Find the site-packages directory inside your virtualenv directory (should be somewhere under <virtualenv dir>\lib\<etc>\site-packages) and inside it, create a plain text file named fe.pth, containing the path to your repo root.

If you want to use the webserver:

• Install MongoDB server.
• Download the Floating IPS executable for your target platform, and place it inside FreeEnt/server/bin. (This file should be named either flips.exe, flips-linux, or flips-mac accordingly.)

All modes of running Free Enterprise tools require specifying a path to an FF2 US v1.1 headerless ROM (not supplied in this repo).

Always run with the virtualenv active.

From the repo root directory: python -m FreeEnt <rompath> make -h

Note as mentioned above that MongoDB must be installed to use the web generator, and you must have downloaded the Floating IPS binary to FreeEnt/server/bin.

From the repo root directory: python -m FreeEnt <rompath> server --local

Then navigate in a browser to localhost:8080.

From the fetools directory: python tool_site.py <rompath>

Then navigate in a browser to localhost:8082.

Free Enterprise was made possible using the extensive technical research and knowledge of PinkPuff, Grimoire LD, Chillyfeez, and Aexoden. This repo contains code written and designed by b0ardface/HungryTenor, Crow, Myself086, Myria, mxzv, and Wylem. It also contains the graphic design work of SchalaKitty and Steph Sybydlo. It is based on the game design work of riversmccown and mxzv. And while their specific assets are not included in this repo, the musical work of Xenocat and Calmlamity contributes extensively to Free Enterprise, and was formative in the development of tools contained here.

This repo is distributed under the MIT License.