Origami

From Botdom Wiki
Jump to: navigation, search
Origami
Origami OSX.png
Origami 0.3 Alpha running on Mac OSX
Developer(s): DivinityArcane
Programming language: Perl
Minimum requirements: Perl or ActivePerl
Development state: Pre-Alpha
Source model: Open source


License type: Free software (GPL)



Origami is a bot for deviantART's Message Network (dAmn), written in Perl by DivinityArcane. It aims at being a fully featured, event driven bot with support for third party modules and extensions. Unlike dAmnPearl, it is more than a logging bot and comes with quite a few commands out of the box, as well as some modules containing things like games and searches. It is the first publicly released, fully featured dAmn bot written in Perl.


Origami 0.3 Alpha running on Windows
Origami 0.3 Alpha running on Linux


Downloads

Modules

In the future, information on modules will go here.


Installation

Origami requires Perl to run. Obtaining Perl is simple, and you may already have it depending on your operating system.


Windows

Windows users must download and install ActiveState's Perl distribution, ActivePerl. Doing so is simple. The installer can be obtained from this page (it's the big blue button at the top-right.) Once it has been installed, the user may download Origami, extract it, and proceed into the folder it extracted to. There will be a file named install_deps_windows.bat (the .bat may not show for some.) which the user must run first. This will install everything necessary for the bot to operate and successfully log into dAmn. It should output something similar to this:

 Installing deps...
 Downloading ActiveState Package Repository packlist...done
 Updating ActiveState Package Repository database...done
 Downloading JSON-XS-2.32...done
 Downloading File-Slurp-9999.19...done
 Downloading common-sense-3.6...done
 Unpacking JSON-XS-2.32...done
 Unpacking File-Slurp-9999.19...done
 Unpacking common-sense-3.6...done
 Generating HTML for JSON-XS-2.32...done
 Generating HTML for File-Slurp-9999.19...done
 Generating HTML for common-sense-3.6...done
 Updating files in site area...done
   15 files installed
 Done!
 Press any key to continue . . .

After this, the user can run the run_windows.bat file (again, the .bat may not show for some.) to run the bot.


Linux

Most Linux distributions already have Perl installed, and usually the version is sufficient to run Origami. All that is required is that the user runs the install_deps_linux.sh file (either by double clicking it, or cding to the directory and typing ./install_deps_linux.sh) which will install all the needed Perl libraries so that the bot can log into dAmn and function correctly. The output should be along the lines of:

 Installing deps...
 
 Downloading ActiveState Package Repository packlist...done 
 Updating ActiveState Package Repository database...done 
 Syncing user PPM database with .packlists...done 
 Downloading Crypt-SSLeay-0.64...done 
 Downloading JSON-XS-2.32...done 
 Downloading File-Slurp-9999.19...done 
 Downloading common-sense-3.6...done 
 Unpacking Crypt-SSLeay-0.64...done 
 Unpacking JSON-XS-2.32...done 
 Unpacking File-Slurp-9999.19...done 
 Unpacking common-sense-3.6...done 
 Relocating Crypt-SSLeay-0.64...done 
 Relocating JSON-XS-2.32...done 
 Relocating File-Slurp-9999.19...done 
 Relocating common-sense-3.6...done 
 Generating HTML for Crypt-SSLeay-0.64...done 
 Updating files in user area...done 
   16 files installed
 Done!

After this, the user can go ahead and run run_linux.sh file which will run the bot.


Mac OSX

Mac OSX comes with Perl installed, however, in most all cases it is Perl v5.10 which is quite outdated and does not work correctly with Origami. To update to a newer Perl, the easiest way is to use ActiveState's Perl distribution, ActivePerl. Installing it is simple. The installer can be obtained from this page (it's the big blue button at the top-right.) Once it has been installed, the user may download Origami, extract it, and proceed into the folder it extracted to. The first thing the user will have to do is run the file named fix_perl_mac.sh (either by double clicking it or cding to the directory and typing ./fix_perl_mac.sh) which will replace the default Perl binary with the ActiveState binary, and also enable usage of ppm (Perl Package Manager) so the bot can obtain packages with ease. Running this file should yield similar results to these:

 Finding ActivePerl installation...
 Found ActivePerl in /usr/local/ActivePerl-5.16
 Saving /usr/bin/perl as /usr/bin/perl.bak
 Copying /usr/local/ActivePerl-5.16/bin/perl to /usr/bin/perl
 Copying /usr/local/ActivePerl-5.16/bin/ppm to /usr/bin/ppm
 Done!
 Press any key to close the window.

Note that the user may have to enter their Mac OS password so that it can copy the files successfully. After doing this, the user will need to run the install_deps_linux.sh file, which will install the Perl libraries the bot needs to run correctly and connect to dAmn. This should yield results similar to:

 Installing deps...
 
 Downloading ActiveState Package Repository packlist...done 
 Updating ActiveState Package Repository database...done 
 Syncing user PPM database with .packlists...done 
 Downloading Crypt-SSLeay-0.64...done 
 Downloading JSON-XS-2.32...done 
 Downloading File-Slurp-9999.19...done 
 Downloading common-sense-3.6...done 
 Unpacking Crypt-SSLeay-0.64...done 
 Unpacking JSON-XS-2.32...done 
 Unpacking File-Slurp-9999.19...done 
 Unpacking common-sense-3.6...done 
 Relocating Crypt-SSLeay-0.64...done 
 Relocating JSON-XS-2.32...done 
 Relocating File-Slurp-9999.19...done 
 Relocating common-sense-3.6...done 
 Generating HTML for Crypt-SSLeay-0.64...done 
 Updating files in user area...done 
   16 files installed
 Done!

After doing this, the user can go ahead and run the run_linux.sh file, which will start the bot.