MORKEye Setup Guide Revision 2.2 Setup Guide Revision 2.2

MORKEye Setup Guide
Revision 2.2
MORKEye – COD2 & COD4 Language Violation Tool
(C) Copyright 2007-2008
2008 by James Booth, Inc. All Rights Reserved.
MORKEye<(o)>® IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTY OF ANY KIND, BUT
NOT LIMITED TO, AND WITHOUT LIMITATION, THAT IT IS FREE OF DEFECTS, FIT FOR A
PARTICULAR PURPOSE, OR THAT IT IS MERCHANTABLE. LICENSOR DOES NOT WARRANT THAT
THE OPERATION OF MORKEYE WILL BE
B UNINTERRUPTED OR ERROR-FREE
FREE OR THAT IT WILL
MEET LICENSEE'S SPECIFIC REQUIREMENTS OR DESIRES. LICENSEE AGREES THAT JAMES
BOOTH SHALL NOT BE LIABLE FOR ANY CLAIM WHATSOEVER INVOLVING MORKEYE IN ANY
WAY. FURTHERMORE, SHOULD ANY VERSION OF MORKEYE, INCLUDING
INCLUDING FUTURE VERSIONS,
PROVE DEFECTIVE IN ANY WAY, LICENSEE ASSUMES THE ENTIRE COST, IF ANY, OF LOSS OR
DAMAGE OF ANY TYPE AND TO ANY DEGREE. THIS WARRANTY DISCLAIMER SHALL SURVIVE
TERMINATION OF THE LICENSE OF MORKEYE BY LICENSEE, REGARDLESS OF WHETHER THE
LICENSE
CENSE IS TERMINATED BY JAMES BOOTH OR LICENSEE.
1
Contents
CONTENTS ..........................................................................................................................................................2
PRE INSTALLATION SERVER SETUP .....................................................................................................................3
MORKEYE INSTALLATION ...................................................................................................................................4
RUNNING MORKEYE ...........................................................................................................................................8
MAIN WINDOW BUTTONS & OPTIONS ...............................................................................................................9
WEB INTERFACE....................................................................................................................................................... 10
NEW MONITOR ....................................................................................................................................................... 11
OPEN MONITOR ...................................................................................................................................................... 13
DELETE MONITOR .................................................................................................................................................... 14
STARTING A MONITOR .....................................................................................................................................15
MONITOR OPTIONS ..........................................................................................................................................17
SERVER .................................................................................................................................................................. 17
EXTERNAL FILES ....................................................................................................................................................... 18
GENERAL OPTIONS ................................................................................................................................................... 18
LANGUAGE VIOLATIONS............................................................................................................................................. 20
WELCOME MESSAGES............................................................................................................................................... 21
CONSOLE ANTI-SPAM ............................................................................................................................................... 21
KEYBOARD BINDS ..................................................................................................................................................... 22
DUPLICATE PLAYER NAMES......................................................................................................................................... 22
LANGUAGE MONITORING DAYS/TIMES (SCHEDULE) ....................................................................................................... 23
WORD LISTS .....................................................................................................................................................24
BAD WORD LIST ...................................................................................................................................................... 24
DICTIONARY (GOOD WORDS LIST) ................................................................................................................................ 24
BINDS FILE SETTINGS ........................................................................................................................................25
SWEARING/RACISM LOGIC ...............................................................................................................................26
TROUBLESHOOTING .........................................................................................................................................27
MORKEYE WILL NOT START. ...................................................................................................................................... 27
MORKEYE WILL NOT CONNECT TO THE SERVER. ............................................................................................................. 27
MORKEYE REPORTS CONSTANT PBUCON FAILURE. ......................................................................................................... 27
MORKEYE FREEZES MY VNC CONNECTION. .................................................................................................................. 27
CAN’T SEE THE WEB INTERFACE ................................................................................................................................... 27
2
Pre Installation Server Setup
1. We need to make sure that PB will accept PBUCON sessions since MORKEye uses
PBUCON to 'listen' to the server.
On the game server... navigate to the Call of Duty PB directory which should look
something like...
C:\Program Files\Activision\Call of Duty - World at War\pb
The minimal configuration for a PB Server to accept PBUCON sessions requires two
things:
1) creating an empty text file in the PB directory named pbucon.use in the
server's home pb folder (file contents does not matter)
2) setting the pb_sv_usessionlimit setting in your pbsv.cfg file to a number
higher than 0 (which is the default).
pb_sv_usessionlimit 1
3) Add MORKEye to the pbsv.cfg file
pb_sv_uconadd 3 "195.238.232.38" "morkeye123" "morkeye123"
This is the default username & password that MORKEye uses...
3
MORKEye Installation
Run (double-click) the setup.exe file...
4
5
6
Above are the files that will be written to the installation folder.
There should also be a shortcut on the Desktop as well as a Start Menu icon.
7
Running MORKEye
To run MORKEye double-click on either the Desktop icon or click on the MORKEye Start Menu
icon.
In order to monitor a game server you need to create a New Monitor.
Clicking on the
button will bring up the New Monitor window.
8
Main Window Buttons & Options
New - Create a new server monitor.
Open - Open an existing server monitor.
Delete - Delete an existing server monitor (including all chat and pbucon archives).
Start All - Starts all monitors at once.
Stop All - Stops all monitors at once.
Reload Word Lists - Tells ALL monitors to reload their respective/common word lists.
Tile - Tiles the monitors windows inside the main window.
Help - Contents and Index - Provides access to this document.
Options - Opens the MORKEye Options window (below)
Online Support - Opens the MORKEye homepage in your default browser
The Options window looks like this.
Most of these options are self explanatory.
Enabling the web interface turns MORKEye into a mini web server which will display the
status of MORKEye anywhere on the web.
9
Web Interface
The web interface is purely passive and cannot be used (at this time) to send commands back
to MORKEye. Simply browse to the IP of the computer running MORKEye and add the port
number specified in the Web Interface Port Number setting of the min MORKEye Options
window.
Ie...
http://195.238.232.38:8080
10
New Monitor
If you are creating a new monitor select the New Server Monitor button and enter a unique
name for the monitor.
If you wish to import the settings from an existing monitor then select the ‘Import XML
Settings’ option.
Note: spaces are not allowed in the monitor name and if used will be converted to underline.
After you click the OK button the monitor settings window will immediately appear.
11
Note: You MUST fill in the Server details before a monitor can be created.
Game Server IP – The IP Address of your game server
Port – The game server port.
Your WAN IP* – The internet IP of the PC/Server running MORKEye
Port** – The ucon port you wish MORKEye to use (any 4 or 5 digit port ie. 8888).
RCON Password
*Note: if you are unsure of your WAN IP simply double-click in the your WAN IP box and
MORKEye will automatically fill in the correct value.
**Note: The ucon port can be any unused port on the host PC/Server. You may need to allow
this port through your firewall.
With the minimum information in place you can click the Save & Activate button and your
monitor will be created.
12
Open Monitor
Run the MORKEye program and click the ‘Open’ button.
MORKEye will present you with a list of previously created monitors. If the ‘Open’ button is
disabled it is because there are no saved monitors and you will have to create one.
At this point you can either double-click on the monitor you want to open, or click the ‘Select
All’ button to select all saved monitors then click the ‘OK’ button.
You should now be left with your selected monitor/s loaded into MORKEye.
13
Delete Monitor
Run the MORKEye program and click the ‘Delete’ button.
MORKEye will present you with a drop-down box of previously created monitors.
Select the monitor you wish to delete then click the ‘OK’ button.
At the confirmation box click ‘Yes’.
14
Starting a Monitor
From here you can re-open the settings window by clicking the Server Settings button and
adjust the various monitor options to suit your needs.
The various monitor options are covered under the Monitor Options section of this
document.
To start the monitor click the Start Monitoring button.
15
The image above shows a successful connection to a game server.
16
Monitor Options
Server
Game Server IP
Port
Your WAN IP*
Port**
RCON Password
–
–
–
–
–
The IP Address of your game server
The game server port.
The internet IP of the PC/Server running MORKEye
The ucon port you wish MORKEye to use (any 4 or 5 digit port ie. 8888).
The RCON password for your server. Double-clicking this box will toggle
between hidden & plain text passwords
17
*Note: if you are unsure of your WAN IP simply double-click in the your WAN IP box and
MORKEye will automatically fill in the correct value.
**Note: The ucon port can be any unused port on the host PC/Server. You may need to allow
this port through your firewall.
External Files
Bad Words List
-
Dictionary
-
This is the file and path path (relative to the MORKEye.exe file) that
holds the list of bad words you want MORKEye to monitor.
This is the file and path path (relative to the MORKEye.exe file) that
holds the list of good words you want MORKEye to ignore.
You can read more about how these files are formatted in the Word Lists section
Binds File
-
This is the file and path path (relative to the MORKEye.exe file) that
holds the list of key binds you want MORKEye to monitor.
You can read more about how this file is formatted in the
Dictionary (good words list)
The dictionary.dic file is a list of approximately 20,200 common English words. It is used by
MORKEye to remove ambiguities in it’s swear detection logic. If a word is flagged by
MORKEye as bad but it is actually an acceptable word then you can add that word to this file
and MORKEye will ignore it in the future.
Binds File Settings section of this document.
Note: ALL the above files by default are located in the MORKEye directory. If you want a
different file for each monitor then simply place the file in to the relevant monitor directory
and edit it as required then put it’s path (relative to the MORKEye.exe file) in the relevant box
{monitor folder}\{file name}
->
COD5_Monitor\badwords.txt
General Options
log Tick
Ticking this box will write the “.” Ticks you see in the chat window to the chat log file. Unticking this box can save a lot of log space on busy servers.
log Chat
Ticking this box will write what players say in the chat window to the chat log file.
log Welcome
18
Ticking this box will write the welcome messages to the chat log file.
log Connecting
Ticking this box will log any players connecting to the server into the chat log file.
log Disconnecting
Ticking this box will log any players disconnecting from the server into the chat log file.
log NewRound
Ticking this box will write a ‘New Round’ message to the chat log file when the server starts a
new round.
log Warnings To Kick Log
Ticking this box will log any player warning messages issued by MORKEye to the chat log file.
show Kick Message
Ticking this box will display any ‘player kicked’ messages issued by MORKEye to the chat
window.
AutoStart Delay
I MORKEye is configured to autostart certain monitors then this is the delay applied when this
monitor is auto-atarted.
auto Update Your IP
Ticking this box will cause a monitor to check for and use the correct WAN IP each time it is
loaded into MORKEye. This is particularly useful for people running MORKEye from their
home PC and who do not have a fixed IP address from their ISP.
enable Tips
Ticking this box will enable tool tips such that if you hover your mouse over any control in
MORKEye a small window will popup telling what that control is and does.
highlight Violations In Chat
Ticking this box will cause any language violations detected by MORKEye to be highlighted in
the chat window.
enable Kick Log Analyzer
Ticking this box will enable the use of the Kick Log Analyzer. Un-ticking this box will mean the
kick log will be opened in Notepad.
Keep PBUcon Log Archive
Ticking this box allows MORKEye to archive the current pbucon.log. Archiving takes place
between midnight & 6AM
Enable Web Date
If ticked this will allow MORKEye’s built in web server to display this monitor. See the Web
Interface section for more details.
19
enable Diagnostic Logging
Ticking this box will place MORKEye into a diagnostic mode. This means that MORKEye will
display detailed information of what it’s thinking/doing within the chat window and chat log.
WARNING: This may cause MORKEye place a heavier load on the CPU (may cause lag).
This option should be left OFF AT ALL TIMES unless directed to enable by the developer.
20
Language Violations
Warn for lang violation
Ticking this box will cause MORKEye to issue an in-game warning for a language violation.
Kick for lang violation
Ticking this box will cause MORKEye to issue a Punkbuster kick for a language violation.
max Warnings
This value denotes the maximum number of warnings a player will receive for language
violations before they are kicked.
Note: Minimum is 1 and Maximum is 5
warning Sound
Every time a player is issued an in-game warning MORKEye will play (locally not in-game) this
sound file. The sound must be a ‘.wav’ file. This sound file normally lives in the same directory
as MORKEye. If you are running multiple monitors and wish to use different warning sound
for each monitor then simply type the relative path.
i.e. if you had a server called ‘Hardcore’ and you wanted that server to use it’s own
warning.wav sound then you could place the sound file into the hardcore directory and enter
“/hardcore/warning.wav” into the warning Sound text box.
warning Message
This is the message that the player will see in-game if he is issued a warning by MORKEye. If
you wish to display the players name in the message then enter “%P%” at the position in the
message you want the name to appear. i.e. if a warning was being issued against a player
called ‘[TaG]Justin’ you could use the message ‘Warning %P% For Bad Language’ and the ingame message would say ‘Warning [TaG]Justin For Bad Language.
Kick Severity <1>
This is the kick duration should a player is kicked for typing a ‘Severity 1’ bad word. For more
information on the severity system see MORKEye’s Severity System.
Note: Minimum is 1 and Maximum is Unlimited
kick Sound
Every time a player is issued an in-game kick MORKEye will play (locally not in-game) this
sound file. The sound must be a ‘.wav’ file. This sound file normally lives in the same directory
as MORKEye. If you are running multiple monitors and wish to use different kick sound for
each monitor then simply type the relative path.
i.e. if you had a server called ‘Hardcore’ and you wanted that server to use it’s own kick.wav
sound then you could place the sound file into the hardcore directory and enter
“/hardcore/kick.wav” into the kick Sound text box.
Kick Severity <2>
This is the kick duration should a player is kicked for typing a ‘Severity 2’ bad word. For more
information on the severity system see MORKEye’s Severity System.
Note: Minimum is 1 and Maximum is Unlimited
21
kick Message
This is the message that the player will see in-game if he is issued a kick by MORKEye. If you
wish to display the players name in the message then enter “%P%” at the position in the
message you want the name to appear.
i.e. if a kick was being issued against a player called ‘[TaG]Justin’ you could use the message
‘Kicking %P% For Bad Language’ and the in-game message would say ‘Kicking [TaG]Justin For
Bad Language.
Welcome Messages
show Welcome Message
Ticking this box will cause MORKEye to issue a welcome message that the player will see ingame to welcome him to the server. If un-ticked no welcome message will be sent by
MORKEye.
Delay (seconds)
This is the delay period (in seconds) between MORKEye seeing the player join the server and
MORKEye issuing the welcome message.
Note: Minimum is 1 and Maximum is 60
welcome Message
This is the message that the player will see in-game to welcome him to the server. If you wish
to display the players name in the message then enter “%P%” at the position in the message
you want the name to appear.
i.e. if a welcome message was being issued to a player called ‘[TaG]Justin’ you could use the
message ‘Welcome %P% To The Server’ and the in-game message would say ‘Welcome
[TaG]Justin To The Server.
Console Anti-Spam
Warn for Spam violation
Ticking this box will cause MORKEye to issue an in-game warning for a spam violation.
Kick for Spam violation
Ticking this box will cause MORKEye to issue a Punkbuster kick for a spam violation.
Note: If both warn and kick are ticked then MORKEye will issue a single warning before
kicking.
The logic for determining a spam violation is: Spam = {x} messages in {y} seconds.
warning Message
This is the message that the player will see in-game if he is issued a spam violation warning by
MORKEye. If you wish to display the players name in the message then enter “%P%” at the
position in the message you want the name to appear.
22
i.e. if a warning was being issued against a player called ‘[TaG]Justin’ you could use the
message ‘Warning %P% For Spamming The Console’ and the in-game message would say
‘Warning [TaG]Justin For Spamming The Console’.
kick Message
This is the message that the player will see in-game if he is issued a kick by MORKEye. If you
wish to display the players name in the message then enter “%P%” at the position in the
message you want the name to appear.
i.e. if a kick was being issued against a player called ‘[TaG]Justin’ you could use the message
‘Kicking %P% For Spamming The Console’ and the in-game message would say ‘Kicking
[TaG]Justin For Spamming The Console.
Keyboard Binds
warn
Ticking this box will cause MORKEye to issue an in-game warning for a bind violation.
kick
Ticking this box will cause MORKEye to issue a Punkbuster kick for a bind violation.
warn Message Delay (seconds)
This is the delay period (in seconds) between MORKEye seeing the bind violation and
MORKEye issuing the bind warning message.
Note: Minimum is 1 and Maximum is 30
max Warnings Before Kick
This value denotes the maximum number of warnings a player will receive for bind violations
before they are kicked.
View Binds File
Clicking this button will open your binds.txt file in notepad for you to view & amend as
necessary.
Note: If you add or remove binds from this file you will need to click the ‘Reload Words &
Binds’ button on your monitor in order to load the changes. This can be done while the
monitor is running/monitoring.
Duplicate Player names
These settings are ONLY useful in COD, COD:UO, COD2 & COD4
Log Duplicate Names
Ticking this box will cause MORKEye to monitor for, and log any duplicate player names it
detects.
Kick For Duplicate Player Names
Ticking this box will cause MORKEye to kick the latest player to join where that players name
is the same as one already on the server.
23
Language Monitoring Days/Times (Schedule)
This is a simple 24/7 scheduling function that allows the language monitoring portion of
MORKEye to be ‘switched off’ during certain hours. For example you may allow bad language
after 10pm through till 5am.
To do this simply click on each schedule square to toggle between red & blue. During those
periods indicated by red squares MORKEye will ignore the language monitor settings.
MORKEye will however still monitor & record all chat.
There is an option to allow MORKEye to instantly kick for really foul and racist language
during the red periods. To read on how to do this see the Word Lists portion of this
document.
24
Word Lists
There are two word lists that MORKEye uses.... banWords.txt and dictionary.dic
Bad Word List
The banWords.txt file contains all the bad words you want to check for including what action
to take if any are detected.
The dictionary.dic file is a list of standard English words that MORKEye will cross reference
against if it thinks a word is bad but not in the badWords.txt file to help determine if it’s good
or bad.
Ie... someone types into the game console the word Scunthorpe (which is a town in the UK)...
morkeye will see the word cunt in Scunthorpe. Now MORKEye knows cunt is a bad word but
it’s determined it’s part of another word so MORKEye will check the dictionary.dic file. If
Scunthorpe is in the dictionary then MORKEye will not flag the word, however if it’s not in the
dictionary then MORKEye will flag it as a bad word and take action.
Words are listed in the banWords.txt file with a severity rating...
Words preceded by <0> are words that players will only ever be warned for.
Words preceded by <1> are words that players can be warned for.
Words preceded by <2> are words that players may be instantly kicked for.
MORKEye includes a ‘schedule’ option where between certain hours bad language is
allowed... see the Language Monitoring Days/Times (Schedule) section of this document.
Words preceded by <3> are words that players may be instantly kicked for during those
periods (red) in which MORKEye is scheduled to not monitor chat. This setting is reserved for
those words that you cannot tolerate under ANY circumstance or at ANY time.
Note: Each word in the banWords.txt file must appear on a new line and there must be no
empty lines at the end of the document.
MORKEye also attempt to compensate for 1337 (leet) speak as well as numerous other missspellings.
Dictionary (good words list)
The dictionary.dic file is a list of approximately 20,200 common English words. It is used by
MORKEye to remove ambiguities in it’s swear detection logic. If a word is flagged by
MORKEye as bad but it is actually an acceptable word then you can add that word to this file
and MORKEye will ignore it in the future.
25
Binds File Settings
The binds.txt file lives in the MORKEye.exe program directory.
The content of the binds.txt file looks like...
//Please use the following self-explanatory system to enter binds
//
//<"KEY"><"TERM"><"MESSAGE DISPLAYED IN-GAME">
//
//using "KEY_ANY" within the <"KEY"> expression will flag any player
//that has any key/button bound to the <"TERM"> expression.
//
//Place your binds directly below this line.
//****************************************************************
<"KEY_ANY"><"vstr"><"^1OI!!! %P% ^1Binding any key to run 'vstr'
scripts on this server is forbidden.">
<"KEY_ANY"><"exec"><"^1OI!!! %P% ^1Binding any key to execute scripts
using 'exec' on this server is forbidden.">
<"KEY_MWHEELUP"><"+attack"><"^1OI!!! %P% ^1Binding the fire button to
the mousewheel on this server is forbidden.">
<"KEY_MWHEELDOWN"><"+attack"><"^1OI!!! %P% ^1Binding the fire button
to the mousewheel on this server is forbidden.">
26
Swearing/Racism Logic
warn kick severity action
------------------------------Y
0
warn
Y
1
warn
Y
2
warn
Y
Y
0
warn
Y
Y
1
warn/kick
Y
Y
2
kick
Y
0
kick
Y
1
kick
Y
2
kick
Severity 3 works exactly like severity 2 except MORKEye will
still take action on detecting severity 3 words during those
periods when MORKEye is scheduled to NOT monitor chat.
See the Language Monitoring Days/Times (Schedule) section of
this document for more details on schedules.
27
Troubleshooting
MORKEye will not start.
1. MORKEye will only run on W2000, W2K3, W2K8, XP & Vista (x32 & x64)
2. Ensure you have the latest .Net version installed on the PC.
3. Ensure you have all the Microsoft updates installed for your OS.
One of the first things to do when diagnosing problems with MORKEye is to go into the
monitor options and enable diagnostic mode as this will provide a great deal of feedback on
what the program is doing.
MORKEye will not connect to the server.
1. Make sure you have the correct rcon password in the monitor settings.
2. Make sure you have a pbucon.use file in the pb directory of your game server.
3. Make sure any firewalls between MORKEye and the server are set to allow the pbucon
port (you specified in the monitor settings).
MORKEye reports constant pbucon failure.
1. Make sure you have a pbucon.use file in the pb directory of your game server.
2. Make sure there is a good solid connection between MORKEye and the game server as
this can often be a problem when running MORKEye from a home/remote PC.
MORKEye freezes my VNC connection.
1. There no known fix at this time.
Can’t see the web interface
1. Ensure you have a tick in the Enable Web Interface setting of the main MORKEye
program. See the Main Window Buttons & Options portion of this document.
If none of the above helps then you can contact me via the forum at
http://www.morkeye.co.uk
28