Release MVE2i

Author: peterekepeter

docs/changelog.md

@@ -1,4 +1,4 @@
-# `MVE2i` **TODO** February 2026
+# `MVE2i` 25 February 2026
 
 This release contains 2 years of upgrades and improvements. The main focus has
 been improving compatibility, fixing bugs and some new features for admins and

docs/feature-documentation.md

@@ -39,6 +39,19 @@ gain a bit of understanding, you'll be able to make larger changes with
 confidence, but until then make the smallest changes and see what it does. 
 
 
+## Travel State
+
+MapVote holds between map switches in a special file called `MVE_Travel.ini`
+If mapvote crashes or if the current map is deleted it's possible for this 
+file to contain instructions to switch to a map or load a gametype for which
+the packages no longer exist. This can cause a crashloop where mapvote will 
+keep trying to switch to the map that does not exist.
+
+To reset the travel state simply vote for a mode and map and which works. If 
+it's not possible to bring up mapvote anymore then an admin needs to delete 
+the `MVE_Travel.ini` file and restart the server to start from a clean state.
+
+
 ## Map Lists (aka FilterCode)
 
 Every gametype you configure requires a list of maps. The list of maps to be 
@@ -260,11 +273,11 @@ The following configuration properties support aliases:
 - MainServerPackages
 - CustomGame[n].ExcludeMutators
 - DefaultSettings
-- CustomGame[i].Settings
+- CustomGame[n].Settings
 - DefaultUrlParameters
-- CustomGame[i].UrlParameters
-- CustomGame[i].GameClass
-- Aliases[i]
+- CustomGame[n].UrlParameters
+- CustomGame[n].GameClass
+- Aliases[n]
 
 The aliases are recursively resolved. This is a fancy way of saying that an 
 alias can be used inside another alias. In practice what this means is that 

docs/quickstart.txt

@@ -122,6 +122,13 @@ III. Troubleshooting
     Restore this configuration from a stock install of UT99 if needed to.
 
 
+4. Map vote is crash looping trying to switch to map
+
+    A. The most likely cause that triggers this is a missing map or missing 
+    packages. Please investigate the server log for problems. Delete the 
+    `MVE_Travel.ini` to reset mapvote's state.
+
+
 IV. Additional Support
 ======================
 

readme.md

@@ -1,5 +1,5 @@
 
-# MVE - Map Vote Extended 
+# MVE - Map Vote Extended
 
 [![ci](../../workflows/ci/badge.svg)](../../actions/workflows/ci.yml)
 
@@ -8,33 +8,56 @@ MapVote lets players to choose the next gametype and map when a match ends.
 
 ![Screeshot of MapVote](./docs/map-vote-screen.png)
 
+## Features
+
+This mapvote is mainly focused on enabling multi-gametype servers. There was 
+also a lot of work on compatibility so that it can load any gametype, mutator, 
+package combination and mapvote itself can be run in multiple ways. 
+
+Important Features:
+- ServerPackages set per gametype -> Players only download what's needed for 
+  the current gametype, not the whole server.
+- Mutators, ServerActors, settings configurable per gametype
+- Map overrides allow map specific configuration (limited to a few configuration props)
+
 Map management:
- - include/exclude filters
- - map prefix filter
- - map tags filter
- - premade lists
+ - Include/exclude filters
+ - Map prefix filter
+ - Map tags filter
+ - Fixed order premade lists
 
-Compatible with:
+Compatible with gametypes:
  - Assault (including LeagueAssault)
  - Jailbreak (fixed spectator bug)
  - Coop campaigns with fixed map order
  - DeathMatch, CTF & Domination
  - MonsterHunt
  - BunnyTrack
 
-Important Features:
- - ServerPackages set per gametype, players only download what's needed for 
-   the current gametype.
- - Mutators, ServerActors, settings are all configurable individually 
-   for every gametype.
+For more info read the [documentation](./docs/feature-documentation.md).
+There also have a [changelog](./docs/changelog.md).
 
 
 ## Installation
 
-To install, grab one of the [latest release](../../releases/latest) and follow the readme 
-from the that comes with the release. You should be able to find an 
-[installation guide](./ReleaseFiles/MVE2dev/Help/Map%20Vote%20Extended.txt)
-inside the Help folder.
+To install, grab one of the [latest release](../../releases/latest) and follow 
+the [quickstarter](./docs/quickstart.txt) readme. Which should be located in
+the Help folder of any release package.
+
+
+## Bugs and feature requests
+
+You can use github issues for this, it will be easy to track the issue that
+way. I may not be able to respond immediately. For server setup help please 
+contact the UT99 community first as there are many admins familiar with this 
+mapvote they may be able to help with your problem before I even read the 
+message.
+
+For bugs relevant log and configuration snippets are appreciated without which
+it can be hard to guess what's going on.
+
+Feature requests will be weighted based on the fesability and usefulness and
+whether it makes sense for it to be withing mapvote.
 
 
 ## Development
@@ -46,6 +69,8 @@ To package a release, make the neccesay changes inside `./ReleaseFiles` then
 copy the built *.u files to the System folder inside `./ReleaseFiles`, package
 this all together.
 
+There is also [release.sh](./scripts/release.sh) which automates this process.
+
 Recommended development environment:
  - editor [VsCodium](https://vscodium.com/) or [VsCode](https://code.visualstudio.com/)
  - language support [ucx](https://marketplace.visualstudio.com/search?term=ucx&target=VSCode)
@@ -55,15 +80,27 @@ Recommended development environment:
  - [nodemon](https://nodemon.io/) is needed for watch tasks to work
 
 Alternatively what I recommend is to grab the release archive and extract the code
-from the release packages. That way you can still modify and debug, but if you
-plan on submittin a PR then you will have to re-apply your local changes on
-top of this repository.
+from the release packages. That way you can still modify and debug.
 
 The project uses unit tests. These must always be green to ensure the correct
 function of logic classes. The test code can be found in separate packages.
 To run the tests you need to run [TestMVE.TestAll.TestMain()](TestMVE/Classes/TestAll.uc)
 This can be done by running `ucc TestMVE.TestAll`
 
-MVE has a long history of development with contributions from many people.
 
-Each author retains copyright to their code.
+## History, license and forks
+
+MVE has a long history of development with contributions from many people.
+The project was copied, decompiled and modified by multiple people which is 
+why the code itself is quite the spaghetti monster. I've been doing my best to
+clean things up and have rewritten major parts of this software already and I 
+hope to continue cleaning it up.
+
+Theoretically each author retains copyright to their code, but as with most
+UT99 mutators, things get copied and modified so feel free to do so yourself.
+I will not come with pitchfork after you and hopefully neither will my 
+prececessors who built layed the foundation pieces for this mapvote. I can also
+neither provide any support or warranty of any sorts.
+
+There are probably hundreds of forks floating around of the original mapvote 
+anyways and I also know of a few forks of this mapvote too.