WolfWiki - User contributions [en]

File:File graph GraphVizExtensionDummy dot.png

2015-11-25T09:07:43Z

Bani: generated by the GraphViz extension from the File page

File:ETTV Server Configuration digraph ettv dot.png

2015-11-25T09:01:12Z

Bani: generated by the GraphViz extension from the ETTV:Server Configuration page

[[Category:GraphViz]][[Category:GraphViz dot]]

File:File graph GraphVizExtensionDummy dot.jpeg

2015-11-25T09:01:03Z

Bani: generated by the GraphViz extension from the File page

File:File graph GraphVizExtensionDummy dot.jpg

2015-11-25T09:01:02Z

Bani: generated by the GraphViz extension from the File page

ETTV:Server Configuration

2015-11-25T08:36:23Z

Bani:

<graphviz>
digraph ettv {
master -> slave1
master -> slave2
slave1 -> "client1.."
slave1 -> "..client50"
slave2 -> "client51.."
slave2 -> "..client100"
slave1 -> "chained_slave1"
chained_slave1 -> "client101"
chained_slave1 -> "...client150"
}
</graphviz>

==Installation - "Master" (gameserver)==

Copy ettv.(x86|exe) to the same directory your etded.(x86|exe) is located.
Start your gameserver as normal, but run ettv.(x86|exe) instead of etded.(x86|exe).

===Set some cvars===

'''ettv_sv_maxslaves''' (default 0, no slave connections allowed)
:Number of ettv slaves allowed to connect.
:''Note:'' Slave slots are always reserved, like private slots.
'''ettv_password''' (default "", no slave connections allowed)
:Password for ettv slaves.
:Must be set, or no slaves will be able to connect!
'''b_ettv_flags''' (default 3)
:1 = prevent slaves from being callvote kicked
:2 = grant shoutcaster status to slaves
:values can be added together, eg 3 for both features.

===Playing on the master===
Players may now connect to your gameserver as normal.

==Installation - "Slave" (broadcast server)==

Copy ettv.(x86|exe) to the same directory your etded.(x86|exe) is located.
Copy tvgame.mp.i386.(so|dll) to the same directory as your etpro/qagame.mp.i386.(so|dll) is located.

===Set some cvars===
'''sv_maxclients'''
:Number of spectator clients to allow. This number is only limited by available cpu and memory.
:Some guidelines when provisioning a broadcast server:
:*100 spectator slots will require ~ 128mb ram. Use com_hunkmegs to set this.
:*100 spectator slots will require ~ 768kbyte/sec (6mbits), roughly 6kbyte/sec per client
:*100 spectator slots will take ~ 80% cpu of a Xeon 2.2ghz
:*Each slave will require ~20-40kbyte/sec from the master.

'''ettv_clientname''' (default "ETTV")
:Playername the slave will use when connecting to the master, eg "ETTV-xyz"

'''ettv_delay''' (default 0, disabled)
:number of seconds for slave to delay the master feed. Recording/playback chains should no longer be needed, and slaves should always maintain an exact delay from the master server.
:''note'': this should ONLY be set on the slave.
:''note'': only supported in ettv beta8 and later

===Chat passwords===
In order to curb the rampant abuse of ettv chat, admins may set "chat passwords" on their servers. If enabled, viewers are not allowed to chat unless they have a password. You can define as many passwords as you like, so you can easily track down individual abusers and limit the damage of stolen passwords.

'''ettv_chatpasswords''' (default 0, disabled)
:number of chat passwords defined.
'''ettv_chatpassword'''(1-99999)
:individual chat passwords.

viewers use <tt>/chatpassword <password></tt> to login.

if logged in, ettv chats will be tagged with a number in parentheses identifying which chat password the viewer is using.
===Misc commands for viewers===
;For ettv beta 4 and above
* spectators may <tt>/ignore</tt> and <tt>/unignore</tt> other spectators
* semiadmin functionality now works for slaves
* rcon may now mute/unmute specs

===Connect the slave===
Now start your slave server by running ettv.(x86|exe)

Tell the slave server to connect up to the master server:
:<tt>tv connect master.ip.address:port ettv_password(required) g_password(if the master has a g_password set)</tt>

If you have configured everything correctly, the slave should connect to the master.
Clients should now be able to connect to the slave and spectate the game in progress.

This is a "live broadcast" with no delay.

===Disconnect the slave===
To tell the slave to disconnect from the master:
:<tt>tv disconnect</tt>

===Slave Chaining===

==== What is chaining and why chain slaves? ====

ETTV allows chaining slaves together. This very neat feature lets you connect one ETTV slave to another ETTV slave that is broadcasting a match instead of directly to the game server hosting the match. Apart from the "w00t this is very cool" factor, why is this feature so important for admins? Basicly, working in a chained model allows to broadcast a match to a large number of spectators without too much hastle and too many risks for the master server.

Chaining was developped for a simple reason: if you take into account that one ETTV slave connects at an '''unlimited''' rate to a master, you really don't want to connect 15 or 20 slaves to a game server to broadcast let's say the ''Atlantic Battle''. Chances are you will bring down the master game server and thus the game. Chaining slaves firmly alleviates the load on the master game server. 2 or 4 of these ''Hubs'' can do the job of delaying the signal and feeding it to other slaves.

Other benefits might include better network performance. If you can choose to either connect your slave to the game server where your connection is not optimal or to a nearby slave who is on a better connection to the master, it might help the quality of your broadcast. Plus you don't need to record anything when connecting to a delayed slave.

==== Setting up your slave to allow connections from other slaves ====

This part is actually pretty easy. You need to set up your slave as if you were setting up a master game server. This means that, next to the normal slave parameters, you have to set up the following:

* '''b_ettv_flags''': set this to at least 1
* '''ettv_sv_maxslaves''': set this to at least 1. Depending on how powerful your machine is you can set this number higher. Don't set it too high though, a slave still connects at an unlimited rate
* '''ettv_password''': set to something else than "". This password is needed by the slaves connecting to your slave (together with g_password of course)

Other settings such as ettv_netblast, ettv_tv_iptos etc... can be set as well. You can even use autorecord if you wish, or just add an extra delay.

==== Pitfalls ====

There are however a few risks associated with slave chaining. One of the biggest issues is '''PK3 dependancies'''.

As you know, a slave needs to have at least all the PK3s of the server it connects too. But a slave can have more PK3s installed, as long as it has the ones on the server's pure list. This is what complicates things! The further you go down the "chain", the more the chances exist of PK3 pollution, which makes the job of the last slave very hard. And the viewers connecting to that slave will not be very happy either.

So for those of you venturing into chaining slaves here's a rule of thumb: '''always keep the installed PK3s to the bare minimum'''! Do not add stuff you do not need. If you want to know what PK3s you need and not need, connect your slave to the master or the hub, see which PK3s are on the pure list and rename or remove the PK3s that are not on the list. You will make your viewers and other admins connecting to your slave very happy.

Another risk could be '''chained lag'''. If one of the slaves that is higher in the chain starts lagging, the consequenses for the slaves depending on it will be seen immedeatily. So if you offer to be one of the higher slaves in the chain, make sure your machine can handle it! An ETTV chain is much like the food chain ;-).

==== Admin contributions ====

If by now you feel like getting your hands dirty in ETTV chaining madness and you want to see some example of hubs, slaves, broadcasters and scripts to get it all working, you can already start by checking out [[User:Deej|deej's page]].

==ETTV Demos==
ETTV can record and playback '''ETTV demos'''. ETTV demos have the extension .tv_84 (or .tv_83 for older versions) and are completely different from the .dm_84 demos recorded on clients.

You may record the match in progress to a file, with the command:
:<tt>record <'''demo name'''></tt>
If you omit the demo name, ettv will start recording using a filename of demoXXXX where XXXX is the first available number starting from 0000.

Demos will stop recording when a map changes.

To stop recording a demo:
:<tt>stoprecord</tt>

To play back a recorded demo:
:<tt>demo <'''demo name'''></tt>

To check the status of an ettv slave:
:<tt>tv status</tt>
This will tell you if the slave is connected to a master, or if it is currently playing back a demo.

To fastforward a demo:
:<tt>ff <seconds></tt>
Eg <tt>ff 30</tt> will fast foward 30 seconds. Fast forward stops at map restarts, so you can safely ff 999 to fast forward through a warmup.
:''note'': requires ettv beta 7 or later

===Autorecording demos===
ettv is able to automatically continuously record demos, creating new demofiles when the map changes. To do this, set the cvar ettv_autorecord to 1. ettv will start recording demos with the name demoXXXX where XXXX is a number starting at 0000 and incrementing on each map change.

Server admins may find it useful to use the demo recording feature of ettv to record matches, instead of requiring individual players to record them. An ettv demo records everything that happens on a server, including all player viewpoints.

===How to create demo based delayed feeds===
Autorecording demos is the first half of the process for delayed feeds. Typically you would run a passworded slave server with the smallest number of sv_maxclients possible. No spectators should connect to this server. The only purpose of this slave is to connect up to the master and record the match to sequentially numbered demofiles.

Now start up a slave, and tell it to broadcast the demo being recorded.

:<tt>demo demo0000</tt>

If you wait approx. 60 seconds after the master begins recording before issuing this command to your slaves, then you have a 60 second delay on your broadcast.

If you want slaves to automatically switch to the next demo when the end of the demo is reached (eg on a map change), you would set the cvar ettv_autoplay to 1. If a slave is playing demo0000 and it reaches the end, it will then try to play demo0001 and so on.

Disadvantage of this method: It is not automated in ettv itself, though admins can script it.
Advantage of this method: You may run multiple broadcast servers from the same single demo stream.

Automated delayed feeds are supported in ettv beta 8. See the above.

===Playing back previously recorded ETTV demos===
This is essentially the same as delayed feeds above.
* Configure your server as described in [[ETTV:Server_Configuration#Installation_-_.22Slave.22_.28broadcast_server.29|Slave Installation]] section
* Obtain the <tt>.tv_*</tt> demos and place them in <tt>''fs_game''/demos</tt>
* Start the ettv executable with pb disabled
* <tt>set ettv_autoplay 1</tt> if you want to play back sequential demos named <tt>demo0000.tv_84</tt>, <tt>demo0001.tv_84</tt> etc.
* <tt>demo '''<yourdemoname>'''</tt>
* connect a client and enjoy the show!

==Troubleshooting==

* The slave server must be running the same fs_game setting as the master server.
* The slave server must have a copy of every map pk3 the master server is using.
* If the master server loads a map the slave server doesn't have, the slave will get stuck.
* Spectators will be forced to download any custom pk3 you are using.
* It is a good idea to keep the master server pk3 list to a minimum.
* If you are using the autorecord/autoplay feature for running delayed feeds, you will usually want to make sure you clear out the demos directory first. Autorecording will start numbering demofiles using the first available number, so if you have old recorded demos then ettv might start recording from eg demo0017. If your scripts expect to start playback from demo0000 then you might end up broadcasting a game recorded at some earlier date...
* If the broadcaster constantly reloads on round starts etc, it's probably a problem with too many pk3s on the ettv servers.

==Miscellaneous==
* Slaves may send chats to the master with the command msay
* Slaves may list players on the master with the command players

==Performance tuning==

Spectator servers with large numbers of clients (eg >100) will push the OS very hard with huge amounts of UDP traffic. The default OS buffer settings for Linux are inadequate and can hurt performance, causing lag and/or disconnects.

If you get messages like
:<tt>NET_SendPacket ERROR: No buffer space available to 192.168.120.142:27960</tt>

Then you definitely need to increase your kernel network buffers.

Large spectator servers should increase the kernel buffers.

The following commands should be issued as root on linux:
:<tt>echo "524288" > /proc/sys/net/core/rmem_max</tt>
:<tt>echo "524288" > /proc/sys/net/core/wmem_max</tt>

These values will be lost on a reboot of your system. A good way to reapply the values upon boot is to include the following in your /etc/sysctl.conf:

:<tt>net.core.rmem_default = 524288</tt>
:<tt>net.core.rmem_max = 524288</tt>
:<tt>net.core.wmem_default = 524288</tt>
:<tt>net.core.wmem_max = 524288</tt>

FreeBSD can try this:
:<tt>sysctl -w net.inet.udp.recvspace=65535</tt>
:<tt>sysctl -w net.inet.udp.maxdgram=57344</tt>
:<tt>sysctl -w kern.ipc.maxsockbuf=8388608</tt>

===Network tuning cvars===
;The following are only available in ettv beta 7 and later.
By default, et uses small packets of 1400 bytes or less to send to clients. If messages need to be larger, they are 'fragmented' and sent over several server frames. ettv slave messages tend to be large and often fragment. ettv normally tries to send slaves all fragments at once to avoid jittery playback, but some networks / OSes handle this badly. ettv beta 7 introduces new controls so admins can optimize ettv for their individual network.

'''ettv_netblast''' (default 1)
:by default, ettv tries to send all fragments at once. some networks may handle this badly. Possible values are:
:* 0 - disable sending all fragments at once. Warning: setting this to 0 without increasing ettv_mtu will result in severely laggy slave playback.
:* 1 - send all fragments at once (default behaviour)
:* 2 - use the old (very broken) beta4 netblast behavior (only applicable for ETTV beta 11 & higher)

'''ettv_mtu''' (default 1400)
:; master only
:if your network / os supports it, you can set this to large values (eg 16000) to prevent message fragmentation and provide smoother ettv links. this cvar has no effect on normal ET clients.
:''note'': ettv_mtu must currently be set from commandline, it cannot be changed on the fly (yet).

'''ettv_tv_iptos''' (default 0)
:you can set the ip type of service field of ettv link packets. if your network/ISP supports it, you can use a value like 16 ("minimize delay") to prioritize ettv link packets over others on the network.

'''ettv_sv_iptos''' (default 0)
:same as ettv_tv_iptos, but affects packets for normal ET clients.

===Article Reference===
(x86|exe) refers to the file extension of the ettv file, for linux use .x86 and for windows use .exe
(so|dll) refers to the file extension of the slave file, for linux use .so and for windows use .dll

[[Category:ETTV]]

Talk:Lua Mod API

2007-01-03T19:52:31Z

Bani:

- et.G_SlotSound( slotnum, soundindex ) -> Plays the sound soundindex at for the player @ slotnum only. --[[User:RoadKillPuppy|RoadKillPuppy]] 14:17, 16 December 2005 (PST)
:you can do this with tempentities and SVF_SINGLECLIENT ...
:--[[User:Bani|Bani]] 17:32, 16 December 2005 (PST)

----
some of this can be done via function et_Print(text).. but this would greatly simplify life, 
my wish list for christmas: 
- getUserEguid(cno) - get a client's etpro guid? 
- repair gentity_set for vec3 - scotty fix the transporter please 
:[http://bani.anime.net/banimod/forums/viewtopic.php?t=6279 fixed.]--[[User:Bani|Bani]] 17:56, 22 December 2005 (PST)

trap sen server cmd is a ET engine trap the comand u send it send to the client and recived as a server command no a client command

to add ill well that would be al ot of coding for not much [[User:=FF=im2good4u|=FF=Im2good4u]] 12:12, 20 December 2005 (PST)

aight thnx. 
heres another api request, i'd like to be able to get a clients xp directly. et.gentity_get(cno, "sess.game_points") seems to return 0 always (?) 
--[[User:Hadr0|Hadr0]] 15:38, 21 December 2005 (PST)
:oh nevermind, i see this can be done now with xp = et.gentity_get(cno, "ps.stats", 8)
:nice... --[[User:Hadr0|Hadr0]] 16:58, 23 December 2005 (PST)
--------
add a way to determine if a client is 999, and if possible why he's 999 (loading, connecting, loosing packets, etc) 
--Gotenks

999 means: server has not been sent data from client for > 1000 ms. So there is no way to certainly tell why.
The timeoutflag is stored in the pmflags IIRC. Don't know if lua can read them right now. --[[User:Deus|Deus]] 23:12, 22 December 2005 (PST) 
Still would like access to the ping, or a dummy variable if they are 999, but also the ammount of time they are inactive. 
--[[User:Gotenks|Gotenks]] (Sorry for double post) 1:53, 31 December 2005 (CST)
:[http://bani.anime.net/banimod/forums/viewtopic.php?t=6291 fixed].--[[User:Bani|Bani]] 02:40, 7 February 2006 (PST)
----
Access to weapon stats during game similar to end of round stats that are displayed. 
--[[User:LethalInjection|LethalInjection]] 23:52, 22 December 2005 (PST)
:[http://bani.anime.net/banimod/forums/viewtopic.php?t=6291 fixed].--[[User:Bani|Bani]] 02:40, 7 February 2006 (PST)

----
please call et_Obituary() and et_Print() at the end of the engine function because we can do better output then. example: the engine output (ETPlayer killed himself.) is after the lua output (Hahaha! ETPlayer seems to be a selfkill noob!). thx!! --[[User:Pdi|pdi]] 09:13, 26 December 2006 (PST)
:It is called at the beginning of the function so lua mods can override obituary and print entirely if they want. I can make a separate lua hook which is called at the end of the function, eg et_ObituaryPost and et_PrintPost. [[User:Bani|Bani]] 11:52, 3 January 2007 (PST)
----

== IPC stuff ==

<hr>
i would like a et_IPCReceive whit an return value so u can send info back on a request

i would like a et_IPCSend that can send to all lua mods then them mods can decide if the wana use that message or not
[[User:=FF=im2good4u|=FF=Im2good4u]] 12:35, 8 January 2006 (PST)
<hr>
et_IPCReceive wouldn't send it to the other mod... afaik... so just use another send
just et_IPCSend to all modules (afaik, you can even send to ones not there), simple loop function
[[User:gotenks|gotenks]] 20:04, 8 January 2006 (CST)

yeh probely but its not verry handy its better to get the good vmnumber or to e able to send on mod filenames

apart from that returning a value will be more handy since tnhe u cna contine in 1 funtion else u got to reacise it in the recieve funtion [[User:=FF=im2good4u|=FF=Im2good4u]] 10:45, 9 January 2006 (PST)

<hr>
bani i need a console print function on the client that does sepport ascii plz [[User:=FF=im2good4u|=FF=Im2good4u]] 12:49, 12 January 2006 (PST)
:et.trap_SendServerCommand( clientnum, "print \"hello ascii console on the client\n\" ) ) --[[User:Bani|Bani]] 22:33, 15 January 2006 (PST)
<hr>
bani: how about a et_sound(id, sound) event? [[User:gotenks|gotenks]] 20:45, 17 January 2006 (CST)
:[http://wolfwiki.anime.net/index.php/ETPro:Lua_Mod_API#sound et.G_Sound( entnum, soundindex )] --[[User:Bani|Bani]] 22:07, 18 January 2006 (PST)
:bani, i was referring to an on event call, so when a sound is played et_sound(id,sound) would be called.[[User:gotenks|gotenks]] 21:45, 20 January 2006 (CST)
::most sounds are clientside... this would not be of much use. --[[User:Bani|Bani]] 04:42, 22 January 2006 (PST)
:::except for checking when something like a killing spree sound is activated--[[User:gotenks|gotenks]] 07:54, 23 January 2006 (CST)
:::::There would be no way for you to know what sound was activated. You can't get a filename from the soundindex.--[[User:Bani|Bani]] 10:19, 24 January 2006 (PST)
:::::This is a case where IPCSend/IPCReceive would be useful, so mods can notify each other of specific events.--[[User:Bani|Bani]] 02:40, 7 February 2006 (PST)

----
== Fields for the next release ==
Is it possible to get a player's live angles? Fieldname "s.angles" only gives the spawn angles. Tried "rotate", "s.angles2", "TargetAngles", "r.currentAngles" as well but they just give 0.000000 for each element. thanks for any help --[[User:Hadr0|Hadr0]] 01:35, 25 January 2006 (PST)
:This will be fixed in the next release, where you will get access to ps.viewangles--[[User:Bani|Bani]] 02:33, 7 February 2006 (PST)

Would it be possible to set the player's liveangle?Just like setting one's position(origin).I would also like to set player's velocities(maybe a vec3 field), 'speed' is not working. --[[User:Kotoko|Kotoko]] 06:06, 26 May 2006 (PDT)
:viewangles is what you want --[[User:ReyalP|ReyalP]] 14:00, 26 May 2006 (PDT)
Seems i get it ..It WILL BE AVAILABLE at NEXT release ..not now .. right?-_- [[User:Kotoko|Kotoko]] 22:49, 26 May 2006 (PDT)
:I think Kotoko wants the '''ps.velocity''' field here. It would be a good idea, I think. --[[User:FARMICEUDICAL|FARMICEUDICAL]] 20:23, 5 December 2006 (PST)

bani: please give access to fieldname 's.eventParm'. --[[User:Pdi|pdi]] 01:52, 6 July 2006 (PDT)

bani: RW access to all "sess.*" fields (sess.skillpoints, sess.startskillpoints, sess.startxptotal, ...) would be great. thanx! --[[User:Pdi|pdi]] 05:55, 2 August 2006 (PDT)

bani: please make all "pers.*" fields (pers.clientTimeNudge, pers.clientMaxPackets, ...) available. thanx! --[[User:Pdi|pdi]] 01:04, 17 August 2006 (PDT)
:you can get timenudge and maxpackets from the userinfo --[[User:ReyalP|ReyalP]] 20:19, 18 August 2006 (PDT)
::i know, but i ask for all pers.* fields. pers.clientTimeNudge and pers.clientMaxPackets are only examples. :) --[[User:Pdi|pdi]] 01:56, 21 August 2006 (PDT)

bani: will we have rw access to those fields (all sess.* and all pers.*) with next update? please!! --[[User:Pdi|pdi]] 07:02, 19 October 2006 (PDT)

'''ps.weapon''', so arbitrary weapons can be added to or removed from arbitrary classes. For example, trickjump servers don't like Field Ops spamming airstrikes or artillery, but they do appreciate the ammo they give out. --[[User:FARMICEUDICAL|FARMICEUDICAL]] 21:09, 5 December 2006 (PST)
: ps.weapon won't do that for you. ps.weapon'''s''' might :) --[[User:ReyalP|ReyalP]] 17:14, 6 December 2006 (PST)

Okay then, '''ps.weapon''' so that medics can be set to spawn with the adrenaline needle out instead of the smg. --[[User:FARMICEUDICAL|FARMICEUDICAL]] 03:23, 11 December 2006 (PST)

== LoadLib ==

Add loadlib ppl it says u have lua basic included but not loadlib !!

(on windows it gives an error attept to call global load lin a nil valua)[[User:=FF=im2good4u|=FF=Im2good4u]] 05:16, 15 February 2006 (PST)
----
== XP control not just skill ==

I would like to request RW access to the "sess.skillpoints" array

At least a callback on et.G_AddSkillPoints ( '''cno''', '''skill''', '''points''' ) [[User:=FF=im2good4u|=FF=Im2good4u]] 07:45, 8 March 2006 (PST)

Talk:Lua Mod API

2007-01-03T19:49:21Z

Bani:

- et.G_SlotSound( slotnum, soundindex ) -> Plays the sound soundindex at for the player @ slotnum only. --[[User:RoadKillPuppy|RoadKillPuppy]] 14:17, 16 December 2005 (PST)
:you can do this with tempentities and SVF_SINGLECLIENT ...
:--[[User:Bani|Bani]] 17:32, 16 December 2005 (PST)

----
some of this can be done via function et_Print(text).. but this would greatly simplify life, 
my wish list for christmas: 
- getUserEguid(cno) - get a client's etpro guid? 
- repair gentity_set for vec3 - scotty fix the transporter please 
:[http://bani.anime.net/banimod/forums/viewtopic.php?t=6279 fixed.]--[[User:Bani|Bani]] 17:56, 22 December 2005 (PST)

trap sen server cmd is a ET engine trap the comand u send it send to the client and recived as a server command no a client command

to add ill well that would be al ot of coding for not much [[User:=FF=im2good4u|=FF=Im2good4u]] 12:12, 20 December 2005 (PST)

aight thnx. 
heres another api request, i'd like to be able to get a clients xp directly. et.gentity_get(cno, "sess.game_points") seems to return 0 always (?) 
--[[User:Hadr0|Hadr0]] 15:38, 21 December 2005 (PST)
:oh nevermind, i see this can be done now with xp = et.gentity_get(cno, "ps.stats", 8)
:nice... --[[User:Hadr0|Hadr0]] 16:58, 23 December 2005 (PST)
--------
add a way to determine if a client is 999, and if possible why he's 999 (loading, connecting, loosing packets, etc) 
--Gotenks

999 means: server has not been sent data from client for > 1000 ms. So there is no way to certainly tell why.
The timeoutflag is stored in the pmflags IIRC. Don't know if lua can read them right now. --[[User:Deus|Deus]] 23:12, 22 December 2005 (PST) 
Still would like access to the ping, or a dummy variable if they are 999, but also the ammount of time they are inactive. 
--[[User:Gotenks|Gotenks]] (Sorry for double post) 1:53, 31 December 2005 (CST)
:[http://bani.anime.net/banimod/forums/viewtopic.php?t=6291 fixed].--[[User:Bani|Bani]] 02:40, 7 February 2006 (PST)
----
Access to weapon stats during game similar to end of round stats that are displayed. 
--[[User:LethalInjection|LethalInjection]] 23:52, 22 December 2005 (PST)
:[http://bani.anime.net/banimod/forums/viewtopic.php?t=6291 fixed].--[[User:Bani|Bani]] 02:40, 7 February 2006 (PST)

----
please call et_Obituary() and et_Print() at the end of the engine function because we can do better output then. example: the engine output (ETPlayer killed himself.) is after the lua output (Hahaha! ETPlayer seems to be a selfkill noob!). thx!! --[[User:Pdi|pdi]] 09:13, 26 December 2006 (PST)
:It is called at the beginning of the function so lua mods can override obituary and print entirely if they want. I can make a separate lua hook which is called at the end of the function, eg et_ObituaryPost and et_PrintPost. --
----

== IPC stuff ==

<hr>
i would like a et_IPCReceive whit an return value so u can send info back on a request

i would like a et_IPCSend that can send to all lua mods then them mods can decide if the wana use that message or not
[[User:=FF=im2good4u|=FF=Im2good4u]] 12:35, 8 January 2006 (PST)
<hr>
et_IPCReceive wouldn't send it to the other mod... afaik... so just use another send
just et_IPCSend to all modules (afaik, you can even send to ones not there), simple loop function
[[User:gotenks|gotenks]] 20:04, 8 January 2006 (CST)

yeh probely but its not verry handy its better to get the good vmnumber or to e able to send on mod filenames

apart from that returning a value will be more handy since tnhe u cna contine in 1 funtion else u got to reacise it in the recieve funtion [[User:=FF=im2good4u|=FF=Im2good4u]] 10:45, 9 January 2006 (PST)

<hr>
bani i need a console print function on the client that does sepport ascii plz [[User:=FF=im2good4u|=FF=Im2good4u]] 12:49, 12 January 2006 (PST)
:et.trap_SendServerCommand( clientnum, "print \"hello ascii console on the client\n\" ) ) --[[User:Bani|Bani]] 22:33, 15 January 2006 (PST)
<hr>
bani: how about a et_sound(id, sound) event? [[User:gotenks|gotenks]] 20:45, 17 January 2006 (CST)
:[http://wolfwiki.anime.net/index.php/ETPro:Lua_Mod_API#sound et.G_Sound( entnum, soundindex )] --[[User:Bani|Bani]] 22:07, 18 January 2006 (PST)
:bani, i was referring to an on event call, so when a sound is played et_sound(id,sound) would be called.[[User:gotenks|gotenks]] 21:45, 20 January 2006 (CST)
::most sounds are clientside... this would not be of much use. --[[User:Bani|Bani]] 04:42, 22 January 2006 (PST)
:::except for checking when something like a killing spree sound is activated--[[User:gotenks|gotenks]] 07:54, 23 January 2006 (CST)
:::::There would be no way for you to know what sound was activated. You can't get a filename from the soundindex.--[[User:Bani|Bani]] 10:19, 24 January 2006 (PST)
:::::This is a case where IPCSend/IPCReceive would be useful, so mods can notify each other of specific events.--[[User:Bani|Bani]] 02:40, 7 February 2006 (PST)

----
== Fields for the next release ==
Is it possible to get a player's live angles? Fieldname "s.angles" only gives the spawn angles. Tried "rotate", "s.angles2", "TargetAngles", "r.currentAngles" as well but they just give 0.000000 for each element. thanks for any help --[[User:Hadr0|Hadr0]] 01:35, 25 January 2006 (PST)
:This will be fixed in the next release, where you will get access to ps.viewangles--[[User:Bani|Bani]] 02:33, 7 February 2006 (PST)

Would it be possible to set the player's liveangle?Just like setting one's position(origin).I would also like to set player's velocities(maybe a vec3 field), 'speed' is not working. --[[User:Kotoko|Kotoko]] 06:06, 26 May 2006 (PDT)
:viewangles is what you want --[[User:ReyalP|ReyalP]] 14:00, 26 May 2006 (PDT)
Seems i get it ..It WILL BE AVAILABLE at NEXT release ..not now .. right?-_- [[User:Kotoko|Kotoko]] 22:49, 26 May 2006 (PDT)
:I think Kotoko wants the '''ps.velocity''' field here. It would be a good idea, I think. --[[User:FARMICEUDICAL|FARMICEUDICAL]] 20:23, 5 December 2006 (PST)

bani: please give access to fieldname 's.eventParm'. --[[User:Pdi|pdi]] 01:52, 6 July 2006 (PDT)

bani: RW access to all "sess.*" fields (sess.skillpoints, sess.startskillpoints, sess.startxptotal, ...) would be great. thanx! --[[User:Pdi|pdi]] 05:55, 2 August 2006 (PDT)

bani: please make all "pers.*" fields (pers.clientTimeNudge, pers.clientMaxPackets, ...) available. thanx! --[[User:Pdi|pdi]] 01:04, 17 August 2006 (PDT)
:you can get timenudge and maxpackets from the userinfo --[[User:ReyalP|ReyalP]] 20:19, 18 August 2006 (PDT)
::i know, but i ask for all pers.* fields. pers.clientTimeNudge and pers.clientMaxPackets are only examples. :) --[[User:Pdi|pdi]] 01:56, 21 August 2006 (PDT)

bani: will we have rw access to those fields (all sess.* and all pers.*) with next update? please!! --[[User:Pdi|pdi]] 07:02, 19 October 2006 (PDT)

'''ps.weapon''', so arbitrary weapons can be added to or removed from arbitrary classes. For example, trickjump servers don't like Field Ops spamming airstrikes or artillery, but they do appreciate the ammo they give out. --[[User:FARMICEUDICAL|FARMICEUDICAL]] 21:09, 5 December 2006 (PST)
: ps.weapon won't do that for you. ps.weapon'''s''' might :) --[[User:ReyalP|ReyalP]] 17:14, 6 December 2006 (PST)

Okay then, '''ps.weapon''' so that medics can be set to spawn with the adrenaline needle out instead of the smg. --[[User:FARMICEUDICAL|FARMICEUDICAL]] 03:23, 11 December 2006 (PST)

== LoadLib ==

Add loadlib ppl it says u have lua basic included but not loadlib !!

(on windows it gives an error attept to call global load lin a nil valua)[[User:=FF=im2good4u|=FF=Im2good4u]] 05:16, 15 February 2006 (PST)
----
== XP control not just skill ==

I would like to request RW access to the "sess.skillpoints" array

At least a callback on et.G_AddSkillPoints ( '''cno''', '''skill''', '''points''' ) [[User:=FF=im2good4u|=FF=Im2good4u]] 07:45, 8 March 2006 (PST)

Talk:Lua Mod API

2006-07-06T22:35:20Z

Talk:Lua Mod API

2005-12-23T09:38:33Z

Bani:

Talk:Lua Mod API

2005-12-23T01:56:19Z

Bani:

Talk:Lua Mod API

2005-12-17T01:32:00Z

Bani:

2005-11-18T02:16:28Z

Bani: TRUTH ABOUT FRETN

The fifth egg does not work in recent versions so i left it out. Something happens when you do the things to make it happen, but it stays like its value is 0. I Hope, that does not reveal too much ;) --[[User:Deus|Deus]] 05:46, 16 November 2005 (PST)

it's an extra level of difficulty if they want to find the real (working) one :p

== TRUTH ABOUT FRETN ==

[http://www.zapatopi.net/belgium/ OMG SCARY]

Fieldname

2005-11-16T21:08:17Z

Bani: lua-4 changes

Lua Mod API

2005-11-16T21:06:14Z

Bani:

__NOEDITSECTION__
<div align="center" style="background: #FFFFCC; padding: 2px; border: 2px solid #000000;">The latest version of the lua-enabled ETPro qagame is etpro-lua-4 and can be downloaded [http://etpro.anime.net/etpro-lua-4.zip here].</div>

ETPro now supports serverside mods via the [http://www.lua.org/ lua] scripting language.

ETPro has an embedded lua 5.0.2 interpreter, and if present will load user-defined scripts from the etpro directory. ETPro also provides an "et" library of function calls for lua to access the server engine, and provides callbacks so a serverside mod may trigger on specific server events.

The following standard lua libraries are initialized by default and available to ETPro lua scripts:
[http://www.lua.org/manual/5.0/manual.html#5.1 basic], [http://www.lua.org/manual/5.0/manual.html#5.4 table], [http://www.lua.org/manual/5.0/manual.html#5.6 i/o], [http://www.lua.org/manual/5.0/manual.html#5.3 string], [http://www.lua.org/manual/5.0/manual.html#5.5 math].

A list of [[ETPro]] mods can be found [[:Category:ETPro:Mods|here]].

==server commands==
===lua_status===
:lists all currently loaded lua modules.

==cvars==
===lua_modules===
:(default "", disabled)
:space separated list of lua modules for ETPro to load. modules will be run in the order listed.

===lua_allowedmodules===
:(default "", disabled)
:if set, only lua modules with the matching sha1 signatures listed in this cvar will be allowed to load.
 
changing either cvar will cause all currently loaded modules to quit and be unloaded until the next map_restart. 
 

==et library calls==

===modules===
et.RegisterModname( '''modname''' )
:Registers a descriptive string '''modname''' for this mod.
'''vmnumber''' = et.FindSelf()
:Returns a number indicating the VM slot the current mod is loaded into.
'''modname''', '''signature''' = et.FindMod( '''vmnumber''' )
:Returns the '''modname''' and sha1 '''signature''' for the mod loaded in the VM slot '''vmnumber'''. Returns nil, nil if the VM slot is invalid.
'''success''' = et.IPCSend( '''vmnumber''', '''message''' )
:Sends the string '''message''' to the mod in the VM slot indicated by '''vmnumber'''. The mod receiving '''message''' must have an ''et_IPCReceive()'' callback. If the message is successfully sent, '''success''' will be 1. On failure it will be 0.
 

===printing===
et.G_Print( '''text''' )
:Prints the string '''text''' to the server console.
et.G_LogPrint( '''text''' )
:Prints the string '''text''' to the server console and writes it to the server log.
 

===argument handling===
These functions are to be used within the [[#commands|command callback functions]]. 
'''args''' = et.ConcatArgs( '''index''' )
:Returns all arguments beginning from '''index''' concatenated into a single string '''args'''
'''argcount''' = et.trap_Argc()
:Returns a number indicating the number of command line arguments in the command buffer.
'''arg''' = et.trap_Argv( '''argnum''' )
:Returns the contents of the command line argument '''argnum'''.
 

===cvars===
'''cvarvalue''' = et.trap_Cvar_Get( '''cvarname''' )
:Returns the value of the cvar '''cvarname'''
et.trap_Cvar_Set( '''cvarname''', '''cvarvalue''' )
:Sets the cvar '''cvarname''' to '''cvarvalue'''
 

===configstrings===
'''configstringvalue''' = et.trap_GetConfigstring( '''index''' )
:Returns the string '''configstringvalue''' containing the contents of the configstring '''index'''
et.trap_SetConfigstring( '''index''', '''configstringvalue''' )
:Sets the configstring '''index''' to the string '''configstringvalue'''
 

===server===
et.trap_SendConsoleCommand( '''when''', '''command''' )
:Sends the command '''command''' to the server console, to be executed '''when''' (see et.EXEC_* constants)
 

===clients===
et.trap_DropClient( '''clientnum''', '''reason''', '''ban_time''' )
:Disconnects '''clientnum''' from the server, with descriptive string '''reason''' reported to clients. '''ban_time''' is the time in seconds to ban the client from the server. '''ban_time''' is optional and may be entirely omitted, in which case the ban time defaults to the cvar ''b_defaultbantime''
et.trap_SendServerCommand( '''clientnum''', '''command''' )
:Sends the command '''command''' to the client '''clientnum'''. If '''clientnum''' is -1, the '''command''' is broadcast to all connected clients.
et.G_Say( '''clientNum''', '''mode''', '''text''' )
:Sends a chat command on behalf of client '''clientNum''' with the mode '''mode''' (see et.SAY_* constants) and chat text '''text'''.
 

===userinfo===
'''userinfo''' = et.trap_GetUserinfo( '''clientnum''' )
:Returns the contents of the userinfo string for the client '''clientnum'''
et.trap_SetUserinfo( '''clientnum''', '''userinfo''' )
:Sets the userinfo string for the client '''clientnum''' to '''userinfo'''
 

===string utility functions===
'''infostring''' = et.Info_RemoveKey( '''infostring''', '''key''' )
:Removes key '''key''' from infostring '''infostring''' and returns the modified infostring.
'''infostring''' = et.Info_SetValueForKey( '''infostring''', '''key''', '''value''' )
:Sets the key '''key''' in the infostring '''infostring''' to '''value''' and returns the modified infostring.
'''keyvalue''' = et.Info_ValueForKey( '''infostring''', '''key''' )
:Returns the value of the key '''key''' in the infostring '''infostring'''
'''cleanstring''' = et.Q_CleanStr( '''string''' )
:Returns '''string''' stripped of all color codes
 

===ET filesystem===
'''fd''', '''len''' = et.trap_FS_FOpenFile( '''filename''', '''mode''' )
:Attempts to open the file '''filename''' with the access mode '''mode''' (see et.FS_ constants). Returns the filedescriptor '''fd''' and file length '''len'''. On error, '''len''' returns -1.
'''filedata''' = et.trap_FS_Read( fd, count )
:Reads '''count''' bytes from filedescriptor '''fd'''.
'''count''' = et.trap_FS_Write( '''filedata''', '''count''', '''fd''' )
:Attempts to write '''count''' bytes of '''filedata''' to filedescriptor '''fd'''. Returns number of bytes successfully written.
et.trap_FS_Rename( '''oldname''', '''newname''' )
:Renames file '''oldname''' to '''newname'''.
et.trap_FS_FCloseFile( '''fd''' )
:Closes filedescriptor '''fd'''
 

===indexes===
'''soundindex''' = et.G_SoundIndex( '''filename''' )
:Returns an index to the soundfile indicated by '''filename'''
'''modelindex''' = et.G_ModelIndex( '''filename''' )
:Returns an index to the model indicated by '''filename'''
 

===sound===
et.G_globalSound( '''sound''' )
:Plays the global sound indicated by the filename '''sound'''.
et.G_Sound( '''entnum''', '''soundindex''' )
:Plays the sound '''soundindex''' at the location of entity '''entnum'''
 

===miscellaneous===
'''milliseconds''' = et.trap_Milliseconds()
:Returns a number indicating the current server time in milliseconds.
 

===entities===
'''entnum''' = et.G_Spawn()
:Spawns a new entity and returns the new entity number.
'''entnum''' = et.G_TempEntity( '''origin''', '''event''' )
:Spawns a new TempEntity of event type '''event''' and places it at '''origin''' in the world.
et.G_FreeEntity( '''entnum''' )
:Frees the entity '''entnum'''
'''spawnval''' = et.G_GetSpawnVar( '''entnum''', '''key''' )
:Returns the value of spawnvar '''key''' for entity '''entnum'''
et.G_SetSpawnVar( '''entnum''', '''key''', '''value''' )
:Sets the spawnvar '''key''' to '''value''' for entity '''entnum'''
'''integer entnum''' = et.G_SpawnGEntityFromSpawnVars( string spawnvar, string spawnvalue, ... )
:This function can only be called inside the '''et_InitGame''' callback
et.trap_LinkEntity( '''entnum''' )
:Links the entity '''entnum'''
et.trap_UnlinkEntity( '''entnum''' )
:Unlinks the entity '''entnum'''
'''(variable)''' = et.gentity_get ( '''entnum''', '''[[Fieldname]]''' )
:Gets the value of '''[[Fieldname]]''' from entity '''entnum''' out of the g_entity struct 
et.gentity_set( '''entnum''', '''[[Fieldname]]''', '''(variable)''' )
:Sets the value of '''[[Fieldname]]''' from entity '''entnum''' in the g_entity struct to '''(variable)''' 

 

==callbacks==

===qagame execution===
et_InitGame( '''levelTime''', '''randomSeed''', '''restart''' )
:Called when qagame initializes. '''levelTime''' is the current level time in milliseconds. '''randomSeed''' is a number that can be used to seed random number generators. '''restart''' indicates if et_InitGame() is being called due to a map restart (1) or not (0).
et_ShutdownGame( '''restart''' )
:Called when qagame shuts down. '''restart''' indicates if the shutdown is being called due to a map_restart (1) or not (0).
et_RunFrame( '''levelTime''' )
:Called when qagame runs a server frame. '''levelTime''' is the current level time in milliseconds.
et_Quit()
:Called when ETPro unloads the mod. The mod should close all open filedescriptors and perform all cleanup.
 

===client management===
'''rejectreason''' = et_ClientConnect( '''clientNum''', '''firstTime''', '''isBot''' )
:Called when a client attempts to connect to the server. '''clientNum''' is the client slot id, '''firstTime''' indicates if this is a new connection (1) or a reconnection (0). '''isBot''' indicates if the client is a bot (1) or not (0). If the mod accepts the connection, it should return nil. Otherwise, the mod should return a string describing the reason the client connection was rejected.
et_ClientDisconnect( '''clientNum''' )
:Called when a client disconnects. '''clientNum''' is the client slot id.
et_ClientBegin( '''clientNum''' )
:Called when a client begins (becomes active, and enters the gameworld). '''clientNum''' is the client slot id.
et_ClientUserinfoChanged( '''clientNum''' )
:Called when a client's Userinfo string has changed. '''clientNum''' is the client slot id.
 

===commands===
'''intercepted''' = et_ClientCommand( '''clientNum''', '''command''' )
:Called when a command is received from a client. '''clientNum''' is the client slot id. '''command''' is the command. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
'''intercepted''' = et_ConsoleCommand()
:Called when a command is entered on the server console. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
'''intercepted''' = et_ClientSay( '''clientNum''', '''mode''', '''text''' )
:Called when a client sends a chat command. '''clientNum''' is the client slot id. '''mode''' is the chat mode (see et.SAY_* constants). '''text''' is the chat text. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain)
:Note that this command '''does not''' use the [[#argument_handling|argument handling]] functions.
 

===miscellaneous===
et_IPCReceive( '''vmnumber''', '''message''' )
:Called when another mod sends an et.IPCSend() message to this mod. '''vmnumber''' is the VM slot number of the sender, and '''message''' is the message.
et_Print( '''text''' )
:Called whenever the server or qagame prints a string to the console.
 

==predefined constants==
et.EXEC_NOW 
et.EXEC_INSERT 
et.EXEC_APPEND 
et.FS_READ 
et.FS_WRITE 
et.FS_APPEND 
et.FS_APPEND_SYNC 
et.SAY_ALL 
et.SAY_TEAM 
et.SAY_BUDDY 
et.SAY_TEAMNL 
 
et.HOSTARCH
:set to WIN32 or UNIX depending on the host architecture qagame is running on.
LUA_PATH
:set to fs_homepath/fs_game/?.lua in order to ease use of the [http://www.lua.org/pil/8.1.html require] function.
 

==configs==
If a config is loaded, all modules are shutdown and reloaded. If a ''certified'' config is loaded, all modules are shutdown and reloaded, and additionally the following functions are disabled: '''require()''', '''loadfile()''', '''loadlib()''', '''loadstring()''', '''dofile()''' 
 

==caveats==
Like qagame, lua modules are unloaded and reloaded on map_restart and map changes. This means that all global variables and other information is lost. Mods may choose to store persistent data in cvars or external files. 
 

==FAQ==

Q: OMG I hate the libary prefix et.* on everything!!11!1oneone 
A: table.foreach(et, function (func, value) _G[func] = value; end)

Q: How do a re-load my lua file without restarting the whole server ? 
A: change maps or map_restart

Q: Can I see some sample code? 
A: [[ETPro:Lua Sample Code]]

Q: Is there a list of [[ETPro]] mods? 
A: Yes, [[:Category:ETPro:Mods|here]].

Q: OMG my mod doesn't work! 
A: Make sure you added your mod's filename to the lua_modules cvar (e.g. set lua_modules mymod.lua).

[[Category:ETPro]]
[[Category:ETPro:Mods]]

User talk:Bani

2005-11-15T19:42:04Z

Bani:

The best method to contact [[Bani]] is through the [http://bani.anime.net/banimod/forums/ Banimod Forums] [http://bani.anime.net/banimod/forums/privmsg.php?folder=inbox Private Messenging] system. Alternatively you may join the [[ETPro]] [[IRC]] channel and talk to him there, but be warned that the Bani Monster rarely talks.

"nicked" ooo look at Bani trying to be English ;P

<sarcasm>By Jove! Are you implying that this charming young gentleman is not indeed English?</sarcasm> --Rookie One 10:49, 15 November 2005 (PST)

wtf mate? we use 'nicked' this side of the pond too. --[[User:Bani|Bani]] 11:42, 15 November 2005 (PST)

Main Page

2005-11-15T12:21:51Z

Bani: added __NOEDITSECTION__

<center>'''Welcome to''' '''[[WolfWiki]]''' </center>

<table cellspacing="8">
<tr valign="top">

<td width="60%" style="border: 1px solid #FABD23; color: #000; background-color: #fcfae3">
<div style="padding: .5em .9em .9em">
__NOTOC__
==About==
[[WolfWiki]] is a collaborative site for the ETPro / ETTV / BayonET community.

==Getting Started==
Anyone with a [http://bani.anime.net/banimod/forums/ Banimod Forums] account may edit pages. If you do not have an account, you may [http://bani.anime.net/banimod/forums/profile.php?mode=register apply] for one. Please follow the [[Help:Editing]] guidelines when editing pages. 
<hr>
<center>There are currently {{NUMBEROFARTICLES}} [[:Special:Allpages|articles available]].</center>
</div>
</td>

<td style="border: 1px solid #3e48fb; color: #000; background-color: #f0f0ff">
<div style="padding: .5em .9em .9em">
==[[:Category:ETPro|ETPro]]==
{{ETPro_Topics}}
==[[:Category:ETTV|ETTV]]==
[http://bani.anime.net/banimod/forums/viewforum.php?f=18 Discussion Forums] 
[[ETTV:Server Configuration|Server Configuration]] 
[[ETTV:Viewer's Guide|Viewer's Guide]] 

==[[:Category:BayonET|BayonET]]==
[http://bani.anime.net/banimod/forums/viewforum.php?f=10 Discussion Forums]

</div>
</td>

</tr>

</table>

__NOEDITSECTION__

2005-11-06T10:28:06Z

Bani:

<dot_graph>
digraph ettv {
master -> slave1
master -> slave2
slave1 -> "client1.."
slave1 -> "..client50"
slave2 -> "client51.."
slave2 -> "..client100"
}
</dot_graph>

==Installation - "Master" (gameserver)==

Copy ettv.x86 to the same directory your etded.x86 is located.
Start your gameserver as normal, but run ettv.x86 instead of etded.x86.

===Set some cvars===

'''ettv_sv_maxslaves''' (default 0, no slave connections allowed)
:Number of ettv slaves allowed to connect.
:''Note:'' Slave slots are always reserved, like private slots.
'''ettv_password''' (default "", no slave connections allowed)
:Password for ettv slaves.
:Must be set, or no slaves will be able to connect!
'''b_ettv_flags''' (default 1)
:1 = prevent slaves from being callvote kicked
:2 = grant shoutcaster status to slaves
:values can be added together, eg 3 for both features.

===Playing on the master===
Players may now connect to your gameserver as normal.

==Installation - "Slave" (broadcast server)==

Copy ettv.x86 to the same directory your etded.x86 is located.
Copy tvgame.mp.i386.so to the same directory as your etpro/qagame.mp.i386.so is located.

===Set some cvars===
'''sv_maxclients'''
:Number of spectator clients to allow. This number is only limited by available cpu and memory.
:Some guidelines when provisioning a broadcast server:
:*100 spectator slots will require ~ 128mb ram. Use com_hunkmegs to set this.
:*100 spectator slots will require ~ 768kbyte/sec (6mbits), roughly 6kbyte/sec per client
:*100 spectator slots will take ~ 80% cpu of a Xeon 2.2ghz
:*Each slave will require ~20-40kbyte/sec from the master.

'''ettv_clientname''' (default "ETTV")
:Playername the slave will use when connecting to the master, eg "ETTV-xyz"

'''ettv_delay''' (default 0, disabled)
:number of seconds for slave to delay the master feed. Recording/playback chains should no longer be needed, and slaves should always maintain an exact delay from the master server.
:''note'': this should ONLY be set on the slave.
:''note'': only supported in ettv beta8 and later

===Chat passwords===
In order to curb the rampant abuse of ettv chat, admins may set "chat passwords" on their servers. If enabled, viewers are not allowed to chat unless they have a password. You can define as many passwords as you like, so you can easily track down individual abusers and limit the damage of stolen passwords.

'''ettv_chatpasswords''' (default 0, disabled)
:number of chat passwords defined.
'''ettv_chatpassword'''(1-99999)
:individual chat passwords.

viewers use <tt>/chatpassword <password></tt> to login.

if logged in, ettv chats will be tagged with a number in parentheses identifying which chat password the viewer is using.
===Misc commands for viewers===
;For ettv beta 4 and above
* spectators may <tt>/ignore</tt> and <tt>/unignore</tt> other spectators
* semiadmin functionality now works for slaves
* rcon may now mute/unmute specs

===Connect the slave===
Now start your slave server by running ettv.x86

Tell the slave server to connect up to the master server:
:<tt>tv connect master.ip.address:port ettv_password(required) g_password(if the master has a g_password set)</tt>

If you have configured everything correctly, the slave should connect to the master.
Clients should now be able to connect to the slave and spectate the game in progress.

This is a "live broadcast" with no delay.

===Disconnect the slave===
To tell the slave to disconnect from the master:
:<tt>tv disconnect</tt>

===Slave Chaining===
;something cool goes here

==ETTV Demos==
You may record the match in progress to a file, with the command:
:<tt>record <'''demo name'''></tt>
If you omit the demo name, ettv will start recording using a filename of demoXXXX where XXXX is the first available number starting from 0000.

Demos will stop recording when a map changes.

To stop recording a demo:
:<tt>stoprecord</tt>

To play back a recorded demo:
:<tt>demo <'''demo name'''></tt>

To check the status of an ettv slave:
:<tt>tv status</tt>
This will tell you if the slave is connected to a master, or if it is currently playing back a demo.

To fastforward a demo:
:<tt>ff <seconds></tt>
Eg <tt>ff 30</tt> will fast foward 30 seconds. Fast forward stops at map restarts, so you can safely ff 999 to fast forward through a warmup.
:''note'': requires ettv beta 7 or later

===Autorecording demos===
ettv is able to automatically continuously record demos, creating new demofiles when the map changes. To do this, set the cvar ettv_autorecord to 1. ettv will start recording demos with the name demoXXXX where XXXX is a number starting at 0000 and incrementing on each map change.

Server admins may find it useful to use the demo recording feature of ettv to record matches, instead of requiring individual players to record them. An ettv demo records everything that happens on a server, including all player viewpoints.

===How to create demo based delayed feeds===
Autorecording demos is the first half of the process for delayed feeds. Typically you would run a passworded slave server with the smallest number of sv_maxclients possible. No spectators should connect to this server. The only purpose of this slave is to connect up to the master and record the match to sequentially numbered demofiles.

Now start up a slave, and tell it to broadcast the demo being recorded.

:<tt>demo demo0000</tt>

If you wait approx. 60 seconds after the master begins recording before issuing this command to your slaves, then you have a 60 second delay on your broadcast.

If you want slaves to automatically switch to the next demo when the end of the demo is reached (eg on a map change), you would set the cvar ettv_autoplay to 1. If a slave is playing demo0000 and it reaches the end, it will then try to play demo0001 and so on.

Disadvantage of this method: It is not automated in ettv itself, though admins can script it.
Advantage of this method: You may run multiple broadcast servers from the same single demo stream.

Automated delayed feeds are supported in ettv beta 8. See the above.

==Troubleshooting==

* The slave server must be running the same fs_game setting as the master server.
* The slave server must have a copy of every map pk3 the master server is using.
* If the master server loads a map the slave server doesn't have, the slave will get stuck.
* Spectators will be forced to download any custom pk3 you are using.
* It is a good idea to keep the master server pk3 list to a minimum.
* If you are using the autorecord/autoplay feature for running delayed feeds, you will usually want to make sure you clear out the demos directory first. Autorecording will start numbering demofiles using the first available number, so if you have old recorded demos then ettv might start recording from eg demo0017. If your scripts expect to start playback from demo0000 then you might end up broadcasting a game recorded at some earlier date...

==Miscellaneous==

Slaves may send chats to the master with the command msay
Slaves may list players on the master with the command players

==Performance tuning==

Spectator servers with large numbers of clients (eg >100) will push the OS very hard with huge amounts of UDP traffic. The default OS buffer settings for Linux are inadequate and can hurt performance, causing lag and/or disconnects.

If you get messages like
:<tt>NET_SendPacket ERROR: No buffer space available to 192.168.120.142:27960</tt>

Then you definitely need to increase your kernel network buffers.

Large spectator servers should increase the kernel buffers.

The following commands should be issued as root on linux:
:<tt>echo "524288" > /proc/sys/net/core/rmem_max</tt>
:<tt>echo "524288" > /proc/sys/net/core/wmem_max</tt>

FreeBSD can try this:
:<tt>sysctl -w net.inet.udp.recvspace=65535</tt>
:<tt>sysctl -w net.inet.udp.maxdgram=57344</tt>
:<tt>sysctl -w kern.ipc.maxsockbuf=8388608</tt>

===Network tuning cvars===
;The following are only available in ettv beta 7 and later.
By default, et uses small packets of 1400 bytes or less to send to clients. If messages need to be larger, they are 'fragmented' and sent over several server frames. ettv slave messages tend to be large and often fragment. ettv normally tries to send slaves all fragments at once to avoid jittery playback, but some networks / OSes handle this badly. ettv beta 7 introduces new controls so admins can optimize ettv for their individual network.

'''ettv_netblast''' (default 1)
:by default, ettv tries to send all fragments at once. some networks may handle this badly. setting this to 0 disables. warning: setting this to 0 without increasing ettv_mtu will result in severely laggy slave playback.

'''ettv_mtu''' (default 1400)
:; master only
:if your network / os supports it, you can set this to large values (eg 16000) to prevent message fragmentation and provide smoother ettv links. this cvar has no effect on normal ET clients. note: ettv_mtu must currently be set from commandline, it cannot be changed on the fly (yet).

'''ettv_tv_iptos''' (default 0)
:you can set the ip type of service field of ettv link packets. if your network/ISP supports it, you can use a value like 16 ("minimize delay") to prioritize ettv link packets over others on the network.

'''ettv_sv_iptos''' (default 0)
:same as ettv_tv_iptos, but affects packets for normal ET clients.

[[Category:ETTV]]

Main Page

2005-11-05T18:00:49Z

Bani:

'''Welcome to''' '''[[WolfWiki]]''' 

[[WolfWiki]] is a collaborative site for the ETPro / ETTV / BayonET community. Anyone with a [http://bani.anime.net/banimod/forums/ Banimod Forums] account may edit pages. If you do not have an account, you may [http://bani.anime.net/banimod/forums/profile.php?mode=register apply] for one. Please follow the [[Help:Editing]] guidelines when editing pages. 
<center>There are currently {{NUMBEROFARTICLES}} [[:Special:Allpages|articles available]].</center>

==[[:Category:ETPro|ETPro]]==
{{ETPro_Topics}}
==[[:Category:ETTV|ETTV]]==
[http://bani.anime.net/banimod/forums/viewforum.php?f=18 Discussion Forums] 
[[ETTV:Server Configuration|Server Configuration]] 
[[ETTV:Viewer's Guide|Viewer's Guide]] 

==[[:Category:BayonET|BayonET]]==
[http://bani.anime.net/banimod/forums/viewforum.php?f=10 Discussion Forums]