Skip to content

GoMudEngine/MudletUI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GoMudUI

A modern, feature-rich Mudlet UI package for the Official GoMud engine. This UI package enhances your GoMud gaming experience with a clean, intuitive interface and powerful functionality.

Features

  • Modern UI Components: Clean and intuitive interface elements for better gameplay experience
  • Customizable Settings: Extensive configuration options to tailor the UI to your preferences
  • Event-Driven Architecture: Efficient handling of game events and updates
  • Container Management: Advanced container tracking and management system
  • Informational Displays: Real-time game information and status updates
  • Self-updating: The UI is self-updating to the newest release on Github

Installation

Option 1: In-Game Installation

  1. Connect to GoMud using Mudlet
  2. Type install ui in the game
  3. Follow the on-screen prompts to complete the installation
  4. Optionally reconnect to the game the "kick-start" the gmpc data

Option 2: In-Client Installation

  1. Connect to the game or open the profile as "Offline"
  2. Use this command in Mudlet: 'lua installPackage("https://github.com/GoMudEngine/MudletUI/releases/latest/download/GoMudUI.mpackage")'
  3. Optionally reconnect to the game to "kick-start" the gmpc data

Option 3: Manual Package Installation

  1. Download the latest .mpackage file from the releases page
  2. Open Mudlet
  3. Go to Settings → Package Manager
  4. Click "Import" and select the downloaded .mpackage file

Option 4: Building from Source

  1. Clone or fork the repository:
    git clone https://github.com/GoMudEngine/MudletUI.git
    cd GoMudUI
  2. Install Muddler (a build tool for Mudlet packages)
  3. Run Muddler to build the package:
    muddler
  4. The built .mpackage file will be in the build directory
  5. Import the package using Mudlet's Package Manager as described in Option 2

Configuration

The UI can be customized through the settings panel. More settings are available using the "ui" command in Mudlet.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Credits

Created by Morquin, inspired by Durd of Asteria Copyright (c) 2025