├── src
    └── main
    │   ├── resources
    │       └── plugin.yml
    │   └── java
    │       └── me
    │           └── missionary
    │               └── board
    │                   ├── settings
    │                       ├── ScoreDirection.java
    │                       └── BoardSettings.java
    │                   ├── provider
    │                       └── BoardProvider.java
    │                   ├── board
    │                       ├── tasks
    │                       │   └── BoardUpdateTask.java
    │                       ├── BoardEntry.java
    │                       └── Board.java
    │                   ├── example
    │                       └── ExampleUsage.java
    │                   └── BoardManager.java
├── .gitignore
├── pom.xml
├── README.md
└── LICENSE


/src/main/resources/plugin.yml:
--------------------------------------------------------------------------------
1 | name: board
2 | main: me.missionary.board.example.ExampleUsage
3 | author: Missionary
4 | version: ${project.version}


--------------------------------------------------------------------------------
/src/main/java/me/missionary/board/settings/ScoreDirection.java:
--------------------------------------------------------------------------------
 1 | package me.missionary.board.settings;
 2 | 
 3 | /**
 4 |  * @author Missionary (missionarymc@gmail.com)
 5 |  * @since 5/31/2018
 6 |  */
 7 | public enum ScoreDirection {
 8 |     UP,
 9 |     DOWN
10 | }
11 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Created by .ignore support plugin (hsz.mobi)
 2 | ### Java template
 3 | # Compiled class file
 4 | *.class
 5 | 
 6 | # Log file
 7 | *.log
 8 | 
 9 | # BlueJ files
10 | *.ctxt
11 | 
12 | # Mobile Tools for Java (J2ME)
13 | .mtj.tmp/
14 | 
15 | # Package Files #
16 | *.jar
17 | *.war
18 | *.ear
19 | *.zip
20 | *.tar.gz
21 | *.rar
22 | 
23 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
24 | hs_err_pid*
25 | 
26 | 


--------------------------------------------------------------------------------
/src/main/java/me/missionary/board/settings/BoardSettings.java:
--------------------------------------------------------------------------------
 1 | package me.missionary.board.settings;
 2 | 
 3 | import lombok.Builder;
 4 | import lombok.Getter;
 5 | import me.missionary.board.provider.BoardProvider;
 6 | 
 7 | /**
 8 |  * @author Missionary (missionarymc@gmail.com)
 9 |  * @since 5/31/2018
10 |  */
11 | @Getter
12 | @Builder
13 | public class BoardSettings {
14 | 
15 |     private BoardProvider boardProvider;
16 | 
17 |     private ScoreDirection scoreDirection;
18 | 
19 | }
20 | 


--------------------------------------------------------------------------------
/src/main/java/me/missionary/board/provider/BoardProvider.java:
--------------------------------------------------------------------------------
 1 | package me.missionary.board.provider;
 2 | 
 3 | import me.missionary.board.board.Board;
 4 | import org.bukkit.entity.Player;
 5 | import org.bukkit.scoreboard.Objective;
 6 | 
 7 | import java.util.List;
 8 | 
 9 | public interface BoardProvider {
10 | 
11 |     /**
12 |      * Gets the title for {@link Objective#getDisplayName()}
13 |      *
14 |      * @param player The {@link Player} to supply
15 |      * @return The title for the objective
16 |      */
17 |     String getTitle(Player player);
18 | 
19 |     /**
20 |      * Gets the contents to be displayed on the {@link Board}
21 |      *
22 |      * @param player The {@link Player} to supply
23 |      * @return The {@link List} of contents
24 |      */
25 |     List<String> getLines(Player player);
26 | }
27 | 


--------------------------------------------------------------------------------
/src/main/java/me/missionary/board/board/tasks/BoardUpdateTask.java:
--------------------------------------------------------------------------------
 1 | package me.missionary.board.board.tasks;
 2 | 
 3 | import lombok.RequiredArgsConstructor;
 4 | import me.missionary.board.BoardManager;
 5 | import org.bukkit.Bukkit;
 6 | import org.bukkit.scheduler.BukkitRunnable;
 7 | 
 8 | import java.util.UUID;
 9 | import java.util.function.Predicate;
10 | 
11 | /**
12 |  * @author Missionary (missionarymc@gmail.com)
13 |  * @since 5/31/2018
14 |  */
15 | @RequiredArgsConstructor
16 | public class BoardUpdateTask extends BukkitRunnable {
17 | 
18 |     private static final Predicate<UUID> PLAYER_IS_ONLINE = uuid -> Bukkit.getPlayer(uuid) != null;
19 | 
20 |     private final BoardManager boardManager;
21 | 
22 |     @Override
23 |     public void run() {
24 |         boardManager.getScoreboards().entrySet().stream().filter(entrySet -> PLAYER_IS_ONLINE.test(entrySet.getKey())).forEach(entrySet -> entrySet.getValue().update());
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/main/java/me/missionary/board/board/BoardEntry.java:
--------------------------------------------------------------------------------
 1 | package me.missionary.board.board;
 2 | 
 3 | import lombok.Getter;
 4 | import org.apache.commons.lang.StringUtils;
 5 | import org.bukkit.ChatColor;
 6 | 
 7 | /**
 8 |  * @author Missionary (missionarymc@gmail.com)
 9 |  * @since 3/29/2018
10 |  */
11 | public class BoardEntry {
12 | 
13 |     @Getter
14 |     private final String prefix, suffix;
15 | 
16 |     private BoardEntry(final String prefix, final String suffix) {
17 |         this.prefix = prefix;
18 |         this.suffix = suffix;
19 |     }
20 | 
21 |     public static BoardEntry translateToEntry(String input) {
22 |         if (input.isEmpty()) {
23 |             return new BoardEntry("", "");
24 |         }
25 |         if (input.length() <= 16) {
26 |             return new BoardEntry(input, "");
27 |         } else {
28 |             String prefix = input.substring(0, 16);
29 |             String suffix = "";
30 | 
31 |             if (prefix.endsWith("\u00a7")) {
32 |                 prefix = prefix.substring(0, prefix.length() - 1);
33 |                 suffix = "\u00a7" + suffix;
34 |             }
35 | 
36 |             suffix = StringUtils.left(ChatColor.getLastColors(prefix) + suffix + input.substring(16), 16);
37 |             return new BoardEntry(prefix, suffix);
38 |         }
39 |     }
40 | }


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <project xmlns="http://maven.apache.org/POM/4.0.0"
 3 |          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4 |          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 5 |     <modelVersion>4.0.0</modelVersion>
 6 | 
 7 |     <groupId>me.missionary</groupId>
 8 |     <artifactId>board</artifactId>
 9 |     <version>1.1.0-SNAPSHOT</version>
10 |     <packaging>jar</packaging>
11 | 
12 |     <name>Board</name>
13 | 
14 |     <properties>
15 |         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
16 |     </properties>
17 | 
18 |     <build>
19 |         <defaultGoal>clean package install</defaultGoal>
20 |         <plugins>
21 |             <plugin>
22 |                 <groupId>org.apache.maven.plugins</groupId>
23 |                 <artifactId>maven-compiler-plugin</artifactId>
24 |                 <version>3.7.0</version>
25 |                 <configuration>
26 |                     <source>1.8</source>
27 |                     <target>1.8</target>
28 |                 </configuration>
29 |             </plugin>
30 |         </plugins>
31 |     </build>
32 | 
33 |     <repositories>
34 |         <repository>
35 |             <id>spigotmc-repo</id>
36 |             <url>https://hub.spigotmc.org/nexus/content/groups/public/</url>
37 |         </repository>
38 |     </repositories>
39 | 
40 |     <dependencies>
41 |         <dependency>
42 |             <groupId>org.bukkit</groupId>
43 |             <artifactId>bukkit</artifactId>
44 |             <version>1.8.8-R0.1-SNAPSHOT</version>
45 |             <scope>provided</scope>
46 |         </dependency>
47 |         <dependency>
48 |             <groupId>org.projectlombok</groupId>
49 |             <artifactId>lombok</artifactId>
50 |             <version>1.16.20</version>
51 |             <scope>provided</scope>
52 |         </dependency>
53 |     </dependencies>
54 | </project>
55 | 


--------------------------------------------------------------------------------
/src/main/java/me/missionary/board/example/ExampleUsage.java:
--------------------------------------------------------------------------------
 1 | package me.missionary.board.example;
 2 | 
 3 | import me.missionary.board.BoardManager;
 4 | import me.missionary.board.provider.BoardProvider;
 5 | import me.missionary.board.settings.BoardSettings;
 6 | import me.missionary.board.settings.ScoreDirection;
 7 | import org.bukkit.ChatColor;
 8 | import org.bukkit.entity.Player;
 9 | import org.bukkit.plugin.java.JavaPlugin;
10 | 
11 | import java.util.ArrayList;
12 | import java.util.List;
13 | 
14 | /**
15 |  * @author Missionary (missionarymc@gmail.com)
16 |  * @since 3/29/2018
17 |  */
18 | public class ExampleUsage extends JavaPlugin {
19 | 
20 |     private BoardManager manager;
21 | 
22 |     @Override
23 |     public void onEnable() {
24 |         manager = new BoardManager(this, BoardSettings.builder().boardProvider(new ExampleProviderImplementation()).scoreDirection(ScoreDirection.UP).build());
25 |     }
26 | 
27 |     @Override
28 |     public void onDisable() {
29 |         manager.onDisable();
30 |     }
31 | 
32 |     private class ExampleProviderImplementation implements BoardProvider {
33 | 
34 |         @Override
35 |         public String getTitle(Player player) {
36 |             return ChatColor.LIGHT_PURPLE + "Board";
37 |         }
38 | 
39 |         @Override
40 |         public List<String> getLines(Player player) {
41 |             List<String> lines = new ArrayList<>();
42 |             lines.add("&7&m-----------------");
43 |             lines.add(ChatColor.LIGHT_PURPLE + "Name" + ChatColor.GRAY + ": " + ChatColor.YELLOW + player.getName());
44 |             lines.add(ChatColor.LIGHT_PURPLE + "Health" + ChatColor.GRAY + ": " + ChatColor.YELLOW + String.format("%.1f\u2764", Math.ceil(player.getHealth()) / 2.0));
45 |             lines.add(ChatColor.LIGHT_PURPLE + "Hunger" + ChatColor.GRAY + ": " + ChatColor.YELLOW + player.getFoodLevel() / 2);
46 |             lines.add("&7&m-----------------");
47 |             return lines;
48 |         }
49 |     }
50 | }
51 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # board [![](https://jitpack.io/v/missionarydev/board.svg)](https://jitpack.io/#missionarydev/board)
 2 | A clean and functional scoreboard api for use with Bukkit/Spigot plugins. The objective of board is to allow for easy creation 
 3 | of scoreboard systems without the hassle of the included api's in Bukkit.
 4 | 
 5 | ## Usage
 6 | board can be easily added to your project with the use of Apache Maven.
 7 | 
 8 | #### Requirements of board
 9 | * [Java 8+](http://www.oracle.com/technetwork/java/javase/downloads/index.html) (usage of Java 8 specific features is heavy)
10 | * [Project Lombok](https://projectlombok.org/) Any version after 1.16.20 shall suffice
11 | * Bukkit/Spigot (up to the user where they find it)
12 | * [Git SCM](https://git-scm.com/downloads)
13 | * [Apache Maven 3](http://maven.apache.org/download.html)
14 | 
15 | **It is recommended that you use the [jitpack](https://jitpack.io/#missionarydev/board)**
16 | 
17 | After you have all of the requirements installed & configured you can use the following series of commands to download and install
18 | board to your local maven repo (.m2)
19 | ```
20 | git clone https://github.com/missionarydev/board.git
21 | cd board
22 | mvn clean install
23 | ```
24 | board will now have been added to your local maven repo (.m2) and you can begin using it by adding the following into your Maven pom.xml
25 | ```xml
26 | <dependency>
27 |     <groupId>me.missionary</groupId>
28 |     <artifactId>board</artifactId>
29 |     <version>1.1.0-SNAPSHOT</version>
30 |     <scope>compile</scope>
31 | </dependency>
32 | ```
33 | After you have added the dependency to your Maven pom.xml the last thing you need to do is register the BoardManager and instance of BoardProvider
34 | with your plugin!
35 | ```java
36 | public class ExampleUsage extends JavaPlugin {
37 | 
38 |     private BoardManager manager;
39 | 
40 |     @Override
41 |     public void onEnable() {
42 |         manager = new BoardManager(this, BoardSettings.builder().boardProvider(new ExampleProviderImplementation()).scoreDirection(ScoreDirection.UP).build());
43 |     }
44 | 
45 |     @Override
46 |     public void onDisable() {
47 |         manager.onDisable();
48 |     }
49 | }
50 | 
51 | ```
52 | 
53 | ## Functionality
54 | board provides support for creating simple and elegant scoreboards.
55 | 
56 | Here is an example of how to create a scoreboard with board.
57 | ```java
58 | public class ExampleProviderImplementation implements BoardProvider {
59 | 
60 |         @Override
61 |         public String getTitle(Player player) {
62 |             return ChatColor.LIGHT_PURPLE + "Board";
63 |         }
64 | 
65 |         @Override
66 |         public List<String> getLines(Player player) {
67 |             List<String> lines = new ArrayList<>();
68 |             lines.add("&7&m-----------------");
69 |             lines.add(ChatColor.LIGHT_PURPLE + "Name" + ChatColor.GRAY + ": " + ChatColor.YELLOW + player.getName());
70 |             lines.add(ChatColor.LIGHT_PURPLE + "Health" + ChatColor.GRAY + ": " + ChatColor.YELLOW + String.format("%.1f\u2764", Math.ceil(player.getHealth()) / 2.0));
71 |             lines.add(ChatColor.LIGHT_PURPLE + "Hunger" + ChatColor.GRAY + ": " + ChatColor.YELLOW + player.getFoodLevel() / 2);
72 |             lines.add("&7&m-----------------");
73 |             return lines;
74 |         }
75 |     }
76 | ```
77 | The previous code will produce this result: 
78 | 
79 | ![](https://i.imgur.com/hI0I3Nx.png)
80 | 


--------------------------------------------------------------------------------
/src/main/java/me/missionary/board/BoardManager.java:
--------------------------------------------------------------------------------
 1 | package me.missionary.board;
 2 | 
 3 | import me.missionary.board.board.Board;
 4 | import me.missionary.board.board.tasks.BoardUpdateTask;
 5 | import me.missionary.board.settings.BoardSettings;
 6 | import org.bukkit.Bukkit;
 7 | import org.bukkit.entity.Player;
 8 | import org.bukkit.event.EventHandler;
 9 | import org.bukkit.event.Listener;
10 | import org.bukkit.event.player.PlayerJoinEvent;
11 | import org.bukkit.event.player.PlayerQuitEvent;
12 | import org.bukkit.plugin.java.JavaPlugin;
13 | import org.bukkit.scheduler.BukkitTask;
14 | 
15 | import java.util.Collections;
16 | import java.util.Map;
17 | import java.util.Optional;
18 | import java.util.UUID;
19 | import java.util.concurrent.ConcurrentHashMap;
20 | 
21 | /**
22 |  * @author Missionary (missionarymc@gmail.com)
23 |  * @since 3/23/2018
24 |  */
25 | public class BoardManager implements Listener {
26 | 
27 |     private final JavaPlugin plugin;
28 |     private BoardSettings boardSettings;
29 |     private Map<UUID, Board> scoreboards;
30 |     private BukkitTask updateTask;
31 | 
32 |     public BoardManager(JavaPlugin plugin, BoardSettings boardSettings) {
33 |         this.plugin = plugin;
34 |         this.boardSettings = boardSettings;
35 |         this.scoreboards = new ConcurrentHashMap<>();
36 |         this.updateTask = new BoardUpdateTask(this).runTaskTimer(plugin, 2L, 2L);
37 |         plugin.getServer().getPluginManager().registerEvents(this, plugin);
38 |         plugin.getServer().getOnlinePlayers().forEach(this::setup);
39 |     }
40 | 
41 |     public void setBoardSettings(BoardSettings boardSettings) {
42 |         this.boardSettings = boardSettings;
43 |         scoreboards.values().forEach(board -> board.setBoardSettings(boardSettings));
44 |     }
45 | 
46 |     public boolean hasBoard(Player player) {
47 |         return scoreboards.containsKey(player.getUniqueId());
48 |     }
49 | 
50 |     public Optional<Board> getBoard(Player player) {
51 |         return Optional.ofNullable(scoreboards.get(player.getUniqueId()));
52 |     }
53 | 
54 |     private void setup(Player player) {
55 |         Optional.ofNullable(scoreboards.remove(player.getUniqueId())).ifPresent(Board::resetScoreboard);
56 |         if (player.getScoreboard() == Bukkit.getScoreboardManager().getMainScoreboard()) {
57 |             player.setScoreboard(Bukkit.getScoreboardManager().getNewScoreboard());
58 |         }
59 |         scoreboards.put(player.getUniqueId(), new Board(player, boardSettings));
60 |     }
61 | 
62 |     private void remove(Player player) {
63 |         Optional.ofNullable(scoreboards.remove(player.getUniqueId())).ifPresent(Board::remove);
64 |     }
65 | 
66 |     public Map<UUID, Board> getScoreboards() {
67 |         return Collections.unmodifiableMap(scoreboards);
68 |     }
69 | 
70 |     @EventHandler
71 |     public void onJoin(final PlayerJoinEvent e) {
72 |         plugin.getServer().getScheduler().runTaskLater(plugin, () -> {
73 |             if (e.getPlayer().isOnline()) { // Set this up 2 ticks later.
74 |                 setup(e.getPlayer());
75 |             }
76 |         }, 2L);
77 |     }
78 | 
79 |     @EventHandler
80 |     public void onQuit(final PlayerQuitEvent e) {
81 |         this.remove(e.getPlayer());
82 |     }
83 | 
84 |     public void onDisable() {
85 |         updateTask.cancel();
86 |         plugin.getServer().getOnlinePlayers().forEach(this::remove);
87 |         scoreboards.clear();
88 |     }
89 | }
90 | 


--------------------------------------------------------------------------------
/src/main/java/me/missionary/board/board/Board.java:
--------------------------------------------------------------------------------
  1 | package me.missionary.board.board;
  2 | 
  3 | import lombok.NonNull;
  4 | import lombok.Setter;
  5 | import me.missionary.board.settings.BoardSettings;
  6 | import me.missionary.board.settings.ScoreDirection;
  7 | import org.bukkit.Bukkit;
  8 | import org.bukkit.ChatColor;
  9 | import org.bukkit.entity.Player;
 10 | import org.bukkit.scoreboard.DisplaySlot;
 11 | import org.bukkit.scoreboard.Objective;
 12 | import org.bukkit.scoreboard.Scoreboard;
 13 | import org.bukkit.scoreboard.Team;
 14 | 
 15 | import java.util.Collections;
 16 | import java.util.List;
 17 | import java.util.function.Function;
 18 | import java.util.stream.Collectors;
 19 | import java.util.stream.IntStream;
 20 | 
 21 | /**
 22 |  * @author Missionary (missionarymc@gmail.com)
 23 |  * @since 3/23/2018
 24 |  */
 25 | public class Board {
 26 | 
 27 |     private static final String[] CACHED_ENTRIES = new String[ChatColor.values().length];
 28 | 
 29 |     private static final Function<String, String> APPLY_COLOR_TRANSLATION = s -> ChatColor.translateAlternateColorCodes('&', s);
 30 | 
 31 |     static {
 32 |         IntStream.range(0, 15).forEach(i -> CACHED_ENTRIES[i] = ChatColor.values()[i].toString() + ChatColor.RESET);
 33 |     }
 34 | 
 35 |     private final Player player;
 36 |     private final Objective objective;
 37 |     private final Team team;
 38 |     @Setter private BoardSettings boardSettings;
 39 |     private boolean ready;
 40 | 
 41 |     public Board(@NonNull final Player player, final BoardSettings boardSettings) {
 42 |         this.player = player;
 43 |         this.boardSettings = boardSettings;
 44 |         this.objective = this.getScoreboard().getObjective("board") == null ? this.getScoreboard().registerNewObjective("board", "dummy") : this.getScoreboard().getObjective("board");
 45 |         this.objective.setDisplaySlot(DisplaySlot.SIDEBAR);
 46 |         this.team = this.getScoreboard().getTeam("board") == null ? this.getScoreboard().registerNewTeam("board") : this.getScoreboard().getTeam("board");
 47 |         this.team.setAllowFriendlyFire(true);
 48 |         this.team.setCanSeeFriendlyInvisibles(false);
 49 |         this.team.setPrefix("");
 50 |         this.team.setSuffix("");
 51 |         this.ready = true;
 52 |     }
 53 | 
 54 |     public Scoreboard getScoreboard() {
 55 |         return (player != null) ? player.getScoreboard() : null;
 56 |     }
 57 | 
 58 |     public void remove() {
 59 |         this.resetScoreboard();
 60 |     }
 61 | 
 62 |     public void update() {
 63 |         // Checking if we are ready to start updating the Scoreboard.
 64 |         if (!ready) {
 65 |             return;
 66 |         }
 67 | 
 68 |         // Making sure the player is connected.
 69 |         if (!player.isOnline()) {
 70 |             remove();
 71 |             return;
 72 |         }
 73 | 
 74 |         // Making sure the Scoreboard Provider is set.
 75 |         if (boardSettings == null) {
 76 |             return;
 77 |         }
 78 | 
 79 |         // Getting their Scoreboard display from the Scoreboard Provider.
 80 |         final List<String> entries = boardSettings.getBoardProvider().getLines(player).stream().map(APPLY_COLOR_TRANSLATION).collect(Collectors.toList());
 81 | 
 82 |         if (boardSettings.getScoreDirection() == ScoreDirection.UP) {
 83 |             Collections.reverse(entries);
 84 |         }
 85 | 
 86 |         // Setting the Scoreboard title
 87 |         String title = boardSettings.getBoardProvider().getTitle(player);
 88 |         if (title.length() > 32) {
 89 |             Bukkit.getLogger().warning("The title " + title + " is over 32 characters in length, substringing to prevent errors.");
 90 |             title = title.substring(0, 32);
 91 |         }
 92 |         objective.setDisplayName(ChatColor.translateAlternateColorCodes('&', title));
 93 | 
 94 |         // Clearing previous Scoreboard values if entry sizes don't match.
 95 |         if (this.getScoreboard().getEntries().size() != entries.size())
 96 |             this.getScoreboard().getEntries().forEach(this::removeEntry);
 97 | 
 98 |         // Setting Scoreboard lines.
 99 |         for (int i = 0; i < entries.size(); i++) {
100 |             String str = entries.get(i);
101 |             BoardEntry entry = BoardEntry.translateToEntry(str);
102 |             Team team = getScoreboard().getTeam(CACHED_ENTRIES[i]);
103 | 
104 |             if (team == null) {
105 |                 team = this.getScoreboard().registerNewTeam(CACHED_ENTRIES[i]);
106 |                 team.addEntry(team.getName());
107 |             }
108 | 
109 |             team.setPrefix(entry.getPrefix());
110 |             team.setSuffix(entry.getSuffix());
111 | 
112 |             switch (boardSettings.getScoreDirection()) {
113 |                 case UP:
114 |                     objective.getScore(team.getName()).setScore(1 + i);
115 |                     break;
116 |                 case DOWN:
117 |                     objective.getScore(team.getName()).setScore(15 - i);
118 |                     break;
119 |             }
120 |         }
121 |     }
122 | 
123 |     public void removeEntry(String id) {
124 |         this.getScoreboard().resetScores(id);
125 |     }
126 | 
127 |     public void resetScoreboard() {
128 |         ready = false;
129 |         player.setScoreboard(Bukkit.getScoreboardManager().getMainScoreboard());
130 |     }
131 | }
132 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "[]"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright 2018 missionarydev
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 


--------------------------------------------------------------------------------