/ScriptServ

nOthello v1.0b by Nabiki^sKnight

The latest version can be found at NK's Corner:

	http://www.geocities.com/Tokyo/Flats/3498

* Note that Ranma½ and characters (Nabiki and Ranma-chan) from Ranma½ and their pictures are copyright of Takahashi Rumiko and Shogakukan-Kitty-Fuji TV.

Ranma½ is a good anime so go watch it!  Q:)


CONTENTS:

INTRODUCTION
FILES
HOW TO START
RULES OF OTHELLO
HOW TO USE
HOW TO UNINSTALL
NOTES
TECHNICAL NOTES
HISTORY
KNOWN ISSUES

=====

INTRODUCTION:

nOthello is short for NK's Othello... or Nabiki^sKnight's Othello. Yeah, not a very exciting name, but better than the X's I put on my other scripts. Heck, think of the n as standing for Net then. Anyways, this is a two-player board game that can be played by people on the same computer, through DCC connection, socket connection or simply an IRC server connection. You can also change the way the board and pieces look.

=====

FILES:

nothello.ini	The main script.
nothello.doc	The help document file in DOC format.
nothello.txt	The help document file in TXT format.

Bitmaps:
BGCross.bmp	An 8x8 background bitmap.
BGDiag.bmp	An 8x8 background bitmap.
BGDot.bmp	An 8x8 background bitmap.
BGRand.bmp	An 8x8 background bitmap.
BGSSqr.bmp	An 8x8 background bitmap.
BGTriang.bmp	An 8x8 background bitmap.
Pieces.bmp	A bitmap file of 18 different 31x31 squares as examples.
Win.bmp	The bitmap file used when someone wins. You can replace it with your own if you want. The size should be 19x18 but nOthello would fit it to that size if the bitmap is larger or smaller.


Nabiki.bmp	A bitmap file of Nabiki from the anime Ranma½ by Takahashi Rumiko. (Ever wonder who the Nabiki in Nabiki^sKnight refers to?) This can be used as a disc or a background bitmap. I spent a lot of time editing it so a transparent disc would work properly.
Ranma.bmp	A bitmap file of Ranma-chan from the anime Ranma½ by Takahashi Rumiko. This can be used as a disc or a background bitmap. I spent a lot of time editing it so a transparent disc would work properly.

* Note that Ranma½ and characters (Nabiki and Ranma-chan) from Ranma½ and their pictures are copyright of Takahashi Rumiko and Shogakukan-Kitty-Fuji TV.

Note that the only bitmap required is Win.bmp.

=====

HOW TO START:

Simply put all the files into one directory and load nothello.ini into your remote events (replace c:\nothello with your path):

	/load -rs c:\nothello\nothello.ini

Allow the initialization commands to run. This will load nothello.ini and nothell2.ini to the alias section, create the nko.ini file (theme storage file) if it does not already exist and turn on the internal address list (IAL), which is helpful if you use the Socket mode. Type /IAL off to turn it off.

=====

RULES OF OTHELLO:

Othello is a two-player game, each player a different color. The object is to have more discs of your color on the board at the end of the game.

Rules are simple. Each player takes turn placing a disc of his/her own color. A move is only valid if there is at least one of the opponent's color beside it. The player acquires every opponent disc between the disc played and a previously played disc of his/her color. The game ends when no more moves are possible, and whoever has the most discs wins!

=====

HOW TO USE:

To open the @nOthello window, use the Board command in the menubar (under nOthello) or the @nOthello-Info window, or type:

	/nOthello

The titlebar of the @nOthello window shows the current mode (Non-Net, DCC, Socket or Query). Note that you cannot change the size of the @nOthello window.

To open the @nOthello-Info window, use the Info command in the menubar (under nOthello) or the @nOthello window, or type:

	/NKOInfo

This window is where most messages are displayed and where options can be changed.

Both the @nOthello and @nOthello-Info windows have an editbox. Any text entered here is sent to all host/player/spectators in the players list unless the text is prefixed by a /, in which case, it is assumed to be a command. Note that identifiers and variables are not evaluated when entering commands in the editboxes.

The @nOthello window position and @nOthello-Info window size and position are saved when the respective window is closed.

You can find out another person's nOthello version by typing (replacing Nabiki^sKnight with the target's nick):

	/CTCP Nabiki^sKnight .nOthello


The Game:

Double-click on the square where you want to place your disc. The current turn is indicated by an arrow on the right side of the board. The move is displayed after a player places his/her disc. The letter refers to the horizontal coordinates from left to right, and the number refers to the vertical coordinates from top to bottom. Therefore, A2 would be one square down from the top left corner square.

Pop-Up Commands:

nOthello adds the commands nOthello|Board and nOthello|Info to the Menubar pop-up that can be used to open the two windows @nOthello and @nOthello-Info respectively.


@nOthello Commands:

During a game, just double-click where you want to place your disc. If you double-click outside the board, the RGB code of where you clicked is shown in the @nOthello-Info window. If you double-click on the discs on the right of the board, you can change the BMP file assigned to the selected side's disc.

The @nOthello pop-up menu is dynamic. Only relevant commands are shown.

* Info
This opens the nOthello-Info window, where messages are displayed and options are changed.

* Game
	* Restart
	This only appears if you are in Non-Net mode or if you are the host of a net game. The player cannot restart if in net-play mode.

	* Refresh
	This refreshes the board. If you are a player and got disconnected from your host, use this to refresh info from the host.

* Scan
This scans the board and shows all moves currently allowed.

* Midi

	* Play
	This command appears if you have a midi set in your options and if the midi is not playing. It plays the midi in repeat mode.

	* Stop
	This command appears if you have a midi set in your options and if the midi is currently playing. The command stops the midi.

	* Change
	This changes the midi you want to play. If the previously set midi is currently playing, the new midi will automatically start playing.

* Mode
There are four modes. Non-Net mode is played locally on the same computer. The other three modes are played across the internet:

	* DCC
	This is probably the fastest mode. However, you must have DCC chat windows opened to all players/spectators if you are the host. If you are the player, you only need a DCC chat window opened to the host.

	* Query
	This is the simplest but slowest mode. All commands/messages have to go through the IRC server.

	* Socket
	This mode does not need any extra windows. However, you cannot use the Names|Host command to change host on the fly.

When changing to a net-play mode, you are asked the host nickname.

If you are a player and are changing to Socket mode, you need the host IP. nOthello first checks the internal address list (IAL) for the IP. If it can't be found or if the IAL is not on, you must manually enter the host IP. nOthello will automatically perform a /whois command if you are connected to an IRC server, and then display the IP in the @nOthello editbox when the server replies.

If you are the host, you will have to enter the player's and spectators' names. You are also asked whether to turn listening on if you are changing to Socket mode. You must be listening to the same port as the players are trying to connect to.

The game is only played between the host and the player. The spectators only watch the game progress.

When mode is changed from a net-play mode, a prompt appears to ask for confirmation. Mode can be changed during a game.

Note that both player and host must be using the same mode.

* Names
These command are only available if you are the host and in a net-play mode.

	* Switch
	This switches the two players' sides and therefore, turns. You can do this anytime before or during a game.

	* Add
	This adds more spectators.

	* Delete
	This deletes selected spectators. Players cannot be deleted. If you want to delete the player, set one of the spectators as the new player first.

	* Host
	This changes the host to the selected nickname. Note that you lose host status immediately and will no longer have access to host commands.

	* Player
	This changes the player to the selected nickname.

* Connect
This command is only available if you are in a net-play mode. In DCC mode, this opens a chat window with all players (only available for host) or to only the host (only available for player). In Query mode, this connects you to an IRC server if not connected already. In Socket mode, this connects you to the host (only available for the player/spectators).

* Sockets
These commands are only available if you're in Socket mode.

	* Show
	This shows all current nOthello socket connections.

	* Listen
	This toggles listening to the set port (only available on host).

	* Disconnect
	This disconnects you from the selected player/spectators if you are the host, or disconnects you from the host if you are a player or spectator.

* Look
This shows the selected name in the listbox in case it is too long for the listbox width. Clicking on it will open a query window to the nickname.


@nOthello-Info Commands:

Double-click on a listbox item to change it. Double-click on the window itself to clear the buffer, and if the buffer is already cleared, to quickly close the window.

* Board
This opens the @nOthello window, where the game is played.

* Buffer

	* Save
	This saves the @nOthello-Info buffer to a file. The path and filename cannot have spaces.

	* View
	This views a saved buffer or any other text file.

* Theme
A theme refers to a saved set of the display options: the BMP files and colors for the Players 1 (P1) and 2 (P2) and the background (BG), the grid and text colors, the midi file, and whether the Text Area Fill option is on.

	* Show
	This shows all saved themes in windows (10 themes in each window). Double-click or close @nOthello-Thm1 to close all of the theme display windows.

	* Load
	This loads a saved theme.

	* Save
	This saves the current settings as a theme. Name it whatever you want.

	* Delete
	This deletes a saved theme.

	* BMP
	This shows a BMP file in how it would be split into 31x31 areas for the Players 1 and 2 disc bitmaps.

* Help
This takes you to the nOthello homepage (NK's Corner) or opens the help file.

* Clear
This clears the @nOthello-Info buffer.

* Look
This shows the selected option's setting in case it is too long for the listbox width. Clicking on it will change the option.

Options:

These are in the listbox of the @nOthello-Info window.

* Bitmaps
nOthello can use bitmaps for the discs and background.

* P1 or P2
This is the bitmap for Player 1 or 2. Select the BMP file to use, then enter F to use the entire bitmap and fit it to 31x31 when using it, or enter the coordinates of the 31x31 square you want to use. You can also create your own bitmaps for this. Included is an example of a bitmap designed for the use of coordinates: pieces.bmp.

* P1T or P2T
This command is only available if a bitmap is set for P1 or P2. It changes the transparent color of the Player 1 or 2 bitmap. The current bitmap is shown tiled in a window. Just double-click on the color that you want to be transparent or double-click on the white text area for none. Close the window when you're done.

* BG
This sets the bitmap for the background. You can have it displayed normally, tiled in the window, tiled in the board, fit to the window or fit to the board.

* BGArea
This command only appears if a bitmap is set for the BG. It refers to the area of the bitmap file that you want to use for the background. A window opens displaying the entire bitmap (in a smaller form if it is bigger than your screen size). Double-click on the two diagonally opposite corners of the area you want. Double-click on the white text area if you want to use the full bitmap. Close the window when you're done.

* TextAreaFill
This toggles whether the text area is filled by the background bitmap or just displayed against the background color.

* Colors
The options here change the colors of the Player 1 disc (P1), Player 2 disc (P2), background (BG), grid and text.

Just enter the word of the color (White, Black, Blue, Green, Red, Brown, Purple, Orange, Yellow, LightGreen, Cyan, LightCyan, LightBlue, Pink, Grey or LightGrey) or, if you want a different color, the RGB code (eg. 0,0,0 for black).

Note that the P1 and P2 colors will not matter if you are using a bitmap for them. For BG, the color will only matter if you are not using a bitmap or if you are using a bitmap but have the TextAreaFill option off.

* Others

* MidiFile
This is the currently set midi file.

* TurnBeep
This toggles whether a beep is sounded after a player makes a move. Default is on.

* Port
This changes the port number for Socket mode. Default is 5000.

* ScanLevel
This changes when nOthello will scan to see if there are any more possible moves. The range is 4 to 64 and refers to the number of discs on the board before scanning. Therefore, enter a higher number if you don't want the scanning done until later in the game. This may help slightly if you find processing too slow. Default is 16.


=====

HOW TO UNINSTALL:

Just use the Unload command in the @nOthello-Info popup.

=====

NOTES:

Please do not alter the script or include in other scripts without permission from the author.
Distribute freely. Do not charge for it please.
And of course, I'm not responsible for any damage this script may cause to your softwares, hardwares or health.

Send comments/suggestions/bug reports to Nabiki^sKnight at renren@sprint.ca

* Ranma½ and characters (Nabiki and Ranma-chan) from Ranma½ and their pictures are copyright of Takahashi Rumiko and Shogakukan-Kitty-Fuji TV.

Script by: Nabiki^sKnight
Date: February 14, 1998

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=
Nabiki's Castle (http://www.geocities.com/Tokyo/8434)
NK's Corner (http://www.geocities.com/Tokyo/Flats/3498)
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=

=====

TECHNICAL NOTES:

* Specifications:

For use with mIRC v5.3 or 5.31. Later versions of mIRC may or may not work.

The following are permanent (or semi-permanent) variables:

%nko		%nkobmp		%nkoocc1	%nkoocc2
%nkoturn		%nkopoptog	%nkoplayer

The %nko variable:

1	P1 color
2	P2 color
3	BG color
4	Grid color
5	Text color
6	TextAreaFill on/off
7	Mode (Non-Net [0], DCC [1], Query [2], Socket [3])
8	@nOthello window position
9	@nOthello-Info window size and position
10	Scan Level
11	Port
12	Turn beep on/off

The %nkobmp variable:

1	P1 bitmap
2	P2 bitmap
3	P1 transparent color
4	P2 transparent color
5	BG bitmap
6	BG type (Normal [1], Fit to Window [2], Fit to Board [3], Tile in Window [4], Tile in Board [5])
7	Midi file

The %nkopoptog variable:

1	Bitmaps Options collapsed/uncollapsed
2	Colors Options collapsed/uncollapsed
3	Other Options collapsed/uncollapsed

=====

HISTORY:

v1.0b	February 14, 1998
	Fixed bug of text not clearing when the TextAreaFill option is on.

v1.0a	February 7, 1998
	Fixed bug with Theme|Show showing the discs bitmaps as normal size without fitting to 30x30.
	Fixed bug of not showing midi in Theme|Show.
	nOthello now creates the theme file if it does not already exist.
	Now included are four themes: Default, Popping Discs, Nabiki Board and Ranma1/2 Discs.
	Added TXT format of document.

v1.0	February 7, 1998
	First released version.

Began Script	January 29, 1997

=====

KNOWN ISSUES:

1) If you find processing slow, try using less bitmaps and try changing the Scan Level to a higher value.