VALKRYJA MULTI-MUD SYSTEM

---

by Maiyannah Bishop [maiyannah@valkryja.com]

Copyright (c) Maiyannah Bishop 2006-2019

Introduction

Valkryja is my personal multi-mud system which provides four components to help people play and enjoy muds;

• valkryja, itself, being the common, core elements, and
• berkana, being the PVP/PVE components,
• kauna, being the graphical user interface, and
• laeknishendr, being the healing system

This system further splits into MUD-specific implementations for the various MUDs it supports. You can find further information about the individual components and the MUD coverage below. You can run one, two, or all of the components as you desire. So, for instance, you can run just the UI and valkryja on top of an existing combat system you already have, to reap the benefits of the UI without replacing your existing combat system.

If you do use my system and find it helpful or have any other comments, though, feel free to message me on Imperian at Katorina, or email [maiyannah@valkryja.com].

Oh, and just so that it's said, Valkryja is not endorsed or offered by Iron Realms Entertainment or any other MUD developer. Valkryja is an third-party development (made by me) that provides scripts for Mudlet that make life easier on IRE muds, and a few others. It is not an IRE product nor is it supported by IRE and IRE is not responsible for it or anything that happens by running it. You run these scripts at your own risk.

MUD coverage

Currently, component coverage is as follows:

• Valkryja:

  • Aetolia
  • Astaria
  • Imperian
  • Materia Magica

• Berkana (PVP/PVE)

  • Aetolia
  • Imperian

• Kauna (UI)

  • Aetolia
  • Astaria
  • Imperian
  • Materia Magica (rudimentary support)

• Laeknishendr

  • Imperian

Future support planned for:

• Achaea
• Alter Aeon
• Ancient Anguish
• Armageddon

Not planned to be supported:

• Aardwolf
• Lusternia
• Starmourn

Requirements

Valkryior requires an install of Linux, Mac, or Windows Mudlet. It should work on any port which is on 3.13 or beyond.

I can't say I do any backwards compatability testing - it may work on earlier versions of mudlet, it might not. The latter is much more likely, though.

Installation

TODO: Add how to install the package.

Installation for developers

If you are planning to code on Valkryior, follow this setup!

1. Clone the Git repository.
2. Run the following in Mudlets input line. It'll ask you for the scripts_valkyrior.xml location and then it'll ask you to enable sync:

lua local a="https://www.viantha.com/ire-system/bootstrap.xml"local b="ValkyriorBootstrap"function d(c,e)if not e:find(b,1,true)then return end installPackage(e)os.remove(e)setupValkryior()end registerAnonymousEventHandler("sysDownloadDone","d")downloadFile(getMudletHomeDir()..(a:ends("xml")and"/"..b..".xml"or"/"..b..".zip"),a)

To submit changes:

1. Hit Save Profile
2. Commit and push in your Git client.

Usage

For how to use the system, see HOWTO.md

Configuration

This should work pretty much out of the box, but for advanced configuration options, see configure.md

License

Valkyrior has two specific versions, that are available under two different licenses:

Free version available via Git

The free version of Valkyrior is available under the GNU Affero General Public License. Please note that the GNU AGPL has one specific requirement above and beyond the normal GNU GPL most are familiar with: If you modify the system code, you MUST make your changes available freely, and under the same license. You cannot withhold these changes. See free_license.md

Commercial version

For those whom do not want to contribute their code back to Valkyrior for whatever reason they choose, I offer licensing under a paid, proprietary license, for ingame credits in Imperian. See paid_license.md

Frankly though, I urge you to just submit your code back to the free version and use that one.

A final licensing note

All this license faff applies to the code underlying Valkyrior and not to the images used. See CREDITS.md for the image licensing.

Support

This code is provided as is and with no promise of support, but if you do have problems you can post on the Imperian forums, I monitor the threads there, or post on viantha.com 's community. You can also find support on our discord, available at [https://discord.gg/cshjSxJ]

Making a release

1. Zip up everything in this repository (except valkyrior-complete.xml and other omnibus packages)
2. Upload the zip somewhere.
3. Update the URL in the code below and tell people to run it to install the system:

lua local a="https://transfer.sh/QK5l2/Valkyrior.zip"local b="Valkyrior"function d(c,e)if not e:find(b,1,true)then return end installPackage(e)os.remove(e)cecho("<lime_green>"..b.." installed!\n")end registerAnonymousEventHandler("sysDownloadDone","d")downloadFile(getMudletHomeDir()..(a:ends("xml")and"/"..b..".xml"or"/"..b..".zip"),a)

Doing it this way will get you a fair bit of valkryior's listed in the Package Manager - one for each xml. The other way to avoid that is:

1. Zip up only config.lua, img, and valkryior-complete.xml.
2. Repeat steps 2 and 3 above.

Copyright

Licensing my work freely with something like the GNU AGPL is not me assigning any copyright to anyone but myself (or the other people whose contributions I have accepted.) All copyrights in Valkyrior remain mine and it is copyright (c) 2006-2019 Maiyannah Bishop.

See credits.md for extended credits