Easy Installation & Map Management Guide

##Easy Installation & Map Management Guide This simple installation guide is updated for the latest changes in Cardinal, including remote and default repositories. This guide is intended to help get a server started as fast as possible. The second section explains how to use new repository features, including local and remote repositories.

Step-by-step Installation or Update Guide

1. Stop the server (if it's running)
2. Download the latest version of Sportbukkit 1.11 here.
3. Download the latest version of Cardinal here.
4. In the server folder, place the Sportbukkit jar (downloaded in step 2).
5. In the plugin folder, place the Cardinal jar (downloaded in step 3).
6. Edit the server's bukkit.yml, below settings: add a new line with legacy-knockback: true, and add a new line with water-pushes-tnt: false if it isn't already present (may require starting and stopping the server to genorate the file). Example: lines 16 & 17
7. Start the server.

Maps & Repositories

Maps are managed in repositories, each repository contains a list of maps (run /repos to see a list of repos), by default, a server will have the "DefaultRepository" (built into the jar) and the "maps" repository, which will load all the maps inside the maps directory located in the server's runtime directory. Repositories are defined in the config file, for example:

repos:
- maps
- git:https://github.com/Pablete1234/PPTM
- git:https://user:password@someServer.com/Some/Path/HiddenRepo

This server would load 4 repositories (/repos example with 3 repos):

1. DefaultRepository, provides fallback/default map.
2. FileRepository (maps), loads all maps inside the maps folder.
3. GitRepository (PPTM), will load all the maps in the public PPTM git repo hosted on github.com.
4. GitRepository (HiddenRepo), will load all maps in the private repo, connecting as user:password hosted in someServer.com

Both local repositories and remote password-protected repositories will remain hidden to non-op players for security purposes.

Players with op will be able to see the path for the repository, however the user and password will still be hidden.

All repositories can be reloaded with /newmaps. Make sure to run /cardinal -r to reload the config first if the config was edited (added/removed repositories).

Taking advantage of new remote repository features is highly encouraged as it provides multiple benefits and ease of use. Remote repositories are handled by a maintainer, and all the user needs to do to keep maps up-to-date is run /newmaps, which fetches the late latest maps from the remote repository.

Map Commands

The introduction of multiple repositories will end up creating duplicate maps A single server may have many repositories and guaranteeing each map is only loaded once between all the repositories is unlikely. To handle naming conflicts between duplicate maps, the plugin allows maps to be referenced by a map id.

Loaded maps will be assigned an id when they are added to the server (note: this id is not permanent and may change on server restart or when running /newmaps). All commands that display a map have a -l (long) argument (ex: /next -l, maps -l [page], map -l [mapName]) and all the commands that use a map as argument, now have a -m (map) argument (ex: /setnext -m 30, /cycle 10 -m 30, /map -lm 30). If an ambiguous map name is used (/map go), the server will print a list of maps and their ids, which can be replace the map name in the command.

Another note: /map -l will show the repository the map comes from, allowing the user to use that to pick between two maps (run /map [name], run /map -lm [id] with all the maps that matched the name, and see which map is from the desired repository).