GROUP EFFORT :: Updating readme.html Part 1

Amadeus · Post by **Amadeus** » Fri Oct 03, 2003 5:18 pm

We desperately need to update the readme.html

Therefore, I am going to help that process along by breaking down the file into manageble sections, posting them here, and having *EVERYONE* submit new wording, changes.

PLEASE read through everything here and help us by replying with sections that you wish to have rewritten. Please (/quote) the section you're changing, then just type in what you want it to say. Don't worry so much about formatting, etc...I'll take care of that.

ALSO, please feel free to write any ADDITIONS that you feel need to be ADDED to this file.

Let's get this updated to help with new people learning MQ!

Code: Select all

1. Installing and Running MacroQuest

Install

*  Unzip MacroQuest somewhere (other than your EQ directory). 
*  Windows 9x/ME users will have to install ActivePerl 
*  For new installations, copy the file macroquest.ini.dist to macroquest.ini
 
To run MacroQuest simply double click on MacroQuest.exe (it will appear in the system tray) and start EverQuest.When there is a patch, check to see if eqgame.exe is updated. If it is then you need to get new offsets, and possibly a new version of MacroQuest. You can get these on the MacroQuest homepage on the "Quick Links" bar at the top of the page.

[i]Note: MacroQuest is currently partially broken on the New UI. It is recommended that you use the old UI for now.[/i]

dont_know_at_all · Post by **dont_know_at_all** » Fri Oct 03, 2003 6:27 pm

Heh, delete all of this.

Trixz · Post by **Trixz** » Fri Oct 10, 2003 3:16 am

I got bored tonight so I figured I'd rewrite this if you all still want it done. I'll look at the other parts of the readme and see if I'm bored enough to redo the bigger parts. Anyway the beggining is as follows.

Code: Select all

1. Downloading and Compiling MacroQuest

Downloading

A. Download the latest zip from http://macroquest2.com/downloads/IRC-latest.zip.

B. Use CVS  (taken from EQMule's help post)
 
******************* CVS and its usage...  ********************
The steps below are for people that want to use the cvs to get the source.
(but as it is nowdays, the zipfile on the downloads page is often newer)
******************************************************************
1. First of all get a decent cvs client, I use Wincvs 1.2 which you can find if you do a google search for Wincvs and download
2. Install it by running setup.exe and click next next and so on...
3. Run it.
4. When it starts open Admin -> preferences and on the General tab paste in:

    anonymous@cvs.sourceforge.net:/cvsroot/macroquest 
    in the 'Enter the CVSROOT' field

5. In the Authentication field choose the '"passwd" file on the cvs server' option
6. Now click on the Globals tab and check the box at the bottom which says: 'Checkout textfiles with the UNIX LX (0xa)'
7. Click ok
8. Goto menu Admin -> Login and when it asks for a password just press enter
9. Goto menu Admin -> Command Line... and paste in

    cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/macroquest co macroquest
and press Enter

9. the source will now be downloaded to you computer...

Compiling - You MUST have Visual Studio installed on your computer to compile macroquest!!!

A. In Windows

1. Goto the directory where you have the source stored.
2. Click on macroquest.dsw (it will open in visual studio)
3. Click on Build>Configurations and set the configuration to macroquest Win32 Release.
4. Source is compiled, you can find the exe in the release folder.

B. From the command line

1. Click on start>run
2. Type cmd and push enter
3. Now change to the eqlib directory where the source is located (example: cd C:\macroquest\eqlib)
4. Type nmake and push enter
5. Type cd.. and push enter
6. Type nmake again
7. Source is compiled... look for the exe in the release folder.

Stogar · Post by **Stogar** » Thu Oct 23, 2003 2:33 pm

See this post.

http://macroquest2.com/phpBB2/viewtopic ... ht=install

Wassup has gone through the current release, tested out commands, and updated the documentation. It's a great chunk of work and I'm sure it took alot of time. He should get a huge thanks for doing it. I'm helping him test things and working on editing the html.

I cleaned the exisiting readme.html and added the above post about Downloading and compiling. Changing the format as well to be more readable. Something like:

Command [options] <arguments>
- Description text
Example
Example text blaa blaa

Will also add a hyperlinked index to commands.

It should end up being pretty clean and up to date.

Need to get a new macro tutorial if anyone wants to tackle that :)