Directory Structure

From BattletechMUX

Jump to: navigation, search
HardCode Section Navigation


Contents

/btmux

Also known as the btmux root directory, this is the top level directory within most installs. From here you may configure and compile your game.

doc

Contains some misc. documents. Most of these can be found on the Wiki in a more up to date form.

event

Even system source code.

game

This is the default game directory. The first time you Image:Command.gif make install, it is copied to game.run, where your active copy resides.

game.run

This is your active BattletechMUX game directory. You will want to run from and make modifications to the things under here, not the game directory.

  • alias.conf - Misc. command/function aliases.
  • compat.conf - MUSH 1 compatability aliases and configs. Slated for deprecation.
  • econ.db - Holds part/commod pricing information.
  • Startmux - Used to start your game.
  • mux.conf - Top level configuration, shouldn't need to touch this.
  • netmux.conf - Various important configuration directives.
  • netmux.log - Log file for your game. Won't be created until you first startup.

bin

Home of your game's binary files, used to run your game.

data

Game database files go here.

  • commac.db - Comsys and macro stuff.
  • hcode.db - Holds data related to any XCODE object.
  • mail.db - Mail messages and aliases.
  • netmux.db - Your actual game database.
  • netmux.db.new - The database that is currently active and being written to. Will be copied to netmux.db on startup.
  • netmux.db.old - The netmux.db that was replaced with netmux.db.new.

logs

Admin-defined log files, generally populated by @log.

maps

Holds your game's map files.

mechs

Holds your game's template files.

text

Holds your game's help/news files.

include

Various C source include files.

misc

Some misc. C source files.

python

Various python scripts.

src

The source for the MUX and Battletech extensions.

tree

C source for some trees used in the src directory.

clients
development