readme.md 5.6 KB
Newer Older
Maiyannah Bishop's avatar
Maiyannah Bishop committed
1
![](http://git.postactiv.com/maiyannah/valkyrior/raw/master/img/valkryja-websplash.png)
2
# VALKRYJA MULTI-MUD SYSTEM
3 4
--------------------------------------------------------------------------------
by Maiyannah Bishop [maiyannah@valkryja.com]
5

6
Copyright (c) Maiyannah Bishop 2006-2019
Maiyannah Bishop's avatar
Maiyannah Bishop committed
7 8

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

12 13 14 15
 * *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
16 17 18 19 20 21 22

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.
23

Maiyannah Bishop's avatar
Maiyannah Bishop committed
24
If you do use my system and find it helpful or have any other comments, though,
25
feel free to message me on Imperian at Katorina, or email [maiyannah@valkryja.com].
Maiyannah Bishop's avatar
Maiyannah Bishop committed
26

27 28
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
29
development (made by me) that provides scripts for Mudlet that make life easier
30 31 32
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.
Maiyannah Bishop's avatar
Maiyannah Bishop committed
33

34 35
## MUD coverage
Currently, component coverage is as follows:
Maiyannah Bishop's avatar
Maiyannah Bishop committed
36

Maiyannah Bishop's avatar
Maiyannah Bishop committed
37
* Valkryja:
38 39 40 41
   * Aetolia
   * Imperian
   * Luminari
   * Materia Magica
Maiyannah Bishop's avatar
Maiyannah Bishop committed
42 43

* Berkana (PVP/PVE)
44 45
   * Aetolia
   * Imperian
Maiyannah Bishop's avatar
Maiyannah Bishop committed
46 47

* Kauna (UI)
48 49 50 51
   * Aetolia
   * Imperian
   * Luminari
   * Materia Magica (rudimentary support)
Maiyannah Bishop's avatar
Maiyannah Bishop committed
52

Maiyannah Bishop's avatar
Maiyannah Bishop committed
53
* Laeknishendr
54
   * Imperian
Maiyannah Bishop's avatar
Maiyannah Bishop committed
55

56 57 58 59 60 61 62 63 64 65 66
Future support planned for:
 * Achaea
 * Alter Aeon
 * Ancient Anguish
 * Armageddon
 * Lusternia
 * Starmourn

Not planned to be supported:
* Aardwolf

67 68
## Requirements
Valkryior requires an install of Linux, Mac, or Windows Mudlet.  It should work
69
on any port which is on 3.13 or beyond.
Maiyannah Bishop's avatar
Maiyannah Bishop committed
70

71 72 73
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.

Maiyannah Bishop's avatar
Maiyannah Bishop committed
74

75
## Installation
Maiyannah Bishop's avatar
Maiyannah Bishop committed
76

77
TODO: Add how to install the package.
Maiyannah Bishop's avatar
Maiyannah Bishop committed
78

79 80 81 82
## Installation for developers
If you are planning to code on Valkryior, follow this setup!

1. Clone the Git repository.
Maiyannah Bishop's avatar
Maiyannah Bishop committed
83 84
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:
85 86 87 88 89 90
```
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`
Maiyannah Bishop's avatar
Maiyannah Bishop committed
91
2. Commit and push in your Git client.
92

93
## Usage
Maiyannah Bishop's avatar
Maiyannah Bishop committed
94

95
For how to use the system, see HOWTO.md
Maiyannah Bishop's avatar
Maiyannah Bishop committed
96

97
## Configuration
Maiyannah Bishop's avatar
Maiyannah Bishop committed
98

99 100
This should work pretty much out of the box, but for advanced configuration
options, see configure.md
Maiyannah Bishop's avatar
Maiyannah Bishop committed
101 102 103 104 105 106 107 108 109 110 111 112 113

## 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
114
For those whom do not want to contribute their code back to Valkyrior for
Maiyannah Bishop's avatar
Maiyannah Bishop committed
115 116 117 118 119 120
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.

121 122 123 124
### 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.

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

131
## Making a release
Maiyannah Bishop's avatar
Maiyannah Bishop committed
132 133 134 135 136
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:
Vadim Peretokin's avatar
Vadim Peretokin committed
137
```
138 139 140 141 142 143 144
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`.
1. Repeat steps 2 and 3 above.

Maiyannah Bishop's avatar
Maiyannah Bishop committed
145 146 147
## 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
148
have accepted.)  All copyrights in Valkyrior remain mine and it is copyright (c)
149
2006-2019 Maiyannah Bishop.
Maiyannah Bishop's avatar
Maiyannah Bishop committed
150

151
See credits.md for extended credits