Nomads

This project is about bringing Nomads back as playable faction via featured mod and make a serious attempt to integrate them into the main game.

We can use all the help we can get :

• coding
• modelling
• texturing
• effects improving
• testing
• mission making
• ...

How do I start contributing?

If you want to contribute, then you'll need to know how git works. Here is a nice short tutorial to get you started. More information for when you want to use the desktop app: Github desktop guides

You should get local copies of both FAForever/fa and Nomads-Project/nomads.

Use your lua code in a game

You should have a local copy of the code - both FAForever/fa and Nomads-Project/nomads - on your computer. Now you'll want to set up your test environment, i.e. running the game based on your local copies.

Inside of the nomads repository is an init_devnomads.lua file that you need to copy inside C:\ProgramData\FAForever\bin\ If you didn't use the default location for your GitHub folders, then you'll have to edit the file and change some file paths. The lines are at the start of the file, so you can't miss them. ( Make sure you don't edit the original file, to avoid problems later )

Inside the same folder, C:\ProgramData\FAForever\bin\, you'll find ForgedAlliance.exe Make a shortcut for it either by right clicking on the file and putting it in an easily accessable place or right clicking in the folder you want the shortcut to be in and making a new shortcut there. (For example your desktop) Go into its properties (right click) and change the target:

C:\ProgramData\FAForever\bin\ForgedAlliance.exe /init init_devnomads.lua /EnableDiskWatch /showlog /log C:\ProgramData\FAForever\logs\dev.log

By adding /showlog then the log window will automaticaly appear. There is an ingame keybind to summon the log window aswell. So it depends on your own prefence if you want it from the start or not. /EnableDiskWatch will ask FA to reload your changes whenever the file is changed - skipping the need to reload your game. /log C:\ProgramData\FAForever\logs\dev.log will save the log in the specified location. Usefull for sharing logs incase of issues.

You're finally ready to make changes to the lua code and test them!

Working with issues and pull requests

The main way of communication on github is done with issues and pull requests.

• Whenever you find a problem or have an interesting idea, then you can make an issue for that. If there already is an issue for it, then you should comment on the original one, instead of making a new issue.
• Whenever you have something of value (bugfixes/improvements/etc) to add, you can make a pull request. Other contributors can review your changes and help improve them and/or confirm their validity. Afterwards your pull request will get merged into the master branch and will be a part of the future releases. So it is not only for sending your own changes, but also for reviewing others' pull requests. Reviewing can be quite laborous, so we'd like as many people as possible doing these so changes will be of a better quality and merged a lot faster.

Making an issue

To make an issue about a bug/possible improvement/new feature/etc, you should go to the original repositories webpage and create an issue there. Don't make issues in your own forked repository unless you don't want anyone to know about them.

When making an issue, you should follow these guidlines:

• Make a seperate issue for each bug/feature. So we avoid cluttered issues and everything is clear.
• Always add as much information as you can provide about the issue
  • Give a nice description of the issue (where/when/what/how)
  • Add the dev logs You can find them here: C:\ProgramData\FAForever\logs
  • Provide the replay too. Watch it first (after you copied the logs) to see if the same thing happens as during the game.

Making a pull request

To make a pull request with your changes for a bugfix/possible improvement/new feature/etc, you should go to the original repositories webpage and create a pull request there. Most of the time pull request will be related to an issue and merging it will solve the issue. You can close an issue manually but its a lot easier if it would automaticaly close when the pull request is merged. You can achieve this by adding a keyword and a reference to the issue inside the body of your pull request message.

When making a pull request, you should follow these guidelines:

• Give a nice description of the changes (where/when/what/how)
• Reference all issues related to this pull request

If something doesn't work: https://xkcd.com/1597/

Map Editor

To run the Map Editor with nomads units you need to do the following steps:

1. Paste nomads_mesh.fx file into effects folder and rename it to mesh.fx
2. Pack effects, env, textures, units folders from this repository into Z_nomad.scd using Winrar or similar (needs to be set as .zip NOT .rar)
3. remove the mesh.fx file from the effects folder of the repository again
4. Paste Z_nomad.scd into Supcom gamedata folder THQ\Gas Powered Games\Supreme Commander\gamedata
5. Go to %USERNAME%\AppData\Local\Gas Powered Games\SupremeCommander\cache and delete the content of the folder

Some common issues and how to solve them

1. Unknown technique NomadsUnit

If you encounter an error like this:

WARNING: attempt to retrieve annotation from unknown technique NomadsUnit
WARNING: c:\work\rts\main\code\src\libs\gpggal\EffectD3D9.cpp(89) invalid effect technique requested: NomadsUnit

Try to run the shader_cleaner.bat file to fix it. You can find this file inside your local copy of Nomads-Project/nomads.

2. HostGame: expected 1 args, but got 2

If you encounter an error like this:

WARNING: Error running OnFrame script in CScriptObject at 10043640: void CLobby.HostGame(self)
        expected 1 args, but got 2
         stack traceback:
             [C]: in function `HostGame'
             "\documents\github\fa\lua\ui\lobby\lobby.lua(6310): in function `HostGame'

Make sure you are using a copy of init_devnomads.lua from this repository and not the outdated init_nomads.lua

Implementing Nomads in FAF (update the current version)

1. extract the nomads loading video from movies/ and put it in the FAForever/movies/ folder

2. replace the init_nomads.lua file in the FAForever/bin/ folder with the version from this repository

3. zip the rest of the repository (except the movie/ folder) and rename the zip to nomads.nmd

4. place the nomads.nmd file in the FAForever/gamedata/ folder