From AresMUSH

Faraday's Softcode Package is a group of softcode modules for PennMUSH. Like Sandbox Globals for MUX, it provides essential functionality missing from out-of-the-box MUSH configs - globals like +who and +finger. It also provides useful utility systems like weather and a multi-descer. Lastly it provides a few advanced systems like skills and combat. It is intended to be a MUSH-In-A-Box, containing everything you need to get a typical game started.

Contents 1 Getting the Code 1.1 Fresh Install 1.2 Upgrade 1.3 License 1.4 Release Notes 1.5 Modifying the Code 2 Keeping In Touch 2.1 Mailing List 2.2 Bug Tracker 2.3 Code Repository 3 Modules 3.1 Core Modules 3.2 Addon Modules 3.3 Skill/Combat Systems 3.4 Unsupported Systems

Getting the Code

ZIP-ed releases of the code can be downloaded from GitHub.

Fresh Install

The most recent release for a fresh install: Version 7.0

See Installation for detailed instructions on installing the code.

If you're starting completely from scratch, you can find database and config files to get you up and running in minutes with the Starter DB for PennMUSH 1.8.4 p3.

Upgrade

The most recent release for upgrading: Version 6.0 upgrade

See Upgrades for general instructions on upgrading.

Note: This release requires some special upgrade steps. See Upgrading from 6.0 to 7.0 for details.

License

Read important License information about using the code.

Release Notes

See the Releases page for detailed information about each release.

Modifying the Code

The License allows you to modify the code for your own purposes (with some restrictions on including the credits and so forth; please consult the license info for details). However, before you do so I suggest you read Modifying the Softcode for some tips and warnings.

Keeping In Touch

Mailing List

You can join the Mailing List to ask questions, report problems, and receive updates about new releases.

Bug Tracker

You can also submit bugs directly via the Bug Tracker

Code Repository

For the coders among you who may want to see detailed changes, the code is available via GIT (read-only) on GitHub.

Modules

This softcode system is designed to work as a cohesive whole. However, the system is modular to an extent. Some of the modules are required for basic functionality, but most are optional. You can pick and choose the ones you want for your game.

Core Modules

The Core Modules are expected as part of any installation. They contain core functionality that most of the other systems rely on in one form or another.

• Install Manager
• Global Functions
• Player Setup
• +help
• FaraMail
• Staff Jobs
• Myrddin's BBS
• Myrddin's Cron
• Hook Manager
• IC Time - Configurable IC Time System.

Help, Mail and Jobs can be worked around with a modest amount of effort. You could, for example, substitute your own +help or +mail system. However, I neither recommend nor support (beyond simple questions) this sort of configuration.

The last few (BBS, Cron, Hook and IC Time) are required for several systems, so I include them in Core. You could do without them if you are willing to do without BBS posts for various systems, if you have some other kind of cron system to periodically execute certain tasks, or if you install the @hooks manually for the systems that need them, and if you have your own custom ictime() function.

Addon Modules

The Addons are optional modules that you can add on to the core functionality. Although there are a few inter-dependencies, most Addon modules can be used independently as long as the Core Modules are installed.

• +actors - Tracks character actors.
• +alts - Alts tracker
• Autospacer - Puts blank spaces before poses for easier reading
• +bg - Background System
• +census - Census and Orgs System (tracks organizations/factions/positions too)
• +cookies - Cookie (nom) Reward System with Luck Points
• +desc - Multi-Descer
• Disclaimer - System for enforcing a terms of service or disclaimer agreement.
• +events - Events System
• +finger - Finger System
• +friends - Friends System
• Globals - Miscellaneous Globals
• Idle Purger - Idle Purger
• +map - Map System
• +meetme - Join players for RP
• +motd - Message of the Day System
• +news - Softcoded news system
• Room Parents - Room parents for basic, places and TP Rooms.
• Staff Commands - Miscellaneous Staff Globals
• Weather - A simple weather generator
• Who - Configurable who system

Skill/Combat Systems

• FS3 - Custom skills system that also includes a combat module and character creation.

Unsupported Systems

These systems are in mothballs, replaced by newer systems or just died to lack of interest.

• FUDGE - The FUDGE system. (replaced by FS3)
• WOD Skills - World of Darkness skills system (one-off I did for a friend)
• +awards - Sophisticated awards system. (replaced by +cookie)
• +term - Simple data terminal
• BabCom - IC communications system for a Babylon5 game.
• +roster - Roster system
• +tp - Tinyplot tracker (replaced by +events)
• Postmaster - Simple +mail (replace by Faramail)