Network & Channel Setup
-------------------------------------------------------------------------------

Admin Network
-------------

You should setup your admin network on a network that has "fakelag" dissabled, or the ability to OPER the bot.
As you can imagine there is alot of data to be pasted to channels and you don't want to be kicked
for flooding every time you type !help.

Add an IRC network with direct connection
-----------------------------------------

If you want the bot to connect to your znc bouncer, look at section 1.2.

Begin by editing the slftp.ini file and enter the nickname you wish to have.

Then it's time to add a connection to a IRC network.

	# !ircnetadd <NETWORKNAME> <url.to.irc> <port> <sslmode on/off>

Example:

	# !ircnetadd LINKNET eu.link-net.org:7000 1

*** sslmode is 0 or 1

Now you have the bot on linknet. And you can add further irc networks for other sites.

Check if the bot is connected

	# !ircstatus

Add an IRC network with ZNC
---------------------------

Making your bot to connect to your znc bouncer is simple. using ZNC is useful when you only want one user visible
on channel, both the one you chat from and your bot. It is also useful if you want to have different nicknames
on different irc networks, as the current version of slftp only allows one irc nickname for all the servers.

	# !ircnetadd <NETWORKNAME> <url.to.irc> <port> <sslmode on/off> <user:password>

Example:

	# !ircnetadd SexyBnc irc.znc.bouncer.com:1337 1 myznc:easilycracked

Check if the bot is connected

	# !ircstatus

IRC channels and blowfish
-------------------------

Adding IRC channels
-------------------

After you have created your irc networks you need to add irc channels for the bot to join.

	# !ircchanadd <NETWORKNAME> <channel>

Example:

	# !ircchanadd LINKNET #channel

IRC channel passwords

If the irc channel requires a password:

	# !ircchankey <NETWORKNAME> <channel> <key>

Example:

	# !ircchankey LINKNET #channel mysecretkey

IRC channel fish keys
---------------------
If your channel requires a fish key
NOTE: If you are using fish in your znc you can skip this step.
      UNLESS you are setting up your admin channel blowfish is mandatory in slftp.

	# !ircchanblow <NETWORKNAME> <channel> <blowfishkey>

Example:

	# !ircchanblow LINKNET #channel %%$#&$%&342546456345#$%45654DFSASGF

Adding sites
------------

Now it's time to add sites

	# !addsite <SITENAME> <user> <password> <ip>:<port>

Example:

	# !addsite TRANNYHEAVEN buck angel 127.0.0.1:6969

In case your site has more than one bnc's you can add more bnc's with the !addbnc command

	# !addbnc TRANNTHEAVEN 192.168.1.1:6969

Adding sections
---------------

slFtp has default section names for releases which you can see under the [sections] in the slftp.precatcher file,
you can edit it as you like. It's highly recommended to become familiar with the file as it will make your life
so much easier when using slFtp.

For a small example as a short introduction to the sections take a look at the following:

Under my [slftp.precatcher] I have:

ISOAPPS=ISOAPPS,APPS,ISO APPS,APPS ISO
ISOGAMES=ISOGAMES,ISO GAMES,GAMES ISO,GAMES

This means that whenever something is uploaded to the sections that have ISO in their name, will be put into the section ISOGAMES

So if you want to race games to a site you need to add the section ISOGAMES to that particular site.

We add the section with the following command:

	# !sections <sitename> <section>

Example:

	# !sections TRANNYHEAVEN ISOGAMES

To remove sections, just run the same !section command again with the name of the section you wish to remove

	# !sections TRANNYHEAVEN ISOGAMES

To see all the sections you have added you can use the !sections command

	# !sections TRANNYHEAVEN

Mapping sections
----------------

After you have set up your sections as you like them you might want to look at [mapping] under the slftp.precatcher file.
It is going to help you sort out what goes where. Here we have a small example.

	ISOGAMES;CLONEGAMES;*clone*,*clonedvd*,*clones*
	ISOGAMES;MACGAMES;*MAC*,*MACOSX*,*OSX*,*MACOS*,*APPLE*

This means that everything that comes into ISOGAMES with the name MACOS or MAC will be mapped to a section that's called MACGAMES.

So if any of my sites allows MACGAMES, then I'll just have to add the MACGAMES section to it.

	# !section TRANNYHEAVEN MACGAMES

You could put everything under ISOGAMES but as some sites don't allow clone then it's necessary to map clone to another section.

Here are some further examples for mapping, if you understand the mapping you can probably figure out what is being done here.

	0DAY;PDA;*.SymbianOS*,*-*PDA,*.WM2003.*,*.XScale.*,*.J2Me*,*.PalmOS.*
	0DAY;EBOOK;*.EBOOK-*,*.EBOOK.*,ActualTests.*,*.Exam.Q.*
	X264;HD720;*.720p.*,*.720p-*
	X264;HD1080;*.1080p.*,*.1080p-*
	ISOAPPS;ISOTRAINING;*Lynda.com.*,*VTC.*,*Total.Training*,*TRAINSIGNAL.*,*Train.Signal*
	MDVDR;MHD;*.1080p.*,*.1080p-*,*.720p.*,*.720p-*,*.x264.*,*.x264-*

NOTE: For a more detailed explination of the precatcher please see the Precatcher file.

Set directories
---------------

Once you have set your sections you need to set your directories so that slftp knows where to put the files
that are going into that particular section.

This is done with the !setdir command

	# !setdir <sitename> <section> <directory>

NOTE: The <section> is the default section in the precatcher file, not the sitebot sections.

Examples:

	# !setdir TRANNYHEAVEN MACGAMES /MACGAMES
	# !setdir TRANNYHEAVEN MP3 /MP3-TODAY

Once you have set all your directories you can use the !site command to get a overview of all the sections/directories you have set, useful to see if you are forgetting something.

	# !site TRANNYHEAVEN


Add precatcher
--------------

Next we need to add a precatcher to catch the announce from the sitebot.
There are a few ways to do this, so I suggest you read the precatcher file so you know what your doing,
and can make a decision on what suits you best.

	# !catchadd <SITE> <NETWORKNAME> <channel> <botname> <NEWDIR> <message>

Example:

	# !catchadd TRANNYHEAVEN LINKNET #trannychan trannybot NEWDIR cum,in,my,ass

To see if your precatcher works and actually catches announces you can use the [!catchtest] command.

Example:

	# !catchtest LINKNET #trannychan trannybot ( xxx|cum ) . Tranny.Grannys.20.XXX.DVDRip.XviD-SiCKFUCK . fag/iND
	# |Process LINKNET #trannychan trannybot ( xxx|cum ) . Tranny.Grannys.20.XXX.DVDRip.XviD-SiCKFUCK . fag/iND
	# |ProcessReleaseTranny.Grannys.20.XXX.DVDRip.XviD-SiCKFUCK iND NEWDIR
	# |Cleanedup line wo rlsname: xxx cum fag iND
	# |Section: XXX
	# |Event: NEWDIR
	# |Ok.


Adding rules
------------

Now it's time to set up some rules to filter out what you want to trade, and what you want to skip.
You add the rules for the site you want to trade to (the destination).

Available rules
---------------

It's best to get familiar with the available rules so you can decide what you need to do. To see available rules:

	# !rulelist

To see how a particular rule functions:

	# !rulehelp rulename

Rule operators
--------------

Another thing you need to get familiar with are the rule operators, some basic knowledge that * is a wildcard is also good.
Knowing regex might also come in handy.

Operators:

	= simple equality test
	=~ mask match with wildchar support. Eg.: releasename =~ *-BERC in list operator, matches any items in the lsit. Eg.: mp3source in TAPE, VINYL
	< <= >= > comparator for mp3year
	@ equality match but it expects SITENAME as parameter

You can use the special section * for section-generic rules, also * for site-generic rules.

Creating rules
--------------

Now that you've gotten yourself familiar with the available rules, operators and hopefully familiarised yourself
with the requirements of the site ("site rules" in most cases) you need to create a list of rules.
The order of the rules is important, the first matching (ALLOW) rule will apply.
The exception to this rule is global rules. They will ALWAYS be put first regardless of the rule number.

If our site allows everything in a section we just need one rule.

	# !ruleadd TRANNYHEAVEN XXX if default then ALLOW

Note that every other rule we'd add after that rule would get ignored, since we just allowed everything.

It's best to rule out what's forbidden (DROP) and then allow the rest. Always try and do drop rules as much as possible rather than ALLOW.
Let's say our site only allows scripted tv shows from the UK and the USA.

	# !ruleadd TRANNYHEAVEN TV720 ifnot tvcountry =~ *USA*  || tvcountry =~ *UNITED STATES* || tvcountry =~ *UK* || tvcountry =~ *United Kingdom* then DROP
	# !ruleadd TRANNYHEAVEN TV720 ifnot tvscripted then DROP
	# !ruleadd TRANNYHEAVEN TV720 if default then allow

Another example where our site only allows non/foreign raggae mp3's ripped from cd, vinyl, web that's newer than 2009

	# !ruleadd TRANNYHEAVEN MP3 if mp3genre =~ *reggae* || mp3genre =~ *Dance Hall* || mp3genre =~ *dancehall* then DROP
	# !ruleadd TRANNYHEAVEN MP3 if not mp3language in en then DROP
	# !ruleadd TRANNYHEAVEN MP3 if not ( mp3source in CD, CDR, Vinyl, WEB ) then DROP
	# !ruleadd TRANNYHEAVEN MP3 if mp3year < 2009 then DROP
	# !ruleadd TRANNYHEAVEN MP3 if default then ALLOW

NOTE: In order for tvmaze, mp3/flac, imdb etc lookups. You MUST set these slftp default sections in your slftp.ini file under [kb].
	TMP3Release=MP3,FLAC
	TTVRelease=TV,TV-DVDRIP,TV-BLURAY,TV-DVDR,TV-HR,TV-WMV,TV-X264,TV-SDX264,TV-XVID,TV-SPORT
	TIMDBRelease=XVID,X264,DVDR,BLURAY

Testing your rules
------------------

You can test your rules by looking up existing releases on a site and see if they are matched or not,
or you can just wait for the next release to be catched.
I strongly advise that you test your rules with existing releases, not all siteops are keen on trial runs.

Begin by looking up the release

	# !lookup TRANNYHEAVEN XXX Tranny.Grannys.20.XXX.DVDRip.XviD-SiCKFUCK

then see the info on the relase

	# !kbshow XXX Tranny.Grannys.20.XXX.DVDRip.XviD-SiCKFUCK


Add routes
----------

Now that the basic stuff has been set up, it's time to decide what sites trade where, we do that with routes.
You can manually set the number [1-9]. If you chose 9 slftp will calculate the routes according to speed, time and ranking.
This is probably the best option for n00bs.

If you want to read more on this look at the chains file.

	# !routeset sitefrom siteto 9

For example if we want to trade stuff from TRANNYHEAVEN to GRANNYHEAVEN and then from GRANNYHEAVEN to TRANNYHEAVEN aswell

	# !routeset TRANNYHEAVEN GRANNYHEAVEN 9
	# !routeset GRANNYHEAVEN TRANNYHEAVEN 9


Turn on auto
------------

Last but not least, turn on the auto

	# !auto 1