Skip to content

Commit

Permalink
Update source code readme information
Browse files Browse the repository at this point in the history
  • Loading branch information
peterekepeter committed Jun 29, 2023
1 parent 33cf425 commit f2950bd
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@

# MVE - Map Vote Extended
# MVE - Map Vote Extended ![ci](../../workflows/ci/badge.svg)


MapVote lets players to choose the next gametype and map when a match ends.

Expand All @@ -24,3 +25,40 @@ Important Features:
the current gametype.
- Mutators, ServerActors, settings are all configurable individually
for every gametype.


## 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/MVE2g-v1/Help/Map%20Vote%20Extended.txt)
inside the Help folder.


## Development

I use the following setup for development:
- editor [VsCodium](https://vscodium.com/) or [VsCode](https://code.visualstudio.com/)
- language support [ucx](https://marketplace.visualstudio.com/search?term=ucx&target=VSCode)
- build tool [ucx](https://www.npmjs.com/package/ucx)
- [tasks.json](.vscode/tasks.json) comes with preconfigured tasks to build & run
I map run task to keyboard shortcut so I can quickly run from code editor.
- I use [nodemon](https://nodemon.io/) to auto launch tasks when source code
changes. I use this mostly for TDD

If you clone the repo I recommend following this way, as the build tool makes
use of source code transpilation.

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

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)


MVE has a long history of development with contributions from many people.

Each author retains copyright to their code.

0 comments on commit f2950bd

Please sign in to comment.