Free Enterprise Wiki

User Tools

Site Tools

Trace:
dev:setup_guide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
dev:setup_guide [2024/06/25 18:17] – [Running the Generator from the Command Line] wylemdev:setup_guide [2024/08/22 07:01] (current) – [Initial Requirements] Microsoft ruins everything wylem
Line 1: Line 1:
 ====== Setting up the FF4FE generator ====== ====== Setting up the FF4FE generator ======
 ===== Initial Requirements ===== ===== Initial Requirements =====
 +  - Install Python, if it's not already installed
 +    * Versions 3.7 through 3.11 are supported, but 3.11 is recommended for performance reasons((Python 3.12 will likely remain incompatible until FE 5.0 or later))
   - Clone the FF4FE repo - [[https://github.com/HungryTenor/FreeEnterprise4]]   - Clone the FF4FE repo - [[https://github.com/HungryTenor/FreeEnterprise4]]
   - Set up site URLs and secrets in the ''.env'' file   - Set up site URLs and secrets in the ''.env'' file
     * ''EMBEDDED_REPORT_KEY'' must be 16, 24, or 32 bytes     * ''EMBEDDED_REPORT_KEY'' must be 16, 24, or 32 bytes
-  - Set up a Python ENV (from project root dir): ''python -m venv ENV'' +  - Set up a Python ENV (from project root dir) using your desired Python version: ''<path-to-python3.xx>\python -m venv ENV'' 
-    * Make sure to use the desired Python version for this+    * It's highly recommended that you use the full path to the Python executable to ensure you're running the intended version.
   - Create the file ''fe.pth'' at the specified location:   - Create the file ''fe.pth'' at the specified location:
     * Windows: ''ENV\Lib\site-packages\fe.pth''     * Windows: ''ENV\Lib\site-packages\fe.pth''
Line 23: Line 25:
     * Linux: ''source ENV/bin/activate''     * Linux: ''source ENV/bin/activate''
   - Run ''python -m FreeEnt /path/to/rom make <arguments>''   - Run ''python -m FreeEnt /path/to/rom make <arguments>''
-    * Pass ''-h'' or ''--help'' as an argument for a list of command line generation flags +    * Pass ''-h'' or ''%%--%%help'' as an argument for a list of command line generation flags 
       * See [[dev:usage|Using the Generator]] for a breakdown       * See [[dev:usage|Using the Generator]] for a breakdown
 ===== Web Server Requirements ===== ===== Web Server Requirements =====
Line 30: Line 32:
     * Linux: https://www.mongodb.com/docs/manual/administration/install-on-linux/     * Linux: https://www.mongodb.com/docs/manual/administration/install-on-linux/
       * You may also need to run ''ulimit -n 64000'' to raise the limit on number of open files       * You may also need to run ''ulimit -n 64000'' to raise the limit on number of open files
-  - Download Floating IPS and extract the appropriate executable to ''FreeEnt/server/bin/'' (the directory will need to be created) +  - Download [[https://github.com/Alcaro/Flips/releases|Floating IPS]] and extract the appropriate executable to ''FreeEnt/server/bin/'' (the directory will need to be created) 
-    * Windows and Mac: [[https://www.romhacking.net/utilities/1040/]] +    * For Linux, set the executable bit (''chmod +x'') on the flips-linux executable 
-    * Linux: The code can be found at [[https://github.com/Alcaro/Flips]] +    * For a headless Linux setup, you may need to compile the [[https://github.com/Alcaro/Flips/|source]] yourself
-      * Set the executable bit (''chmod +x'') on the flips-linux executable+
  
 ===== Running the Web Server ===== ===== Running the Web Server =====
   - Activate the Python virtual environment (only needs to be done if it's not currently active)   - Activate the Python virtual environment (only needs to be done if it's not currently active)
-    * Windows: ''ENV\Scripts\activate.bat''+    * Windows: 
 +      * Command prompt: ''ENV\Scripts\activate.bat'' 
 +      * PowerShell: ''ENV\Scripts\activate.ps1'' 
 +      * Git Bash: ''ENV\Scripts\activate''
     * Linux: ''source ENV/bin/activate''     * Linux: ''source ENV/bin/activate''
   - Run ''python -m FreeEnt /path/to/rom server <arguments>''   - Run ''python -m FreeEnt /path/to/rom server <arguments>''
-     * Pass ''-h'' or ''--help'' as an argument for a list of server flags+     * Pass ''-h'' or ''%%--%%help'' as an argument for a list of server flags
        * See [[dev:usage#web_server|Using the Generator]] for a breakdown        * See [[dev:usage#web_server|Using the Generator]] for a breakdown
      * The server can be run without any additional arguments, in which case it will be available at http://localhost:8080/      * The server can be run without any additional arguments, in which case it will be available at http://localhost:8080/
  
dev/setup_guide.1719339458.txt.gz · Last modified: 2024/06/25 18:17 by wylem

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki