[obsolete] EasyMOD alpha3 v0.0.10 released

This forum is now closed as part of retiring phpBB2.
Forum rules
READ: phpBB.com Board-Wide Rules and Regulations

This forum is now closed due to phpBB2.0 being retired.
Locked
Nuttzy99
Former Team Member
Posts: 4917
Joined: Fri Aug 03, 2001 7:09 am
Location: the 11th dimension
Contact:

[obsolete] EasyMOD alpha3 v0.0.10 released

Post by Nuttzy99 » Sat Jul 26, 2003 10:56 pm

Latest Status:

EasyMOD has a new home! - http://area51.phpbb.com/phpBB22/viewforum.php?sid=&f=15

August 4th - new version is out! Has a few minor fixes. Go get it: http://www.phpbb.com/phpBB/viewtopic.php?t=124436

June 10th: I'm a proud father as of today! Details

-Nuttzy :cool:
Last edited by Nuttzy99 on Mon Aug 04, 2003 6:00 am, edited 3 times in total.
SpellingCow.com - Free spell check service for your forums or any web form!
No Support via PM please!

Nuttzy99
Former Team Member
Posts: 4917
Joined: Fri Aug 03, 2001 7:09 am
Location: the 11th dimension
Contact:

Post by Nuttzy99 » Sat Jul 26, 2003 10:57 pm

Introduction:
EasyMOD is an automatic MOD installer. It does in seconds what used to be the laborious and time consuming task of manually editing files. EM will install EasyMOD Compliant (EMC) MODs and also *try* to install all other MODs as well. For most users, MOD installs should be completely automated. There are break points so you can check what EM proposes to do before it makes any permanant changes.


Author's Notes:
EM is not yet feature complete. Most noteably it is missing SQL processing and an uninstaller. Since EM is not feature complete it is considered alpha software. EM has over 7500 lines of PHP code and this does not even include the 1000+ lines already written to handle SQL processing or the 8 template files. However, this is the 7th public release and by now the features EM does have are release quality. So feel free to install but remember it is not yet as good as its going to get ;)

Now that EM has reached a certain level of maturity, a refining process will take place. I will document how best to write MODs for EM (EasyMOD Compliant). A key to success will be getting MOD Authors to write their MODs so they don't clash with other MOD installations. My goal is to present a clear, reasonable, and unintrusive as possible method.

Lastly, thank you Daz for providing the EM graphics, thanks to the translators listed below, and special thanks to my 1337 Pre-Release Tester Team: Ptirhiik - RPGnet-fr, wGEric, morpheus2matrix, GPHemsley, LifeIsPain, and DanielT


Installation:

Download EM:
[ -- LINK REMOVED BY NUTTZY -- ]

New installs:
1) Extract in your admin directory. The proper directory heirachy should be admin/mods/easymod (note that "easymod" is now lowercase)
2) From a web browser, open http: //{YOUR BOARD ADDRESS}/admin/mods/easymod/easymod_install.php The install will guide you through everything and no modifications occur before warning you.
3) There is no step 3! Yup it's that easy ;) Once installed, you may wish to install the Country Flags MOD which is the only "official" EMC MOD.

Upgrading:
It is advised that you remove any previous admin/mods/EasyMOD directories. Once they are out of the way, just follow the install instructions above. EM will figure everything else out :D



Features:
  • Choose from some fully automated installation methods and some manual methods as well. You decide what's best for you!
  • the modifed files generated can be:
    • written directly to server (requires write access in the "mods" dir)
    • written to a buffer and FTP'd into place (requires FTP access)
    • downloaded to your local machine
    • written on screen in a seperate browser window (requires you to be sadistic ;))
  • If you are satisifed with the modifications, the files can then be moved into place
    • by the copy command (fully automated: requires write access to ALL dirs from phpBB root downward)
    • FTP'd into place (fully automated: requires FTP access)
    • execute a script (fully automated: requires permission to run scripts)
    • manually loaded (requires your time ;))
  • robust installer (needs some work though ;))
  • the program is ready to accept translations for multiple languages
  • support for ALL MOD Template functions (COPY command needs some work)
  • install MODs to all installed themes
  • install MODs to all installed languages
  • automatically backups up files before modifying (you should still make your own backups though!)
  • continued processing if non-English or non-subSilver file fails - you decide if you want to continue or not
  • password protected - even admins cannot access EM unless the board owner gives them the password
  • object oriented programming - classes could be used in other programs
  • install EMC MODs
  • *try* to install non-EMC MODs
  • settings ACP
  • installed MODs history ACP
  • view MOD script from the install screen (click link)
  • security-conscious every step of the way
  • MOD script line numbers appear where ever they will be helpful
  • convinient install debugger
  • I'm sure there are more but I don't feel like thinking about it anymore ;)

To Do List:
Things to be added/fixed in 0.0.11:
  • COPY command needs to handle *.* and entire directories
  • preview mode to see what changes EM proposes to make
  • multi-lingual support (with author notes ;))
  • better debugging for people messing up the FTP path
  • reinstalling EM after board upgrade - yashin19
  • any bugs that come up in 0.0.10
  • compensate for hard coded image paths in tpl - -=ET=-
Things to be added/fixed in Beta 1:
  • SQL processing
  • INCREMENT command
  • auto restore backups option
  • uninstaller option
  • some way of cleaning up disk space
  • comphrensive method for dealing with lang packs
Translations:
EM is going international :D Translations of lang_easymod.php are needed!!! Several translations have already been completed although EM will not really utilize them until version 0.0.11. Below are the languages submitted and their current status:
  • Language - Author - EM version
  • Danish - AlleyKat - 0.0.9c
  • French - Jaeboy - 0.0.9
  • German - Balint - 0.0.9c
  • Norwegian - Espenhh - 0.0.9c
  • Portuguese - JuniorZ - 0.0.9 (file not available)
  • Swedish - Kail - 0.0.8
Language version changes
The language change log can be found here



Bug Tracker:

Bug // Reporter // status
---no 0.0.10 bugs submitted yet --



Changes from 0.0.9c to 0.0.10:

fix bug with mkdir return
missing buffer+ftp option on settings ACP
COPY command working except for *.*
make FTP the default methods
code paths correctly!!
../ in path a problem for some FTP servers - Aexoden
settings ACP should autocomplete with old settings
run FTP access test in debugger for move method
fix pass by ref warnings - GPHemsley + Ptirhiik
correctly parse MOD header to allow for EM to detect more MODs
display info on how to install other MODs
make sure english and subsilver are present before installing
lowcase EasyMOD dir to be easymod ;)
temporary quick fix to determine if file is ASCII or binary
fixed a duplicate lang file entry
make COPY accept unlimited tabs and spaces
changed mod_file param in EM table to be 255 chars (was 50)
fixed finding a bug with multi-line finds - GPHemsley
streamlined the function that performs FINDs

Previous version changes
The complete change log can be found here


-Nuttzy :cool:
Last edited by Nuttzy99 on Mon Aug 04, 2003 6:03 am, edited 5 times in total.
SpellingCow.com - Free spell check service for your forums or any web form!
No Support via PM please!

Nuttzy99
Former Team Member
Posts: 4917
Joined: Fri Aug 03, 2001 7:09 am
Location: the 11th dimension
Contact:

Post by Nuttzy99 » Sat Jul 26, 2003 10:57 pm

Here's help for some frequently asked questions:

Installing MODs with EasyMOD
Theoretically, EM should be able to install any single MOD currently in the www.phpbb.com MODs database. However, MOD authors do not currently write their MODs to prevent clashes with other MODs. Therefore the more MODs you install then the more likely they will clash with each other and EM won't be able to install them. The next phase of the project will be to write a set of standards to prevent this (EMC).

To Install a MOD
  1. Load all files related to the MOD in the directory admin/mods/whatever_the_name_of_the_mod_is
    • the directory you create cannot have any spaces or single quotes (')
    • example: admin/mods/Country_Flags
  2. In the Admin Control Panel, under the Install MODs option, EM will list any MODs it detects. Clicking the "Process" button will initiate the install and EM will guide you every step of the way ;)
    • EM will scan any .txt or .mod file in the directories immediately under admin/mods to see if it's a MOD
EM won't see your MOD? Here's why
EM looks in the header of the MOD and needs to find at least a title and an author name in order to install. EM is fairly flexible in what it will accept, but optimially it is looking for the following format:

Code: Select all

## MOD Title: mod_title_goes_here 
## MOD Author: username < email > (real_name) website_url
## MOD Description: some_description_goes_here 
## MOD Version: x.x.x 


Installing Attachment MOD v2.3.8 with EM
Attachment MOD (Attach) by Aycd Burn is one the most popular MODs for phpBB. There is also a lot involved with installing it and there are many requests for it to work with EM. It almost does ;-) You just need to follow the simple steps below to get Attach ready for EM and have it installed in no time!

IF YOU ENCOUNTER A PROBLEM, ASK ON THE ATTACHMENT MOD TOPIC, NOT HERE!
  1. Refer to the Attach documentation for the most detailed installation instructions
  2. Place the attach_mod directory in admin/mods. You will now have an admin/mods/attach_mod directory.
  3. From admin/mods/attach_mod/docs move the appropriate script to admin/mods/attach_mod. For a fresh instal use install.txt
  4. One change to install.txt must be made so it can be used with EM.
    1. Edit install.txt
    2. Perform a global replace of attach_mod/root with just root This is specifically to fix the COPY command in Step I of Attach
    3. The lang files need to be added to the COPY command. Append the following to the list of files to be copied:
    copy root/language/lang_english/lang_admin_attach.php to language/lang_english/lang_admin_attach.php
    copy root/language/lang_english/lang_faq_attach.php to language/lang_english/lang_faq_attach.php
    copy root/language/lang_english/lang_main_attach.php to language/lang_english/lang_main_attach.php
  5. As per Step II of Attach:
    1. Copy the contents of amind/mods/attach_mod/root/install to install (in phpbb root)
    2. Run mod_table_inst.php through your web browser
  6. Install Attach using the EM Install MOD from Admin Control Panel.
  7. Refer to Step IV of Attach to see if you need to 777 a directory
IF YOU ENCOUNTER A PROBLEM, ASK ON THE ATTACHMENT MOD TOPIC, NOT HERE!

-Nuttzy :cool:
Last edited by Nuttzy99 on Fri Aug 01, 2003 2:55 am, edited 6 times in total.
SpellingCow.com - Free spell check service for your forums or any web form!
No Support via PM please!

Nuttzy99
Former Team Member
Posts: 4917
Joined: Fri Aug 03, 2001 7:09 am
Location: the 11th dimension
Contact:

Post by Nuttzy99 » Thu Jul 31, 2003 3:39 am

I've only checked it over quickly, but GP has a few tips that may help folks:
GPHemsley wrote: INSTALLATION

1) Upload all files and folders for the MOD into the admin/mods/ folder.
2) All MODs should have their own folder and the folder name must not contain any spaces.
3) Visit the forum where the MOD(s) are to be installed, log in as an Administrator, and enter the Administration Panel.
4) Click on "Install MODs" under the "MOD Center" header in the left-hand-side panel.
5) Enter the password for EasyMOD that you first set at installation (or on the "EasyMOD Settings" page).
6) Find the MOD in the list of MODs and click the "Process" button to the right of it.
7) Confirm that EasyMOD has detected and correctly interpreted all steps in the MOD and then click the "Next Step" button.
8 ) Realize that EasyMOD does not currently execute any SQL and then click the "Complete Installation" button.
9) Check to make sure that the MOD installed correctly.

TROUBLESHOOTING

I get a "INVALID PASSWORD SUPPLIED" error when trying to enter the install page.
You have entered a password other than the one set for entrance to EasyMOD or you have not entered a password at all. Try entering a different password.

I get an "All MODs have been processed" message instead of a list of MODs on the "Install MODs" page.
Either there are no MODs in the admin/mods/ folder that have not been processed or one or more MODs have incorrect headers. Make sure the headers look like one of the following:

Code: Select all

## MOD Title: name_of_MOD
## MOD Author: phpBB.com_nick < e-mail_address > (Real Name) 
## MOD Description: description_of_MOD
## MOD Version: x.x.x

Code: Select all

## MOD Title: name_of_MOD
## MOD Author: phpBB.com_nick < e-mail_address > (Real Name) http://MOD.author's.website/
## MOD Description: description_of_MOD
## MOD Version: x.x.x
I get a "Critical Error" message on the first page of installing a MOD.
Usually critical errors occur when FINDs or COPYs cannot be completed. Make sure the code being looked for exists in the file it is being looked for in or that the file to be copied exists in the folder that it is said to be in.

I get a "Warning" message on the first page of installing a MOD.
This is just informing you that EasyMOD cannot find the specified lines of code in languages other than English or styles other than subSilver. You can then choose to continue with or halt installation of that MOD.

I get SQL Disabled messages on the second page of installation.
This is normal for alpha versions of EasyMOD. This is just to make you aware that you have to execute all SQL queries by hand.

I get COPY errors on the third page of installation.
There may be spaces in the name of the folder that contains the MOD. This will confuse EasyMOD. Eliminate any spaces in the foldername and try installing again. If there aren't any spaces, please report your error here.

The MOD does not operate as planned.
EasyMOD is not made to determine whether the MOD will do what you want. Just continue looking for the MOD that you want. Do NOT post here about it.

There are errors in pages outside of the EasyMOD pages in the Admin Panel (i.e. Parse errors, unexpected characters, etc.).
This is probably not an error on EasyMOD's part. Please contact the MOD Author in whichever way he/she prefers. If the MOD normally functions correctly with the version you tried to install, please report your error here.
SpellingCow.com - Free spell check service for your forums or any web form!
No Support via PM please!

Nuttzy99
Former Team Member
Posts: 4917
Joined: Fri Aug 03, 2001 7:09 am
Location: the 11th dimension
Contact:

Post by Nuttzy99 » Thu Jul 31, 2003 3:52 am

Add Ons
A few users have been kind enough to make some add on's for EM.
  • ViewInfo by Jaeboy - allows you to see the info EM stores in the config table. Useful if you forget your EM password ;)
  • EasyMOD Addon by JuniorZ - uses the EM backups files to attempt to uninstall MODs
  • Version Changer by GPHemsley - if for some reason you need to reinstall the same version of EM, this proggie will let you change the EM version in the config table
Thanks guys!
-Nuttzy :cool:
SpellingCow.com - Free spell check service for your forums or any web form!
No Support via PM please!

User avatar
GPHemsley
Registered User
Posts: 1475
Joined: Fri Apr 18, 2003 3:12 am
Location: Long Beach, NY
Name: Gordon Hemsley
Contact:

Post by GPHemsley » Thu Jul 31, 2003 4:06 am

Well, we've all worked hard on this (Nuttzy and the Pre-Release Team) and I think we all deserve a pat on the back (at the least! :lol:).

So, we've got 0.0.11 and then we're heading to Beta, right?

Let's go! :D

Nuttzy99
Former Team Member
Posts: 4917
Joined: Fri Aug 03, 2001 7:09 am
Location: the 11th dimension
Contact:

Post by Nuttzy99 » Thu Jul 31, 2003 4:10 am

NUTTZY SLEEP NOW

-Nuttzy :cool:
SpellingCow.com - Free spell check service for your forums or any web form!
No Support via PM please!

User avatar
GPHemsley
Registered User
Posts: 1475
Joined: Fri Apr 18, 2003 3:12 am
Location: Long Beach, NY
Name: Gordon Hemsley
Contact:

Post by GPHemsley » Thu Jul 31, 2003 4:12 am

Nuttzy99 wrote: NUTTZY SLEEP NOW

-Nuttzy :cool:

Go right ahead. You deserve it. ;)

Josh Windu
Registered User
Posts: 377
Joined: Sun Jul 14, 2002 3:14 am
Location: Australia
Contact:

Post by Josh Windu » Thu Jul 31, 2003 4:44 am

nuttzy- you rock man!! this is awsome!
Nitrotech - Alpha stage... Your own fully customisable forum! and site!

Nuttzy99
Former Team Member
Posts: 4917
Joined: Fri Aug 03, 2001 7:09 am
Location: the 11th dimension
Contact:

Post by Nuttzy99 » Thu Jul 31, 2003 4:50 am

Was curious about how many views some of these EM topics have gotten. That's a lot views!

Code: Select all

version   posts   views   days as current version
-------------------------------------------------
0.0.10      -       -        ???
0.0.9c     590    11185    27 days
0.0.9      409     9219    30 days
0.0.8      371     6470    10 days
0.0.7      448    28764   8.5 months
0.0.6      147    12806    20 days
0.0.4        ?        ?     4 months
-------------------------------------------------
          1965    68444
If 0.0.11 doesn't come out for awhile then the 0.0.10 topic will probably get out of control in a hurry 8O

-Nuttzy :cool:
SpellingCow.com - Free spell check service for your forums or any web form!
No Support via PM please!

chickeneater
Registered User
Posts: 400
Joined: Wed May 21, 2003 3:16 pm

Post by chickeneater » Thu Jul 31, 2003 4:58 am

Nuttzy... I love you :)

chickeneater
Registered User
Posts: 400
Joined: Wed May 21, 2003 3:16 pm

Post by chickeneater » Thu Jul 31, 2003 5:06 am

ok... I got this thing that (pitrhiik ?) told me to get this set of files to test php on my localhost. I don't know what the ftp username and password are... anything?

Questions
Registered User
Posts: 705
Joined: Mon Sep 30, 2002 11:06 pm
Location: Cyberspace Learning: PHP &amp; MySQL
Contact:

Post by Questions » Thu Jul 31, 2003 5:27 am

install the ViewInfo by Jaeboy
I will Install MODs to your forum, or install a fresh phpBB 2.0.10 to your host for reasonable prices.
Contact me via AIM @: Gam LDub


(Please note: I use paypal as my money transaction, so before you contact me to do any work to your site, make sure you have one. Thank you.)

Questions
Registered User
Posts: 705
Joined: Mon Sep 30, 2002 11:06 pm
Location: Cyberspace Learning: PHP &amp; MySQL
Contact:

Post by Questions » Thu Jul 31, 2003 5:29 am

install the ViewInfo by Jaeboy
I will Install MODs to your forum, or install a fresh phpBB 2.0.10 to your host for reasonable prices.
Contact me via AIM @: Gam LDub


(Please note: I use paypal as my money transaction, so before you contact me to do any work to your site, make sure you have one. Thank you.)

User avatar
GPHemsley
Registered User
Posts: 1475
Joined: Fri Apr 18, 2003 3:12 am
Location: Long Beach, NY
Name: Gordon Hemsley
Contact:

Post by GPHemsley » Thu Jul 31, 2003 5:36 am

chickeneater wrote: ok... I got this thing that (pitrhiik ?) told me to get this set of files to test php on my localhost. I don't know what the ftp username and password are... anything?

For your localhost, you probably don't have any username or password. Just leave them blank. (BTW, you shouldn't need the FTP info because server-server-copy will work. ;) )

Locked

Return to “[2.0.x] MOD Writers Discussion”