FAF development school

[Softly]

TLDR:
PM Softles tomorrow from 19:00 GMT onwards (I'll be around) if you're interested in learning how to do FAF development.


Long version:
Since I think people might be interested, I will make myself officially available to help people set up a FAF development environment, starting tomorrow at 19:00 GMT. (We'll get ourselves a chatroom to do this in, so PM Softles to join)

I'll go through all the basics to get people set up for development on the client code (That's the main faf lobby, with #aeolus and things) and be around to point out what bits do what. I'll also go through how you can get your changes into the main FAF release.

Everyone is welcome, and if there's interest we can set up more regular meetings.


PS:
I only really know about the client code, but if other people want to come along and cover FA lua/server code then that would be awesome.

Lesson 1:

Spoiler: show

First off we want to set up our dev environment, so we can run the code and make changes.

Theres a few things we'll need:

1) Github Account - https://github.com/
2) Our own fork of the repository - https://github.com/FAForever/client
3) Vagrant - https://www.vagrantup.com/
4) VirtualBox - https://www.virtualbox.org/

I also recommend getting the GitHub client, its a super handy tool for managing your changes to the code with a pretty UI - https://desktop.github.com/

Once you've forked the code online, you can download it locally from the GitHub desktop client. In the top left there is a + symbol, select it and then click clone. From there select the client repository to download it.

Next we open up a git shell (to do this from desktop client, right click the client repository, it should appear on the left, and select open in git shell), and type the command: vagrant up
This runs a virtual machine where we can run the code in the same environment as everyone else. That should mean we don't have any problems

Once the virtual machine is up and running, we just need to do 2 things:

1) Install sip - for some reason this doesn't come as standard in the VM, but we can easily fix that ourselves. From the VM download https://riverbankcomputing.com/software/sip/download and unzip it. Then double click on the configure.py inside it to set it up.
2) Run the code

To run the code, open up a powershell; you should see the icon for this on the taskbar.
Then run these two commands:

cd C:\vagrant

C:\Python27\python.exe src

The code should run and we're away



----



PS if its not working (and it probably won't be for weird reasons):

To fix run the commands:

cd C:\vagrant
C:\Python27\lib\site-packages\pip\__main__.py uninstall enum
C:\Python27\lib\site-packages\pip\__main__.py install requirements.txt

Install: http://www.microsoft.com/en-gb/download ... px?id=5555

Edit the return line (line 100 at last check) of the get_git_version() in src/config/version.py to:
return "0.11.2"
instead of:
return version

Comment out lines 1 and 15 to 20 in file src/fa/init_file.py

Try running again with the command:
C:\Python27\python.exe src

Link to lessons on wiki: http://wiki.faforever.com/index.php?tit ... ent_School

[briang]

This is in the middle of my school day (GMT-5)

[Aulex]

Make sure you check "Automatically archive my broadcasts" in https://secure.twitch.tv/settings/channel so it can be referenced in the future.

[Softly]

Make sure you check "Automatically archive my broadcasts" in https://secure.twitch.tv/settings/channel so it can be referenced in the future.

I wasn't going to stream it, but maybe that's a feature we can add to FAF

[Exotic_Retard]

if you could also write down what you teach there in the wiki i would appreciate that.

[Softly]

if you could also write down what you teach there in the wiki i would appreciate that.

If you're offering to come and make notes you're more than welcome!

[IceDreamer]

I can probably be around to cover the lua element.

[theManfet]

participants of lesson 1 - if you ask them nicely they maybe can help you if have problems in trying to follow lesson 1
ZLO
JaggedAppliance
yorick
NiCAD
and me.

if you want to get to the client folder in gitshell you can also start the gitshell normally and then enter "ls" to see all folders and change to folder client by entering "cd client"

[Softly]

participants of lesson 1 - if you ask them nicely they maybe can help you if have problems in trying to follow lesson 1
ZLO
JaggedAppliance
yorick
and me.

if you want to get to the client folder in gitshell you can also start the gitshell normally and then enter "ls" to see all folders and change to folder client by entering "cd client"

Updated main post to let people know how to get git shell going

[Stups]

Linux version:

Comment out lines 1 and 15 to 20 in file src/fa/init_file.py

Navigate to the faf folder in the terminal and execute the following commands:
sudo pip install -r requirements.txt
apt-get remove python-enum (normally you wouldnt have this package)
apt-get install python-enum34
python src

(if you get an error regarding trueskill)
download trueskill and place it in the src folder
https://pypi.python.org/packages/source ... 4.3.tar.gz

if it doesnt work, pm me the error you get.