Feather Framework
English

Appearance

GETTING STARTED ​

Feather Framework TX Recipe alpha ​

Dependencies ​

  • Windows or Linux (Ubuntu/Debian recommended)
  • Highly Recommended - Git 1.9k for correct installation
  • Windows only - Visual C++ Redistributable 2019 808 or newer
  • Cfx.re Account
  • Must have "Latest Recommended" txAdmin build artifact
  • MariaDB version 10.7+
    • DO NOT use XAMPP, this has known vulnerabilities when hosted on windows and is shipped with a very old version of mariadb/mysql

Installation Tutorial ​

Windows ​

  1. Create a new base folder (e.g. C:\MyRedMServer)
  2. Navigate to http://runtime.fivem.net/artifacts/fivem/build_server_windows/master and download the Latest Recommended artifact.
  3. Open the downloaded server.zip file and extract the contents to a new folder called cfx within your server folder created in step 1 (e.g. C:\MyRedMServer\cfx)
  4. Double Click or execute FXServer.exe to initiate setup
  5. This site should open in your browser. Make sure a PIN is filled, and click Link Account.enter image description here
  6. Log in to your account on Cfx.re in this tab and then click Yes, Allow.
  7. Set a password to log in to your server's admin page. enter image description here
  8. Click 'Next'. enter image description here
  9. Type a name for your server and click 'Next'
  10. Select to use a 'Remote URL Template'. enter image description here
  11. Copy and paste the below url into the url field. https://raw.githubusercontent.com/FeatherFramework/feather-recipe/main/recipe.yaml
  12. Click Next
  13. Keep the default path and click Next
  14. Click Go to Recipe Deployer
  15. Click 'Next' once you're sure the recipe looks fine. It should be fine the way it comes.
  16. Enter the key you just made on the Keymaster in the 'Before you begin' enter image description here
  17. Click the "Show/Hide Database options (advanced)"
  18. Change Database Name to feather
  19. Click 'Run Recipe'
  20. Woohoo! Recipe installed correctly, you can click 'Next' again. enter image description here
  21. Click "Save & Run Server", and you're done!

Linux ​

Assuming you are SSHed into your machine or have otherwise access.

  1. Create a new base folder (e.g. C:\MyRedMServer)

  2. Navigate in your browser to http://runtime.fivem.net/artifacts/fivem/build_proot_linux/master/
    a. Right click on the latest artifact b. Click “Copy link location” or similar prompts

  3. Create a new cfx folder and then navigate to the MyRedMServer folder
    a. cd ~/MyRedMServer

    b. mkdir cfx

    c. cd cfx

  4. Download the artifact using the link we copied in step 2.
    a. wget <link_url>

  5. Extract the files using tar
    a. tar xf fx.tar.xz

  6. Run the startup script a. ./run.sh

  7. This site should open in your browser. Make sure a PIN is filled, and click Link Account.enter image description here

  8. Log in to your account on Cfx.re in this tab and then click Yes, Allow.

  9. Set a password to log in to your server's admin page. enter image description here

  10. Click 'Next'. enter image description here

  11. Type a name for your server and click 'Next'

  12. Select to use a 'Remote URL Template'. enter image description here

  13. Copy and paste the below url into the url field. (select lua if you want our lua core code, or c# if you prefer core code) (LUA) https://raw.githubusercontent.com/FeatherFramework/feather-recipe/main/recipe.yaml

  14. Click Next

  15. Keep the default path and click Next

  16. Click Go to Recipe Deployer

  17. Click 'Next' once you're sure the recipe looks fine. It should be fine the way it comes.

  18. Enter the key you just made on the Keymaster in the 'Before you begin' enter image description here

  19. Click the "Show/Hide Database options (advanced)"

  20. Change Database Name to feather

  21. Click 'Run Recipe'

  22. Woohoo! Recipe installed correctly, you can click 'Next' again. enter image description here

  23. Click "Save & Run Server", and you're done!

Credits and references ​