Getting and Updating the Source
From BattletechMUX
Hardcode Index · Getting the Source · Compile-Time Directives · Config Directives
The only supported method for getting the BattletechMUX source code right now is via our Subversion repository. By checking the source out from there, you may easily apply updates or generate patches to submit. If you don't know what Subversion is or would like to know where/how to get it, see our Subversion page.
Contents |
Trunk
The Subversion trunk is where the latest stable version of the codebase resides. Changes are incrementally checked in as bugs are founds and improvements are made. Big re-writes or changes are typically segregated out into a different branch where they may be tested and developed. To check out the trunk, you need Subversion.
Once you have Subversion, type this from your shell:
svn co https://btonline-btech.svn.sourceforge.net/svnroot/btonline-btech/btmux/trunk btmux
Build Requirements
In order to compile the source, you will need the following:
- gcc (4.0 or higher strongly recommended)
- crypt (libcrypt/lcrypt)
- libevent (Look for the libevent-dev or libevent package if you're running Linux)
- libdbi and the libdbi-mysql driver (Optional, only if you want SQL support.)
- autoconf
Configuring and Compiling
After grabbing the source, you can issue a:
make -f Makefile.dist (Only required for the dev trunk, releases will already have a configure file generated) ./configure make install
And if all goes well, the latest version of the game directory and its sub-directories will be checked out. Note that you must have Subversion installed for this to be done automatically.
| Note: Read the README and INSTALL files for instructions on setting things up. |
| Tip: For more information on the various projects you can check out from our Subversion repository, see our Subversion Projects Page. |
|
| Tip: See the list of compile-time options for a better description of what each does. |
Where to go from Here
Start by reading the README and INSTALL files in your btmux directory. You will have done most (if not all) of the steps outlined in INSTALL already, but you'll need to look towards the end of the document in Section 5 for the default #1 password (change it immediately upon first connecting!).
Getting Help
Any of the links below are great places to get help. For general questions about softcode and hardcode, try the BattletechMUX Community Portal or the mailing list. Alternatively, connect to the Frontier, join the BTMux channel, and ask on there.
Keeping up to Date
One of the benefits to tracking our source with Subversion is that updates may be easily distributed by the developers and applied by each game's administrator. To receive an email when Subversion commits happen, we suggest signing up for the BTMux-Commits mailing list. This will keep you up to date with the latest developments in BTMux.
The easiest way to update is to issue a make update from the root BattletechMUX directory. Note that if you have modified your source, you may get some update failures. It's better to submit feature requests or patches if you don't want to have to hand-patch updates made by the main distribution. It's a lot easier to hit make update than to look through diff files and compare things.
make update make clean make make install
