IrcBridge - Revision history

Bibim at 20:33, 26 March 2019

2019-03-26T20:33:00Z

← Older revision		Revision as of 21:33, 26 March 2019
Line 19:		Line 19:
	==How to get the full player list ? How to know who is online ?==		==How to get the full player list ? How to know who is online ?==

	Usually, in Spring lobby clients, there is a "local" tab which contains all online players so that you know who is online. You can have the same ~~behaviour~~ with IRC bridge by joining the special "&local" channel. This channel is actually a fake channel which contains all online clients.		Usually, in Spring lobby clients, there is a "local" tab which contains all online players so that you know who is online. You can have the same behavior with IRC bridge by joining the special "&local" channel. This channel is actually a fake channel which contains all online clients.

	Also, if you try to send a private message to a client who isn't online, you will be warned by the IRC bridge that ~~noone~~ received your message (like with normal IRC servers).		Also, if you try to send a private message to a client who isn't online, you will be warned by the IRC bridge that no one received your message (like with normal IRC servers).

	==Can I join battles ?==		==Can I join battles ?==
Line 74:		Line 74:

	In standard channels, the +v/-v user mode changes corresponding to in-game/out-of-game Spring status changes can be annoying because there can be a lot of them at the same time, and they may generate messages at client side. Usually you can filter these messages in your IRC client. But you can also choose to filter them at IRC bridge level, by disabling your "s" (STATUS_CHANGES) user flag. To do so you can send the following standard IRC command: "MODE <nickname> -s" (user modes are persistent at IRC bridge level, so you don't have to send it every time you reconnect).		In standard channels, the +v/-v user mode changes corresponding to in-game/out-of-game Spring status changes can be annoying because there can be a lot of them at the same time, and they may generate messages at client side. Usually you can filter these messages in your IRC client. But you can also choose to filter them at IRC bridge level, by disabling your "s" (STATUS_CHANGES) user flag. To do so you can send the following standard IRC command: "MODE <nickname> -s" (user modes are persistent at IRC bridge level, so you don't have to send it every time you reconnect).

			==Can I use CTCP (Client-To-Client Protocol) IRC extension ?==

			Yes, the IRC bridge supports the CTCP IRC protocol extension. CTCP VERSION is supported even when interacting with standard Spring lobby clients, whereas other CTCP commands (DCC CHAT, DCC SEND ...) only work with other IRC bridge users.

	==How to avoid timeouts between your client and the IRC bridge ?==		==How to avoid timeouts between your client and the IRC bridge ?==

Bibim: /* What do IRC masks mean in Spring world ? */

2019-03-26T19:30:49Z

What do IRC masks mean in Spring world ?

← Older revision		Revision as of 20:30, 26 March 2019
Line 57:		Line 57:
	Standard format is "<nick>!<ident>@<host>", where <nick> is the nickname of the client (as seen on screen during chat), <ident> is the username (as provided by the client), and <host> is the actual hostname or IP address of the client.		Standard format is "<nick>!<ident>@<host>", where <nick> is the nickname of the client (as seen on screen during chat), <ident> is the username (as provided by the client), and <host> is the actual hostname or IP address of the client.

	When using Spring IRC bridge, <ident> is replaced by ~~"<countryCode>_<cpuSpeed>" where~~ <countryCode> is the country code on 2 letters~~, and <cpuSpeed> is the CPU speed provided by the client~~. And <host> is replaced by "<accountId>.taspringmaster.clan-sy.com", where <accountId> is the account identifier (which doesn't change when users renames).		When using Spring IRC bridge, <ident> is replaced by <countryCode> which is the country code on 2 letters. And <host> is replaced by "<accountId>.taspringmaster.clan-sy.com", where <accountId> is the account identifier (which doesn't change when users renames).

	That way, IRC client functionalities which rely on IRC user masks (ignore, highlights etc.) still work reliably.		That way, IRC client functionalities which rely on IRC user masks (ignore, highlights etc.) still work reliably.

Bibim: Update GitHub link

2013-11-02T10:00:33Z

Update GitHub link

← Older revision		Revision as of 11:00, 2 November 2013
Line 29:		Line 29:
	Here are some ways to join battles easily using IRC bridge:		Here are some ways to join battles easily using IRC bridge:
	* you can use the IRC command "LIST" to list all channels. The battles will appear in this list, with various colored information as topic (status, number of players/specs, modname, mapname, description etc.)		* you can use the IRC command "LIST" to list all channels. The battles will appear in this list, with various colored information as topic (status, number of players/specs, modname, mapname, description etc.)
	* you can use the &<playerName> alias to refer to the battle in which <playerName> is. For example, sending the IRC command "JOIN &~~bibim~~" will join the battle in which player "~~bibim~~" is currently		* you can use the &<playerName> alias to refer to the battle in which <playerName> is. For example, sending the IRC command "JOIN &joe" will join the battle in which player "joe" is currently
	* you can use the IRC command "WHOIS" on a player to check in which battle he is		* you can use the IRC command "WHOIS" on a player to check in which battle he is

Line 59:		Line 59:
	When using Spring IRC bridge, <ident> is replaced by "<countryCode>_<cpuSpeed>" where <countryCode> is the country code on 2 letters, and <cpuSpeed> is the CPU speed provided by the client. And <host> is replaced by "<accountId>.taspringmaster.clan-sy.com", where <accountId> is the account identifier (which doesn't change when users renames).		When using Spring IRC bridge, <ident> is replaced by "<countryCode>_<cpuSpeed>" where <countryCode> is the country code on 2 letters, and <cpuSpeed> is the CPU speed provided by the client. And <host> is replaced by "<accountId>.taspringmaster.clan-sy.com", where <accountId> is the account identifier (which doesn't change when users renames).

	That way, IRC client ~~functionnalities~~ which rely on IRC user masks (ignore, highlights etc.) still work reliably.		That way, IRC client functionalities which rely on IRC user masks (ignore, highlights etc.) still work reliably.

	==How to get more Spring-specific information about users ? (ranks, status etc.)==		==How to get more Spring-specific information about users ? (ranks, status etc.)==
Line 69:		Line 69:

	If you try to send raw commands directly with your IRC client, the raw command will be interpreted by the IRC bridge itself and won't be forwarded to Spring lobby server.		If you try to send raw commands directly with your IRC client, the raw command will be interpreted by the IRC bridge itself and won't be forwarded to Spring lobby server.
	To send raw commands to Spring lobby server through IRC bridge, you have to join the special channel "&local" and simply say the command as a chat message here. The "&local" channel is just a fake channel, and ~~noone~~ will see what is entered here. Messages are simply forwarded to Spring lobby server without any modification.		To send raw commands to Spring lobby server through IRC bridge, you have to join the special channel "&local" and simply say the command as a chat message here. The "&local" channel is just a fake channel, and no one will see what is entered here. Messages are simply forwarded to Spring lobby server without any modification.

	==How to filter annoying user mode changes ?==		==How to filter annoying user mode changes ?==
Line 91:		Line 91:
	* &debug contains the same as &debug_lobby and &debug_irc gathered in one channel		* &debug contains the same as &debug_lobby and &debug_irc gathered in one channel

	==~~Source Code~~==		==Is the source code available? What is the license?==

	https://github.com/~~bibim~~/SpringIrcBridge		The IRC bridge source code is available [https://github.com/Yaribz/SpringIrcBridge here] under GPL v3 license.

	[[Category: Lobby]]		[[Category: Lobby]]

Bibim: /* How to get the full player list ? How to know who is online ? */

2013-10-17T16:27:42Z

How to get the full player list ? How to know who is online ?

← Older revision		Revision as of 17:27, 17 October 2013
Line 20:		Line 20:

	Usually, in Spring lobby clients, there is a "local" tab which contains all online players so that you know who is online. You can have the same behaviour with IRC bridge by joining the special "&local" channel. This channel is actually a fake channel which contains all online clients.		Usually, in Spring lobby clients, there is a "local" tab which contains all online players so that you know who is online. You can have the same behaviour with IRC bridge by joining the special "&local" channel. This channel is actually a fake channel which contains all online clients.

	Also, if you try to send a private message to a client who isn't online, you will be warned by the IRC bridge that noone received your message (like with normal IRC servers).		Also, if you try to send a private message to a client who isn't online, you will be warned by the IRC bridge that noone received your message (like with normal IRC servers).

Bibim: added debug special channels

2013-10-17T15:41:51Z

added debug special channels

← Older revision		Revision as of 16:41, 17 October 2013
Line 81:		Line 81:

	If Spring lobby server takes too much time to answer, IRC bridge will consider the connection as down. The default timeout is 60 seconds, which should be ok most of the time (maximum value is 600 and minimum value is 20). However, sometimes Spring lobby server is overloaded so it takes very long to answer to all Spring clients but connections are still active. You can increase the lobby timeout if you want to stay connected in this case. On the other hand, the IRC bridge will take more time to detect that Spring lobby server is down, so you could think you are still connected whereas lobby server is down. You can change your lobby timeout value by changing your "T" (TIMEOUT_LOBBY) user flag. To do so you can send the following standard IRC command: "MODE <nickname> T <timeout>" (user modes are persistent at IRC bridge level, so you don't have to send it every time you reconnect).		If Spring lobby server takes too much time to answer, IRC bridge will consider the connection as down. The default timeout is 60 seconds, which should be ok most of the time (maximum value is 600 and minimum value is 20). However, sometimes Spring lobby server is overloaded so it takes very long to answer to all Spring clients but connections are still active. You can increase the lobby timeout if you want to stay connected in this case. On the other hand, the IRC bridge will take more time to detect that Spring lobby server is down, so you could think you are still connected whereas lobby server is down. You can change your lobby timeout value by changing your "T" (TIMEOUT_LOBBY) user flag. To do so you can send the following standard IRC command: "MODE <nickname> T <timeout>" (user modes are persistent at IRC bridge level, so you don't have to send it every time you reconnect).

			==I have problems using the bridge, can I see the network messages exchanged in real time to investigate myself?==

			Sure, you can join the special channels "&debug", "&debug_lobby" and "&debug_irc". These fake channels allow any IRC bridge user to check the messages exchanged between his IRC client, the IRC bridge and the lobby server (for his connection only of course).

			* &debug_lobby contains all network messages exchanged between the Spring lobby server and the IRC bridge
			* &debug_irc contains all network messages exchanged between the IRC bridge and the IRC client
			* &debug contains the same as &debug_lobby and &debug_irc gathered in one channel

	==Source Code==		==Source Code==

Bibim: Timeout limits adjusted

2013-10-17T10:16:14Z

Timeout limits adjusted

← Older revision		Revision as of 11:16, 17 October 2013
Line 76:		Line 76:
	==How to avoid timeouts between your client and the IRC bridge ?==		==How to avoid timeouts between your client and the IRC bridge ?==

	If you have connection issues, you can try to tune the IRC bridge timeout. Default value is 120 seconds, which should fit most connections (maximum value is 600 and minimum value is 5). If you use a big value as IRC timeout, you will be able to stay connected even if your Internet connection is down for a long time. However the IRC bridge will take more time to detect that your connection is down, so you could appear online on Spring lobby server whereas your connection is down. You can change your IRC timeout value by changing your "t" (TIMEOUT_IRC) user flag. To do so you can send the following standard IRC command: "MODE <nickname> t <timeout>" (user modes are persistent at IRC bridge level, so you don't have to send it every time you reconnect). Note that increasing the IRC timeout value won't help if your IP address changes after each disconnection.		If you have connection issues, you can try to tune the IRC bridge timeout. Default value is 120 seconds, which should fit most connections (maximum value is 600 and minimum value is 20). If you use a big value as IRC timeout, you will be able to stay connected even if your Internet connection is down for a long time. However the IRC bridge will take more time to detect that your connection is down, so you could appear online on Spring lobby server whereas your connection is down. You can change your IRC timeout value by changing your "t" (TIMEOUT_IRC) user flag. To do so you can send the following standard IRC command: "MODE <nickname> t <timeout>" (user modes are persistent at IRC bridge level, so you don't have to send it every time you reconnect). Note that increasing the IRC timeout value won't help if your IP address changes after each disconnection.

	==How to avoid timeouts between IRC bridge and Spring lobby server ?==		==How to avoid timeouts between IRC bridge and Spring lobby server ?==

	If Spring lobby server takes too much time to answer, IRC bridge will consider the connection as down. The default timeout is 60 seconds, which should be ok most of the time (maximum value is 600 and minimum value is 16). However, sometimes Spring lobby server is overloaded so it takes very long to answer to all Spring clients but connections are still active. You can increase the lobby timeout if you want to stay connected in this case. On the other hand, the IRC bridge will take more time to detect that Spring lobby server is down, so you could think you are still connected whereas lobby server is down. You can change your lobby timeout value by changing your "T" (TIMEOUT_LOBBY) user flag. To do so you can send the following standard IRC command: "MODE <nickname> T <timeout>" (user modes are persistent at IRC bridge level, so you don't have to send it every time you reconnect).		If Spring lobby server takes too much time to answer, IRC bridge will consider the connection as down. The default timeout is 60 seconds, which should be ok most of the time (maximum value is 600 and minimum value is 20). However, sometimes Spring lobby server is overloaded so it takes very long to answer to all Spring clients but connections are still active. You can increase the lobby timeout if you want to stay connected in this case. On the other hand, the IRC bridge will take more time to detect that Spring lobby server is down, so you could think you are still connected whereas lobby server is down. You can change your lobby timeout value by changing your "T" (TIMEOUT_LOBBY) user flag. To do so you can send the following standard IRC command: "MODE <nickname> T <timeout>" (user modes are persistent at IRC bridge level, so you don't have to send it every time you reconnect).

	==Source Code==		==Source Code==

Abma at 13:42, 3 October 2013

2013-10-03T13:42:03Z

← Older revision		Revision as of 14:42, 3 October 2013
Line 86:		Line 86:
	https://github.com/bibim/SpringIrcBridge		https://github.com/bibim/SpringIrcBridge

	[[Category: ~~Lobbies~~]]		[[Category: Lobby]]

Abma: /* How to avoid timeouts between IRC bridge and Spring lobby server ? */

2013-02-24T22:36:15Z

How to avoid timeouts between IRC bridge and Spring lobby server ?

← Older revision		Revision as of 23:36, 24 February 2013
Line 81:		Line 81:

	If Spring lobby server takes too much time to answer, IRC bridge will consider the connection as down. The default timeout is 60 seconds, which should be ok most of the time (maximum value is 600 and minimum value is 16). However, sometimes Spring lobby server is overloaded so it takes very long to answer to all Spring clients but connections are still active. You can increase the lobby timeout if you want to stay connected in this case. On the other hand, the IRC bridge will take more time to detect that Spring lobby server is down, so you could think you are still connected whereas lobby server is down. You can change your lobby timeout value by changing your "T" (TIMEOUT_LOBBY) user flag. To do so you can send the following standard IRC command: "MODE <nickname> T <timeout>" (user modes are persistent at IRC bridge level, so you don't have to send it every time you reconnect).		If Spring lobby server takes too much time to answer, IRC bridge will consider the connection as down. The default timeout is 60 seconds, which should be ok most of the time (maximum value is 600 and minimum value is 16). However, sometimes Spring lobby server is overloaded so it takes very long to answer to all Spring clients but connections are still active. You can increase the lobby timeout if you want to stay connected in this case. On the other hand, the IRC bridge will take more time to detect that Spring lobby server is down, so you could think you are still connected whereas lobby server is down. You can change your lobby timeout value by changing your "T" (TIMEOUT_LOBBY) user flag. To do so you can send the following standard IRC command: "MODE <nickname> T <timeout>" (user modes are persistent at IRC bridge level, so you don't have to send it every time you reconnect).

			==Source Code==

			https://github.com/bibim/SpringIrcBridge

	[[Category: Lobbies]]		[[Category: Lobbies]]

Bibim at 07:02, 7 February 2013

2013-02-07T07:02:06Z

← Older revision		Revision as of 08:02, 7 February 2013
Line 8:		Line 8:

	Configure your IRC client as follows:		Configure your IRC client as follows:
	* server: 82.~~236~~.~~136.190~~		* server: irc.springrts.com
	* port: 6667 (or 16667)		* port: 6667 (or 16667)
	* nickname: login of a valid Spring lobby account (not connected to Spring lobby server currently)		* nickname: login of a valid Spring lobby account (not connected to Spring lobby server currently)
Line 16:		Line 16:

	'''''Note:''''' When creating a new lobby account to be used over IRC, you first have to login with it on the lobby, at least once.		'''''Note:''''' When creating a new lobby account to be used over IRC, you first have to login with it on the lobby, at least once.

	~~==Is it an official Spring bridge ? Can't this be used to steal passwords ?==~~

	~~This is ''NOT'' an official Spring bridge, and indeed with some modifications this bridge ''COULD'' be used to steal passwords of users connecting to it.~~
	~~Of course, as IRC bridge developer and administrator, I know this won't happen because I'm not interested at all in stealing Spring passwords or things like that, but I can't prove it.~~
	~~So all I can say is if you don't trust it, don't use it (or create an alternate Spring lobby account just to use the IRC bridge).~~

	==How to get the full player list ? How to know who is online ?==		==How to get the full player list ? How to know who is online ?==

Bibim: /* How to use it ? */

2013-02-03T09:06:04Z

How to use it ?

← Older revision		Revision as of 10:06, 3 February 2013
Line 8:		Line 8:

	Configure your IRC client as follows:		Configure your IRC client as follows:
	* server: ~~springrts~~.~~game-host~~.~~org~~		* server: 82.236.136.190
	* port: 6667 (or 16667)		* port: 6667 (or 16667)
	* nickname: login of a valid Spring lobby account (not connected to Spring lobby server currently)		* nickname: login of a valid Spring lobby account (not connected to Spring lobby server currently)