Skip to content

jasonstolaruk/CurryMUD

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
res
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

CurryMUD

A Multi-User Dungeon ("MUD") server in Haskell. (If you are unfamiliar with the term "MUD," please refer to this Wikipedia article.)

CurryMUD is the hobby project and brainchild of a single developer. It's been in active development for 4 years, but is still very much a work in progress.

My goals

My aim is to create a unique, playable MUD. I am writing this MUD entirely in Haskell, from scratch.

Creating a framework which others can leverage to develop their own MUDs is not an explicit goal of mine, nor is this a collaborative effort (I am not accepting PRs). Having said that, the code is available here on GitHub, so other parties are free to examine the code and develop their own forks. Please refer to the license, which is a 3-clause BSD license with additional unique clauses regarding the creation of derivative MUDs.

CurryMUD will have the following features:

  • Players will be offered an immersive virtual world environment.
  • Content will be created and development will proceed with the aim of supporting a small community of players.
  • Role-playing will be strictly enforced.
  • Classless/skill-based.
  • Permadeath (when player characters die, they really die).
  • Some degree of player-created content will be allowed and encouraged.
  • The state of the virtual world will be highly persisted upon server shutdown.
  • As is common with most MUDs, client connections will be supported with a loose implementation of the telnet protocol.
  • CurryMUD will always be free to play. No pay-to-win.

What I have so far

  • About 95 player commands, 60 administrator commands, and 65 commands for debugging purposes. 🔢
  • About 220 built-in emotes. 👏
  • Help files for all existing non-debug commands. Help topics. 💁
  • Commands have a consistent structure and a unique syntax for indicating target locations and quantities. 🎯
  • Unique commands, accessible only when a player is in a particular room, may be created. 🏡
  • Nearly everything may be abbreviated. 🔤
  • Logging. 📜
  • ANSI color. 🔴
  • Character creation with optional readymade templates. 🏃
  • The virtual world is automatically persisted at regular intervals and at shutdown. 💾
  • Commands for reporting bugs and typos. 🐛
  • Commands to aid in the process of resetting a forgotten password. 🛂
  • NPCs can execute commands, either from within code or via the ":as" administrator command. 🎭
  • PCs can introduce themselves to each other. 🙇
  • PCs can "link" with each other so as to enable "tells." 🔗
  • Question channel for OOC newbie Q&A.
  • Players can create their own ad-hoc channels. 👥
  • Free-form emotes and built-in emotes may be used in "tells" and channel communications. 👏
  • Functionality enabling one-on-one communication between players and administrators. 💬
  • Weight and encumbrance. 📉
  • Volume and container capacity. 🎒
  • Vessels containing liquids. Vessels may be filled and emptied. 🍷
  • Light and darkness. 🌞
  • Light sources (torches and oil lamps) that may be lit and extinguished. Lamps may be refueled. 🏮
  • Players can interact with permanent room fixtures that are not listed in a room's inventory.
  • Objects can be configured to automatically disappear when left on the ground for some time. 💥
  • Smell and taste. Listen. 👃👅👂
  • Eating and drinking. Digestion. 🍞🍺
  • Durational effects that can be paused and resumed. Corresponding feelings. 💫
  • PC and NPC death. Corpse decomposition. 💀
  • Corpses may be sacrificed using the holy symbol of a particular god. 🙏
  • Upon death, PCs may have a limited amount of time to exist in the virtual world as spirits. 👼
  • Maps of the game world. 🌎
  • A history of the game world. 📚
  • Gods. An origin myth describing the creation of the universe. :godmode:
  • An in-game calendar. 📆
  • Server settings are specified in a YAML file. 🔕
  • Sending GMCP Char.Vitals and Info.Room. 📡
  • Mudlet scripts for vitals gauges and mapping. 📜
  • A cheatsheet PDF. 📝

I am still in the initial stage of developing basic commands. There is very little content in the virtual world.

About the code

The code is available here on GitHub under this license (a 3-clause BSD license with additional unique clauses regarding the creation of derivative MUDs.) Please note that I am not accepting PRs.

  • About 42,000 lines of code/text.
  • About 120 modules, excluding tests.
  • About 105 unit and property tests (I'm using the tasty testing framework).
  • A ReaderT monad transformer stack with the entire world state inside a single IORef.
  • STM-based concurrency.
  • Using aeson (with conduit) and sqlite-simple for persistence.
  • Heavy use of the lens library.
  • Heavy use of GHC extensions, including:
    • DuplicateRecordFields
    • LambdaCase
    • MonadComprehensions
    • MultiWayIf
    • NamedFieldPuns
    • ParallelListComp
    • PatternSynonyms
    • RebindableSyntax
    • RecordWildCards
    • TupleSections
    • TypeApplications
    • ViewPatterns
  • Many functions are decorated with the HasCallStack constraint. I hope to remove these when I'm convinced that the code is stable.

How to try it out

Linux and macOS are supported. Sorry, but Windows is not supported.

Please build with stack:

  1. Install the pcre library if necessary. (On macOS, brew install pcre should be sufficient.)
  2. Install stack.
  3. Clone the repo from your home directory (the server expects to find various folders under $HOME/CurryMUD).
  4. Inside $HOME/CurryMUD, run stack setup to get GHC 8 on your machine. (The stack.yaml file points to a recent resolver using GHC 8.)
  5. Run stack build to compile the curry binary and libraries.
  6. Run stack install to copy the curry binary to $HOME/.local/bin.
  7. Execute the curry binary.
  8. Telnet to localhost port 9696 to play. (Better yet, use a MUD client.)

How to contact me

Feel free to email me at the address associated with my GitHub account if you have any questions.