The official, canonical repository of the Valkyrior mudlet system

Maiyannah Bishop 7eab0f230c [Imp] Fix tells capture, addresses #37 36 minutes ago
img 7789c8f6c9 Hopefully we can have an image background for the chat window someday 1 week ago
.gitignore 2cbf3b0b99 Add avatars to the gitignore 1 month ago
alias_combat.xml ddaa9d5962 Fix to make the core combat stuff MUD-agnostic 1 month ago
alias_imperian.xml b6ad608de8 [Imp] Clear defences and the status icons display properly 4 weeks ago
alias_materiamagica.xml 1cc22d8868 Silly mudlet formatting change which is nonsensical 11 months ago
config.lua 4ad2e773dc Remove config.lua and check it in to VCS 1 year ago
credits.md ce181304e0 Wording/formatting fixup in credits and a clarification. 1 year ago
free_license.md ad47e693e3 Initial checkin 1 year ago
keybind_f5.xml 3ac5c19525 [Imp] Make backflip movement configurable in the Config 1 week ago
licensees.md ad47e693e3 Initial checkin 1 year ago
paid_license.md 7087594ed7 Update paid license for Aetolia move. 7 months ago
readme.md 2f1893b179 Some changes for naming consistency 2 weeks ago
scripts_UI.xml 6476a2c10e Allow user customisation of the font-family via Config.FontFamily 4 hours ago
scripts_aetolia.xml 2a32257e0f General code cleanup (tabs to spaces, remove trailing spaces) 2 weeks ago
scripts_character.xml cfd9a0e8cb Colourise the status messages that aren't specified good/bad as well. 1 week ago
scripts_combat.xml c6cad8e9e8 Clean up the auto-bashing, put the mud-specific stuff in scripts_imperian 1 week ago
scripts_imperian.xml 5850eb0fea [Imp] Add a toggle to display captured chat in the main console or not 46 minutes ago
scripts_luminari.xml 2a32257e0f General code cleanup (tabs to spaces, remove trailing spaces) 2 weeks ago
scripts_materiamagica.xml 2a32257e0f General code cleanup (tabs to spaces, remove trailing spaces) 2 weeks ago
scripts_room.xml e28abaa725 [Imp] Comment out the malfunctioning Mobiles count until its fixed 37 minutes ago
scripts_valkyrior.xml 6476a2c10e Allow user customisation of the font-family via Config.FontFamily 4 hours ago
setup_valkyrior.xml 2a32257e0f General code cleanup (tabs to spaces, remove trailing spaces) 2 weeks ago
timers_aetolia.xml 1e30921f21 Save Aetolia timers as seperate module. 7 months ago
timers_character.xml 9666f8b05f [Imp] Disable defences harvest trigger until we can make it less spammy 1 week ago
triggers_aetolia.xml d6286bad50 [Aet] New mudlet format malarkey 1 month ago
triggers_imperian.xml 7eab0f230c [Imp] Fix tells capture, addresses #37 36 minutes ago
triggers_luminari.xml 52d042031e [lum] Get basic character stats from score. 8 months ago
triggers_materiamagica.xml dcc85b1c82 [MM] Add decolourize triggers 11 months ago
valkyrior-complete-aetolia.xml a8e07a59e3 Update the omnibus module with a checkpoint of sorts. 7 months ago
valkyrior-complete-imperian.xml bc7bc86d7d [Imp] Update complete Imperian package 6 hours ago

readme.md

VALKYRIOR IMPERIAN SYSTEM


by Maiyannah Bishop (Evalyne) evalyne@viantha.com Copyright (c) Maiyannah Bishop 2006-2018

Introduction

Valkryior is my personal system for IRE muds, or the latest iteration of it anyways. Anything I have automatically scripted, in my system, will be available here. In general, this means that a lot of messages will be condensed from many disparate lines into singular lines, several onerous tasks such as bashing are automated, and information is presented in a UI that I find pleasing.

This system isn't really designed or anyone but myself, I just make it available with the hope that perhaps someone else whom uses Mudlet and plays IRE MUDs may find it helpful. As such it is provided AS IS, without warranty of any kind, including merchantability or fitness for a specific purpose.

The primary appeal of the system is probably the UI, and you can feel free to just use that as a foundation for your own system so long as you follow the licensing terms.

If you do use my system and find it helpful or have any other comments, though, feel free to message me on Imperian at Havamal, or email havamal@viantha.com.

Oh, and just so that it's said, Valkyrior is not endorsed or offered by Iron Realms Entertainment. Valkyrior is an third-party development (made by me) that provides scripts for Mudlet that make life easier on IRE muds. 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.

PORT NOTE

This is a port of the original Valkyrior system to Mudlet.

IT IS NOT COMPLETE. It may catch fire and explode. It may crash your system and corrupt files. It might be terrible. You have been warned.

Requirements

Valkryior requires an install of Linux, Mac, or Windows Mudlet. It should work on any port which is on 3.0 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.

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-2018 Maiyannah Bishop.

See credits.md for extended credits