Skip to content

Commit

Permalink
Removed MF 5 upgrade instructions from README (#1812)
Browse files Browse the repository at this point in the history
  • Loading branch information
dmccoystephenson authored Nov 10, 2024
1 parent dd86742 commit a76299a
Showing 1 changed file with 1 addition and 27 deletions.
28 changes: 1 addition & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,40 +5,14 @@ Medieval Factions is a system of mechanics that allows for the simulation of sov

A list of features can be found [here](https://github.com/dmccoystephenson/Medieval-Factions/wiki/Features).

### Fifth Major Version - MF 5
Medieval Factions 5 reimagines and reworks everything about the plugin. The development of the fifth major version of MF was led by [alyphen](https://github.com/alyphen) (creator of [RPKit](https://github.com/RP-Kit/RPKit/wiki)). Huge thanks to her!

#### What's changed
This is a complete rewrite of Medieval Factions so everything has received a fresh coat of paint since 4.6.x/4.7.x. Commands, permissions, placeholders, etc should mostly be compatible, though some things have changed, such as locks, roles, and force commands.
The development of the fifth major version of MF was led by [alyphen](https://github.com/alyphen) (creator of [RPKit](https://github.com/RP-Kit/RPKit/wiki)). Huge thanks to her!

## Installation
### First Time Installation
1) You can download the plugin from [this page](https://www.spigotmc.org/resources/medieval-factions-sovereign-nation-simulator.79941/updates).
2) Once downloaded, place the jar in the plugins folder of your server files.
3) Restart your server.

### Upgrading from Medieval Factions 4

1. If you have a Medieval Factions 4 install, replace the Medieval Factions 4 jar with Medieval Factions 5.

2. On the next start, Medieval Factions 5 will detect the Medieval Factions 4 config and make a backup of all of the data in mf4_backup in the data folder. It will then proceed to generate the new config file, and shut down the server.

3. At this point, you should configure your database, if you have one.

If you have MySQL or MariaDB database, this should look something like:

```
database:
url: 'jdbc:mysql://127.0.0.1/database'
dialect: 'MYSQL'
username: 'username'
password: 'password'
```

If you do not have a MySQL database, you can ignore this, as the plugin will create an h2 file-based database in your server's working directory.

4. Start the server one more time, and the configuration and data from the Medieval Factions 4 backup will be migrated to your new Medieval Factions 5 install.

### Dynmap Integration
Dynmap has been integrated with this plugin. In order to be able to view claimed land on a dynamic map, download and install the plugin [here](https://www.spigotmc.org/resources/dynmap.274/).

Expand Down

0 comments on commit a76299a

Please sign in to comment.