OekakiPoteto 5.x User's Manual

Site hosted by Angelfire.com: Build your free website today!

OekakiPoteto 5.x Documentation
OekakiPoteto copyright (c) Theo Chakkapark and Marcello Bastea-Forte 2001-2002.
OekakiBBS paint applet is copyright (c) Poo
PaintBBS paint applet is copyright (c) Shi-cyan

Support Forums
http://www.suteki.nu/community

Homepage
http://www.suteki.nu

Lead Developer
Theo Chakkapark (RanmaGuy)

OekakiBBS / PaintBBS Parser / Hack Developer
Marcello Bastea-Forte

Contributors
Travis Skares
Uriel

Special Thanks
Filb for his BIG help in pointing out to me language pack mis-translations and providing a german language pack for OekakiPoteto
MYMINT for producing a korean language pack

Donors
Big thanks to you donors! Without your generious donations, 5.x would have never seen daylight! More porn for RanmaGuy! Yay!

Mixel
Jennifer Magee
Uriel
Lourdes T Huibonhoa
C. Brock

Please continue to donate if you like my work and enjoy using OekakiPoteto!

Table of Contents

I. Installation

- Things to note
- Requirements
- Install Support
- Determining if you are a newbie
- Installing OekakiPoteto for non newbies

II. Newbie Guide

- I've determined I'm a newbie. Now what?
- I don't have a website or know where to get one.
- What is a CHMOD?
- Your best friend: the command line FTP

III. Free Site Guide

- Installing OekakiPoteto on tripod.lycos.co.uk

IV. Installing Multiple Boards

- Member sharing configuration
- Non-member sharing configuration

V. Using OekakiPoteto

- Adding members
- Giving permissions
- Adjusting OP for your language
- Translating OekakiPoteto

VI. Miscellaneous / Support

- mail() errors
- language errors when upgrading
- unable to delete pictures or your picture directory (version 4.x)

Installation

Things to note

You must know that when OekakiPoteto is installed, because it is graphically intensive, be aware that your server can experience the following:

Heavy disk usage (even more heavier disk usage with JPG compression enabled)
Heavy bandwidth traffic depending on the popularity of your OekakiPoteto board (you can enable JPG compression to reduce this, but be aware of the first note regarding heavy disk usage)

The developers hold no responsibility if your site goes over its monthly disk or bandwidth usage, and you are charged zillions of dollars, rupees, pounds, etc. because of overusage.

Most sites should be okay with using OekakiPoteto. A board with a few visitors should experience around .5 - 1 GB of bandwith a month.

Requirements

The following is reqiured:

UNIX or Windows NT server
PHP version 4.1 or higher
CHMOD support (UNIX) or read/write/execute permissions (Windows NT)
mySQL account

The following is optional:

If you plan on using JPEG compression, you will need GD 2.0.1 or higher to generate true color images; anything lower than 2.0.1 will result in 256 color JPEGs. JPEG support must also be enabled in GD.

Install Support

Unlike previous versions of OekakiPoteto, RanmaGuy no longer provides free OekakiPoteto board installations. Why? Too many stupid people out there who do not know how to follow directions (mainly providing FTP/mySQL details), or knowing if their server can support an OekakiPoteto (paste in the requirements above into an e-mail, and send it to your tech support!). Also, RanmaGuy does not want to do installs anymore unless he has to. Since RanmaGuy is a greedy bastard who needs alittle cash (after all, OekakiPoteto IS free), he has provided the following option below:

If you feel that after reading the newbie guide, you still cannot install OekakiPoteto, or you just want to be a nice person and contribute some of your funds to encourage the development of OekakiPoteto, and you have the requirements stated above, you can ask RanmaGuy to install OekakiPoteto for a $10.00 fee. You will need to have the following:

FTP address
FTP username and password
mySQL database name, username and password

Conditions for using this service:

Make sure you have the items above. Do not e-mail RanmaGuy to fetch it for you.
Get a PayPal account, go to suteki.nu, click on donate, and make a $10.00 "donation".
E-mail RanmaGuy at ranmaguy@suteki.nu with the details above (all details are kept confidential, and will only be used solely to install OekakiPoteto; RanmaGuy has performed over 20 OekakiPoteto installations in the past, so you can guarantee your information will not be leaked), along with the name you used to make the $10.00 payment.
Your payment will not be processed until RanmaGuy installs your OekakiPoteto, and can verify that OekakiPoteto can at least post pictures, and has working e-mail functionality. If one of these do not work, the payer will be notified with the option for a refund. If a refund is issued, the OekakiPoteto files will be removed from the site.
This service ONLY includes install support. If you have a question on the functionality of your board, or error messages that the board may generate, use the OekakiPoteto mailing list.
This fee only covers ONE board install.

Determining if you are a newbie

You are considered a newbie if..

You do not know what an FTP client is.
You do not know how to create directories.
You do not know how to CHMOD files / directories.
You do not know how to switch between ASCII / Binary modes on your FTP.
You do not have a website and you still think you can install OekakiPoteto.

... then you need the Newbie Guide.

If you are using a free site such as lycos, you might want to try the Free Site Guide, but if you still do not know the above, you should try the Newbie guide for fun.

Installing OekakiPoteto for non newbies

Step 1

Make sure you have the requirements along with the following information before you proceed:

FTP address
FTP username and password
mySQL database name, username, and password

If you do not know any of the following, please e-mail your webhost for the information and if your web hosting plan meets the requrements to install OekakiPoteto. If you have all the required information, then proceed to step 2:

These blue boxes will give you a visualization of an example file structure. This shall be called the 'default' install configuation.

Step 2

Create a directory you want to install OekakiPoteto in. CHMOD this to 777.

/oekaki CHMOD 777

Example: The oekaki directory is created as the directory to install OekakiPoteto in.

Step 3

Upload the following files in ASCII mode to the OekakiPoteto directory and CHMOD them to 666.

announce.php
hosts.txt
ips.txt
notice.php

/oekaki CHMOD 777 |- announce.php ASCII CHMOD 666 |- hosts.txt ASCII CHMOD 666 |- ips.txt ASCII CHMOD 666 |- notice.php ASCII CHMOD 666

Step 4

Transfer the following files to the OekakiPoteto directory in Binary mode:

button.gif
MgLine.zip
oekakibbs.jar
PaintBBS.jar
PCHViewer.jar
pr0n.png

Step 5

Transfer all the PHP files in ASCII mode to the OekakiPoteto directory.

Step 6

In the OekakiPoteto directory, create a directory called templates. CHMOD this directory to 777, and upload all the files in the /template directory in ASCII to the templates directory you created.

Step 7

In the OekakiPoteto directory, create a directory to store your pictures. CHMOD this directory to 777.

Example: The pictures directory is created in the oekaki directory to store pictures.

Step 8

In the OekakiPoteto directory, create a directory called langauge, and upload all the files in the /language directory in ASCII mode.

Step 9

Go to http://www.yourwebsite.com/yourOekakiPotetoDirectory/install.php and use the information gathered in Step 1 to fill out the required fields. At the bottom of the page, fill in the login name and password you will use. This will be your owner account. After the install has completed, delete install.php. If you have screwed up, and want to remove the database, there is a link at the bottom of the install.php page.

You can now start using your OekakiPoteto!

Newbie Guide

I've determined I'm a newbie. Now what?

If you've read the determining if you are a newbie section, and you've determed you are a newbie, the best thing to do is learn the command line FTP. No, not the Microsoft Internet Explorer FTP; that's like having someone use a powerful calculator to solve a difficult problem, but not know the mechanics of how the problem is actually solved by hand.

I don't have a website or know where to get one.

Try using the free site guide.

What is a CHMOD?

CHMOD is actually a verb. You pronounce it "Shmod;" it's one syllable and rhymes with "clod." You know, a clod is a guy like you who actually wants to know what a CHMOD is.

All non-seriousness aside, CHMOD is a way of modifying a file's permissions. You as a newbie, will probably not need to know more than this fact, other than just knowing how to use the command, which will be taught in the tutorial.

Your best friend: the command line FTP

Step 1

Make sure you have the requirements along with the following information before you proceed:

FTP address
FTP username and password
mySQL database name, username and password

These panzy pink boxes will give you a visualization of what you will probably see in the FTP command line interface.

The tutorial assumes you are using Microsoft Windows. If you are using Linux, it's assumed you know how to access your FTP client. Commands for the Linux and Windows FTP clients are the same for the tutorial.

Step 2

Start up your FTP client.

Start > run > and type in ftp

You should now see the FTP prompt:

ftp>

Step 3

Connect to your FTP.

open yourftpaddress.com

Replace yourftpaddress.com with the address to your ftp.

ftp> open abcd.com

Connected to abcd.com. 220 ProFTPD 1.2.2rc1 Server (ProFTPD) [192.168.0.2] 500 AUTH not understood. KERBEROS_V4 rejected as an authentication type Name (abcd.com:ranmaguy):

The output above may differ depending on your server.

Step 4

Type in your ftp username.

ftp> open abcd.com

Step 5

Type in your FTP password. You will not be able to see what you type for security reasons. You will know you've sucessfully logged in if you get the message or something similiar:

230 User [your username] logged in.

ftp> open abcd.com

Step 6

Here's where the real tutorial begins. It might get a bit tricky. Let me introduce to you some commands you will/might be using.

help - Shows the available commands. Typing help <a command> will give a description of the command. Example: help ls
open - Opens a connection to an FTP server. Example: open abcd.com
ls - List Structure. Equivilent to the windows dir command. Lists the directories and files on the server.
cd - Change Directory. Changes the current directory on the server.
lcd - Change Local Directory. Changes the directory on your computer.
chmod - CHMODs a file. Be careful with this one. All values are in octal, so if you wanted to chmod a directory or file, it must be chmod 0xxx where xxx is the chmod value (such as 777), like chmod 0777 ips.txt
ascii - Changes the transfer mode to ASCII.
binary - Changes the transfer mode to binary.
mkdir - Creates a directory on the server.
prompt - Asks for confirmation when transfering / replacing files or directories.
put - Uploads a file.
mput - Uploads multiple files.

To make your life simpler, make sure the OekakiPoteto files are in a directory in your C:\ drive; C:\oekaki is suggested, and will be used in the examples.

Step 7

Change the local directory on your computer to where the OekakiPoteto files are.

lcd C:\oekaki

ftp> open abcd.com

Step 8

Change into the directory to where your HTML files go. To find this out, type ls. On my server, I have to switch to the public_html directory. Yours could be different. In some cases, you might not have to change directories at all.

ls cd public_html

ftp> open abcd.com

Step 9

Create a directory, oekaki.

mkdir oekaki

ftp> open abcd.com

Step 10

CHMOD the oekaki directory to 777.

chmod 0777 oekaki

ftp> open abcd.com

Step 11

Change into the newly created oekaki directory.

cd oekaki

ftp> open abcd.com

Step 12

Upload the following files in ASCII mode to the oekaki directory and CHMOD them to 666.

announce.php
hosts.txt
ips.txt
notice.php

ascii put announce.php put hosts.txt put ips.txt put notice.php

chmod 0666 announce.php chmod 0666 hosts.txt chmod 0666 ips.txt chmod 0666 notice.php

ftp> open abcd.com

Step 13

Transfer the following files to the oekaki directory in Binary mode:

button.gif
MgLine.zip
oekakibbs.jar
PaintBBS.jar
PCHViewer.jar
pr0n.png

binary put button.gif put MgLine.zip put oekakibbs.jar put PaintBBS.jar put PCHViewer.jar put pr0n.png

ftp> open abcd.com

Connected to abcd.com. 220 ProFTPD 1.2.2rc1 Server (ProFTPD) [192.168.0.2] 500 AUTH not understood. KERBEROS_V4 rejected as an authentication type Name (abcd.com:ranmaguy): ranmaguy
331 Password required for ranmaguy. Password: 230 User ranmaguy logged in. Remote system type is UNIX. Using binary mode to transfer files. ftp> lcd C:\oekaki Local directory now C:\oekaki ftp> ls 227 Entering Passive Mode (209,148,64,135,13,221). 150 Opening ASCII mode data connection for file list drwxrwxrwx 5 keitaro users 2048 Sep 10 02:00 public_html 226 Transfer complete. ftp> cd public_html 250 CWD command successful. ftp> mkdir oekaki 257 "/usr/home/ranmaguy/public_html/oekaki" - Directory successfully created ftp> chmod 0777 oekaki 200 SITE CHMOD command successful. ftp> cd oekaki 250 CWD command successful. ftp> ascii 200 Type set to A.ftp> put announce.phplocal: announce.php remote: announce.php 200 PORT command successful 150 Opening ASCII mode data connection for announce.php 226 Transfer complete. ftp> put hosts.txt local: hosts.txt remote: hosts.txt 200 PORT command successful 150 Opening ASCII mode data connection for hosts.txt 226 Transfer complete. ftp> put ips.txt local: ips.txt remote: ips.txt 200 PORT command successful 150 Opening ASCII mode data connection for ips.txt 226 Transfer complete. ftp> put notice.php local: notice.php remote: notice.php 200 PORT command successful 150 Opening ASCII mode data connection for notice.php 226 Transfer complete. ftp> chmod 0666 announce.php 200 SITE CHMOD command successful. ftp> chmod 0666 hosts.txt 200 SITE CHMOD command successful. ftp> chmod 0666 ips.txt 200 SITE CHMOD command successful. ftp> chmod 0666 notice.php 200 SITE CHMOD command successful. ftp> binary 200 Type set to I. ftp> put button.gif local: button.gif remote: button.gif 200 PORT command successful 150 Opening BINARY mode data connection for button.gif 226 Transfer complete. ftp> put MgLine.zip local: MgLine.zip remote: MgLine.zip 200 PORT command successful 150 Opening BINARY mode data connection for button.gif 226 Transfer complete. ftp> put oekakibbs.jar local: oekakibbs.jar remote: oekakibbs.jar 200 PORT command successful 150 Opening BINARY mode data connection for oekakibbs.jar 226 Transfer complete. ftp> put PaintBBS.jar local: PaintBBS.jar remote: PaintBBS.jar 200 PORT command successful 150 Opening BINARY mode data connection for PaintBBS.jar 226 Transfer complete. ftp> put PCHViewer.jar local: PCHViewer.jar remote: PCHViewer.jar 200 PORT command successful 150 Opening BINARY mode data connection for PCHViewer.jar 226 Transfer complete. ftp> put pr0n.png local: pr0n.png remote: pr0n.png 200 PORT command successful 150 Opening BINARY mode data connection for pr0n.png 226 Transfer complete. ftp>

Step 14

Transfer all the PHP files in ASCII mode to the oekaki directory.

ascii prompt mput *.php

For the sake of sanity and readability, the file transfers will not be shown in the panzy pink box.

ftp> open abcd.com

Step 15

In the oekaki directory, create a directory called templates. CHMOD this directory to 777, and upload all the files in the C:\oekaki\templates directory in ASCII to the templates directory you created.

lcd C:\oekaki\templates mkdir templates cd templates mput *.php

ftp> open abcd.com

Step 16

In the oekaki directory, create a directory called language. Upload all the files in the C:\oekaki\language directory in ASCII to the language directory you created.

lcd C:\oekaki\language cd .. mkdir language cd language mput *.php

ftp> open abcd.com

Step 17

In the oekaki directory, create a directory called pictures. CHMOD this directory to 777.cd .. mkdir pictures chmod 0777 pictures

ftp> open abcd.com

What your file structure should look like:

Step 18

You can now start using your OekakiPoteto!

Free Site Guide

Installing OekakiPoteto on tripod.lycos.co.uk

This guide assumes you already have an account.

Step 1

Step 2

Start using the Command Line FTP guide. You can skip step 1 and 8.

This will be your required information:

FTP Address: ftp.members.lycos.co.uk
FTP Username: The name of your login account on the site builder.
FTP Password: The login password for your account on the site builder.
Database Name: loginname_uk_db (replace loginname with the name of your login account)
Database Username: The The name of your login account on the site builder.
Database Password: The login password for your account on the site builder.

Installing Multiple Boards

Member sharing configuration

This option is for those who want to set up two or more OekakiPoteto boards, and want to share the member database, so users can use the same login for each board.

Step 1

On the first board, go to Administration > Control Panel, and note down the following:

Database Prefix
Member Database Prefix
Encryption Key

The table below is an example of what you might have if you are using the default install configuration.

	Board 1
Database Prefix	_op
Member Database Prefix	_op
Encryption Key	As

Step 2

Install your additional OekakiPoteto into a new, seperate directory. Do NOT copy your OekakiPoteto files from the first board. When you enter install.php, you must do the following:

Database Prefix: Choose a prefix that none of the other boards have.
Member Database Prefix: All boards that wish to share the member database must use the same prefix.
Encryption Key: All boards that wish to share the member database must use the same encryption key.

If you are using the default Database Prefix, Member Database Prefix, and Encryption Key, you can try using these values on your additional board(s).

Note: You WILL recieve errors such as:

Table 'op_oekaki' already exists
Duplicate entry '' for key 2
Table 'op_oekakichat' already exists
Table 'op_oekakionline' already exists
Table 'op_oekakimailbox' already exists
Table 'op_oekakikill' already exists

This is normal.

Also, beacuse of the way the OekakiPoteto cookies work, users who access a different board that shares the member database will have to re-login.

2 Board Configuration

	Board 1	Board 2	Notes
Database Prefix	_op	_op2	All boards must not share the same Database Prefix.
Member Database Prefix	_op	_op	Must share the same Member Database Prefix.
Encryption Key	As	As	Must share the same Encryption Key.

3 Board Configuration

	Board 1	Board 2	Board 3	Notes
Database Prefix	_op	_op2	_op3	All boards must not share the same Database Prefix.
Member Database Prefix	_op	_op	_op	Must share the same Member Database Prefix.
Encryption Key	As	As	As	Must share the same Encryption Key.

Non-Member sharing configuration

This option is for those who want two or more seperate boards with seperate members on the same site.

Step 1

On the first board, go to Administration > Control Panel, and note down the following:

Database Prefix
Member Database Prefix

The table below is an example of what you might have if you are using the default install configuration.

	Board 1
Database Prefix	_op
Member Database Prefix	_op

Step 2

Install your additional OekakiPoteto into a new, seperate directory. Do NOT copy your OekakiPoteto files from the first board. When you enter install.php, you must do the following:

Database Prefix: Choose a prefix that none of the other boards have.
Member Database Prefix: Choose a prefix that none of the other boards have.

If you are using the default Database Prefix, Member Database Prefix, and Encryption Key, you can try using these values on your additional board(s).

2 Board Configuration

	Board 1	Board 2	Notes
Database Prefix	_op	_op2	All boards must not share the same Database Prefix.
Member Database Prefix	_op	_op2	All boards must not share the same Member Database Prefix.

3 Board Configuration

	Board 1	Board 2	Board 3	Notes
Database Prefix	_op	_op2	_op3	All boards must not share the same Database Prefix.
Member Database Prefix	_op	_op2	_op3	All boards must not share the same Member Database Prefix.

Using OekakiPoteto

Adding members

If you are using a pending system to add in members, you will need to go to Administration > View Pending to accept or reject waitlisted members.

If you are using an automated registration system, make sure that you have set an e-mail that will properly send out in your Admin > Control Panel. When a user registers on an automated registration system, an e-mail will be sent to them with a verification code so they can activate their account. However, you can still go to Admin > View Pending to add/reject members.

Giving permissions

If you want to make someone an administrator or a super administrator, to go Admin > Modify Permissions. DO NOT MODIFY YOUR OWN FLAGS! You will lose your owner status if you do.

Adjusting OP for your language

OekakiPoteto 5.x utilizes language packs. If you want to set the default language, go to Admin > Control Panel to set the default language.

Users can also set the language by going into Admin > Profile.

If a language is not available, it might be soon. Check http://www.suteki.nu for OekakiPoteto updates.

Translating OekakiPoteto

If your language does not exist for OekakiPoteto, you can now create your own without any hassle. Open up the english.php file in the /language directory, and use that as a base to make your translation. Please send your translations to ranmaguy@suteki.nu if you wish to share them with others. If the translation does not exist in the current OekakiPoteto package, it will be included in the next version or update.

Miscellaneous

mail() errors

If you recieve errors relating to mail(), it means that the mail() function is not functional on your server. You might want to ask your tech support to enable this, since it is important and necessary for automated registration and password recovery.

language errors when upgrading

When upgrading from version 4.x, your update.php file needs to be able to modify config.php. If it cannot, you will recieve write errors. If this happens, chmod your config.php file to 666. The update.php file attempts to chmod it, but in some cases it will not work, and you will have to chmod it manually. In the worse case scenerio, if it does not chmod, you will have to ask your tech support to chmod it for you.

unable to delete pictures or your picture directory (version 4.x)

This problem is common with 4.x installations, since 4.x automatically creates the picture directory. Since this directory is under server permissions, you cannot modify anything in it. In the /docs directory, edit chback.php and run it to attempt to get the pictures directory to be modified. In the worse case scenerio, if it does not chmod, you will have to ask your tech support to chmod it for you.