[Home] [Downloads] [Search] [Help/forum]

Gammon Forum

See www.mushclient.com/spam for dealing with forum spam. Please read the MUSHclient FAQ!

[Folder]  Entire forum
-> [Folder]  MUSHclient
. -> [Folder]  General
. . -> [Subject]  MUSHclient 4.43 packaged up into a zip file
Home  |  Users  |  Search  |  FAQ
Username:
Register forum user name
Password:
Forgotten password?

MUSHclient 4.43 packaged up into a zip file

It is now over 60 days since the last post. This thread is closed.     [Refresh] Refresh page


Pages: 1 2  

Posted by Nick Gammon   Australia  (21,322 posts)  [Biography] bio   Forum Administrator
Date Mon 10 Aug 2009 11:30 PM (UTC)

Amended on Tue 11 Aug 2009 08:43 PM (UTC) by Nick Gammon

Message
In order to facilitate distributions of MUSHclient in situations where you may not want to run the installer (eg. when using a thumb drive, or when using Ubuntu), I have repackaged version 4.43 so you can (optionally) download the install as a complete directory.

See: http://www.gammon.com.au/forum/?id=9659

The .zip file contains the MUSHclient directory and all relevant subdirectories (eg. plugins) already in the correct places. So, all you need to do is unzip it and run MUSHclient.exe. The first time around the spellchecker database will be built - this will take a few seconds.

MUD administrators may care to take that directory, add in a world file specific to their MUD (eg. with the IP address and port filled in), make that the default world to load, and distribute that as a "custom client". You may also want to add any relevant or custom plugins to load automatically for that world file.

If you do that you may want to reset things like the "first time flag". I did that by opening the preferences database with the "SQLite Database Browser" program (http://sqlitebrowser.sourceforge.net/) and editing the values in the "control" table. An alternative would be to use the sqlite3.exe program and type this:


C:\Documents and Settings\Owner\Desktop\MUSHclient> sqlite3 mushclient_prefs.sqlite

sqlite> UPDATE control SET value = 1 WHERE name = 'First time';
sqlite> .quit



The sqlite3 program is available from: http://www.sqlite.org/sqlite-3_6_16.zip



- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top

Posted by Twisol   USA  (2,257 posts)  [Biography] bio
Date Reply #1 on Tue 11 Aug 2009 08:18 AM (UTC)
Message
This is a great idea! Is this something that anyone can do themselves, or will you be supplying this as an alternative for future versions?

'Soludra' on Achaea

Blog: http://jonathan.com/
GitHub: http://github.com/Twisol
[Go to top] top

Posted by Bast   (77 posts)  [Biography] bio
Date Reply #2 on Tue 11 Aug 2009 01:51 PM (UTC)
Message
It is something you can do yourself.

See
http://code.google.com/p/bastmush/wiki/PortableMushclient

That was how i did it with the installer. But it should be easier now with the zip file.

Bast

Bast

Scripts: http://bastmush.googlecode.com
[Go to top] top

Posted by Nick Gammon   Australia  (21,322 posts)  [Biography] bio   Forum Administrator
Date Reply #3 on Tue 11 Aug 2009 09:04 PM (UTC)

Amended on Tue 11 Aug 2009 09:08 PM (UTC) by Nick Gammon

Message
Yes, I basically did what Bast said:


  • Use the installer to make a copy of MUSHclient on the desktop

  • Open MUSHclient (the installer offers to do this)

  • Wait for the spell check dictionary to be built (about 2 seconds)

  • Close the various welcome and help dialogs

  • Move the program around on the screen, and resize the main window, to taste

  • Change any global prefs you might want, like "Notify (errors) to output window", and "confirm before closing MUSHclient".

  • If you were making a custom client for a particular MUD, this would be the time to add a world file for your MUD, with the IP address, port and MUD name preconfigured. You might also add it to the global preferences "worlds to open at startup".

  • Also install any plugins that you might require, and load them into your preconfigured world file.

  • Close MUSHclient so screen positions and toolbar locations would be written to mushclient_prefs.sqlite and MUSHclient.ini.

  • (Optional): I deleted a few files in the MUSHclient folder that I thought would confuse new users:


    • mushclient.ico
    • lua5.1.lib
    • uninstall.exe (not needed really since this is an installer-less version)


  • Create a "logs" directory

  • Use the "SQLite Database Browser" program (http://sqlitebrowser.sourceforge.net/) to edit a few entries in the "control" table to make relative pathnames (you can't do this inside the program as it saves full pathnames). Alternatively you could use the sqlite3.exe program in a "command" window to do the same thing. Get this from: http://www.sqlite.org/sqlite-3_6_16.zip

    This is how you would do it with the command-line version:

    
    sqlite3 C:\Documents and Settings\Owner\Desktop\MUSHclient\mushclient_prefs.sqlite
    
    UPDATE prefs   SET value = '.\logs\'           WHERE name = 'DefaultLogFileDirectory';
    UPDATE prefs   SET value = '.\worlds\'         WHERE name = 'DefaultWorldFileDirectory';
    UPDATE prefs   SET value = '.\worlds\plugins\' WHERE name = 'PluginsDirectory';
    UPDATE control SET value = 1                   WHERE name = 'First time';  -- put first-time flag back
    .quit
    


  • In the "spell" subdirectory I deleted the 3.44 Mb file "spell.sqlite". That will be rebuilt when the player starts MUSHclient for the first time, and it adds somewhat to the .zip file size.

  • Use WinZip or some compression program of your choice to make an archive of the resulting folder, making sure you preserve the directory structure.

  • You now have a stand-alone distributable version!



- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top

Posted by WillFa   USA  (525 posts)  [Biography] bio
Date Reply #4 on Fri 14 Aug 2009 07:27 AM (UTC)
Message
Something I just figured out while working on "another project"...

7-zip File Manager (which I use anyway for decompressing stuff like .bz2 or .tar.gz files) can open the NSIS installer archive/exe directly.

So for those portable preferring people, or if you need an older version of a file (available at http://www.gammon.com.au/files) for "another project" (anyone curious yet?), you can just grab them that way.

[Go to top] top

Posted by Nick Gammon   Australia  (21,322 posts)  [Biography] bio   Forum Administrator
Date Reply #5 on Sat 15 Aug 2009 01:48 AM (UTC)
Message
A MUD server? Another, improved, client?

- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top

Posted by WillFa   USA  (525 posts)  [Biography] bio
Date Reply #6 on Sat 15 Aug 2009 02:24 AM (UTC)

Amended on Sat 15 Aug 2009 02:44 AM (UTC) by WillFa

Message
Nah, I should be happy with it by sunday (east coast US) for you to beta...

I got a new 'pooter! Windows 7! :D
No winhlp32... :|

I'm doing a lua script to generate chm help files for ya (okay, for us... ...me.) So far I've gotten a compiled chm with version 4.41 help in it (the most current documentation.sql available). Just working out table of contents and index issues.
The Lua script has 2 requires, lfs (luafilesystem) and luasql. I figure it may be a trivial thing to swap the db engine from sqlite3 to mysql for you.


The overides for WinHelp -> HtmlHelp in MFC look minimal. I've found numerous sites that have sample code that I'll link you to later.

To the best of my knowledge, I've preseved all the context id's. I'm pretty sure I've figured out what makehm.exe does, and how to correctly generate a .hm mapping so shift+f1 should work. We'd need the WinHelp -> HtmlHelp changes to actually test them though.

I made a change to the schema of the database. I've added a table that basically serves as a replacement for the .cnt file. The documentation is all database-driven now. The script will make the required .hm, .hhp (like a .hpj winhelp project), and other files (.hhc (cnt) and .hhk (index)) to compile. I'll give you a .sql file to create and import the table.

The .htm files themselves are being redone in xhtml 1.1/transitional and css. (Boo tables. Yaaa divs!)



I've found a couple small gotcha's in the source code.
docgen's links around the buttons/chicklets reverses the href and alt values, so they're actually all broken. But docgen/makehelp.bat/makehm.exe May all be antiquated if you like the changes.

There's a "kludge" in methods.cpp that loads the hand cursor over hyperlinks from winhlp32 which can probably just go away at this point, but needs to be rethought at the very least.

I don't know if you do your own hosting or not... If you have direct access to the .php and mysql database that gammon.com.au/scripts/doc.php runs. Err, if the php hits the database or if it's translating the path to static html files... Since with the new table we're not limited to 3 fields in the .cnt file (toc depth, display, file name), this script generates "functions/GetWorld.htm" instead of "FNC_GetWorld.htm"... so either docgen will live on, the php file could be updated. I'm not positive that it actually needs to change.
[Go to top] top

Posted by Nick Gammon   Australia  (21,322 posts)  [Biography] bio   Forum Administrator
Date Reply #7 on Sat 15 Aug 2009 03:20 AM (UTC)
Message
Didn't quite follow that last bit. I think I mentioned in a post somewhere how to convert from mysql to sqlite.

Er, here: http://www.gammon.com.au/forum/?id=9241

I can make a new copy of the database. Give me a few minutes - I have upgraded my Red Hat Linux server to Ubuntu, principally because the disk drive was starting to sound like a jet engine getting ready to take off. Hasn't failed yet, but must be a mtter of time ...

Yeah, the context IDs are probably the only tricky thing to make it bring up the right help for the right dialog box. But I think the database has them right, or if not, there is a constant to add to them.


- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top

Posted by WillFa   USA  (525 posts)  [Biography] bio
Date Reply #8 on Sat 15 Aug 2009 03:34 AM (UTC)

Amended on Sat 15 Aug 2009 03:36 AM (UTC) by WillFa

Message
Yup, I've already got the docs in a sqlite db. :) (I was the one that asked for the last update on june 30)

Sorry the last bit was me rambling outloud...

Question:
Does http://www.gammon.com.au/scripts/doc.php?general=scripting hit a mysql db that you control, or do you use docgen to make the html files which you ftp up to a server someplace? If the former, the doc.php wouldn't need to change. If the latter, my script changes your naming convention from FNC_GetInfo.htm, DLG_whatever.htm; to functions/GetInfo.htm and dialogs/whatever.htm.


Hooking up MFC links:
http://simplesamples.info/MFC/HTMLHelp.php
http://support.microsoft.com/kb/191118/EN-US/
http://msdn.microsoft.com/en-us/library/aa733986%28VS.60%29.aspx
[Go to top] top

Posted by WillFa   USA  (525 posts)  [Biography] bio
Date Reply #9 on Sat 15 Aug 2009 04:06 AM (UTC)

Amended on Sat 15 Aug 2009 04:08 AM (UTC) by WillFa

Message
Oh regarding the sqlite and mysql conversion statement...

The script starts with require "luasql.sqlite3", changing that to "luasql.mysql" and changing the db:connect(DBpath) to db:connect(DBpath, username, pw, server, port) should be all you need to generate a chm for future versions. I'm making a point to use sql statements that work in both engines.



I'm guessing but I think your current build process basically

Calls docgen.exe to generate the rtf
Calls makehelp.bat, which calls makehm a bunch of times and then calls hwc.exe to compile the .hlp file using static .hpj and .cnt files.

With the new stuff you'd:
Call HTMLhelp.lua which connects to a database, generates the html files, generates the help context ids, generates file lists, generates a Table of contents, generates the index, and then calls hhc.exe to compile the .chm file.

hhc.exe is part of the HTML Help Workshop, which you can download here: http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en
[Go to top] top

Posted by Nick Gammon   Australia  (21,322 posts)  [Biography] bio   Forum Administrator
Date Reply #10 on Sat 15 Aug 2009 04:25 AM (UTC)
Message
Latest version:

http://www.gammon.com.au/files/mushclient/src/documentation_4_43.sql.bz2

Quote:

Does http://www.gammon.com.au/scripts/doc.php?general=scripting hit a mysql db that you control ...


Yes, I unzip that file, then just do:


mysql < documentation_4_43.sql


... plus a couple of extra bits to specify the database server location, username, password etc. Basically I bang the whole SQL into the server database, which is therefore a copy of what I have locally .

I use the local copy to generate the help files, and the HTML files (when generated). The server copy is used to serve up pages like the one you mentioned.

The copy process from my local copy to the server copy is effectively the "handover" when a release goes live.



- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top

Posted by Nick Gammon   Australia  (21,322 posts)  [Biography] bio   Forum Administrator
Date Reply #11 on Sat 15 Aug 2009 04:35 AM (UTC)
Message
Quote:

Calls docgen.exe to generate the rtf
Calls makehelp.bat, which calls makehm a bunch of times and then calls hwc.exe to compile the .hlp file using static .hpj and .cnt files.


It:


  • Generates the .rtf file help.rtf from the database
  • Calls WriteMapFile (see code snippet) to quickly write out the mapping file help.hm by doing a few selects (makehm is not used).
  • Calls hcw.exe to read in the help.hpj file (copy below). This generates the mushclient.hlp file.



         WriteMapFile (db);

        // generate help file
        printf ("Generating help file ...\n");
        char * args [] = 
          {"hcw", "/C", "/M", HPJ_FILE, NULL };

        if (_execvp (args [0], args) == -1)
          perror ("Invoking help compiler");
        }



This is the help.hpj file:


; This file is maintained by HCW. Do not modify this file directly.

[OPTIONS]
COMPRESS=12 Hall Zeck
LCID=0xc09 0x0 0x0 ; English (Australian)
REPORT=Yes
CONTENTS=DOC_CONTENTS
TITLE=MUSHclient help
COPYRIGHT=Copyright 2003 Gammon Software Solutions
HLP=..\mushclient.hlp

[FILES]
help.rtf

[MAP]
#include help.hm

[WINDOWS]
main="",,27904,(r14876671),(r12632256),f2



You can see from the above that once you have help.rtf and help.hm files, the help generation is pretty straightforwards.




The contents file is totally a manual process. However after a major change I might do the subsections with a few selects as documented in comments in the docgen program, like this:


  select concat("3 ", command_name, "=CMD_", label) FROM commands ORDER BY command_name; 


Stuff like the high-level contents, is simply something I did in a text editor. (It practically never changes).

- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top

Posted by WillFa   USA  (525 posts)  [Biography] bio
Date Reply #12 on Sun 16 Aug 2009 03:48 AM (UTC)
Message
ARGHHHHHHHHHH! *flail like a muppet* ;)

All the cross references are messed up. Some use the "see_also" field, some have doc_name's. Some of the doc_name's are inconsistent (BlendPixel and FilterPixel are grouped with utils, not miniwindows... ?) Some of the doc_names are null.

There's a few orphaned help topics that aren't in the toc, which is generally okay. There's a topic in the toc that doesn't have a help file (DockToolbarNextTo, apparently killed off - google only shows it in the 4.29 diffs file) - and that causes hhc.exe to barf.

I don't mind standardizing the data - ignoring see_also and related_dialog in favor of having consistent doc_name's. Would you object to having a .sql with the full db (in sqlite syntax) available that you can munge and import into mysql? I won't alter the table schema so the php page won't break.


I'm a little concerned about putting a lot of energy into this when you had posted way back when that you didn't have the energy for it. I'm trying to have all my work cause as little work for you as possible. :)

[Go to top] top

Posted by Nick Gammon   Australia  (21,322 posts)  [Biography] bio   Forum Administrator
Date Reply #13 on Sun 16 Aug 2009 04:38 AM (UTC)
Message
BlendPixel and FilterPixel do not, strictly speaking, need a miniwindow, so I put them into utils. They simply modify a number giving another number.

You can probably ignore see_also, for one thing it isn't really third normal form, the way I did it. The idea was that see_also would list related things, perhaps not necessarily in the same document (BlendPixel would be an example).

However, discarding any orphans in see_also you should be able to get reasonable results.

Quote:

Would you object to having a .sql with the full db (in sqlite syntax) available that you can munge and import into mysql?


I don't quite understand the question. You mean your modified version, or something else?

- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top

Posted by WillFa   USA  (525 posts)  [Biography] bio
Date Reply #14 on Sun 16 Aug 2009 05:09 AM (UTC)
Message
Yea, if I go through and sort out all the stragglers so that cross links via doc_name are accurate, would you hate reimporting the whole db; opposed to sql for just the CREATE/INSERTs for the toc table and now a create view...

oh, I made a view that does a union on the 5 major tables (not errors) so I could consistently get to a filename id, title, summary, type (command, func, dialog, general, lua), and doc_name category... I had trouble remembering which table had a name vs command_name vs dialog_name... etc. Those are the 5 values I need for each cross reference link.
[Go to top] top

The dates and times for posts above are shown in Universal Co-ordinated Time (UTC).

To show them in your local time you can join the forum, and then set the 'time correction' field in your profile to the number of hours difference between your location and UTC time.


19,620 views.

This is page 1, subject is 2 pages long: 1 2  [Next page]

It is now over 60 days since the last post. This thread is closed.     [Refresh] Refresh page

Go to topic:           Search the forum


[Go to top] top

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]