├── .gitignore
├── pom.xml
└── src
└── main
├── java
└── com
│ └── bobcat00
│ └── viaversionstatus
│ ├── Config.java
│ ├── Listeners.java
│ ├── LogFilter.java
│ ├── PrismEvent.java
│ ├── PrismEventInterface.java
│ ├── PrismPlayerAction.java
│ ├── ViaVersionStatus.java
│ └── connections
│ ├── Connection.java
│ ├── ProtocolVersion.java
│ └── ViaConnection.java
└── resources
├── config.yml
├── license.txt
└── plugin.yml
/.gitignore:
--------------------------------------------------------------------------------
1 | # Eclipse
2 | .classpath
3 | .project
4 | .settings/
5 |
6 | # Intellij
7 | .idea/
8 | *.iml
9 | *.iws
10 |
11 | # Mac
12 | .DS_Store
13 |
14 | # Maven
15 | log/
16 | target/
17 | dependency-reduced-pom.xml
18 |
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
2 | 4.0.0
3 | com.bobcat00
4 | ViaVersionStatus
5 | 4.01-SNAPSHOT
6 |
7 |
8 |
9 | src/main/resources
10 | true
11 |
12 | **/plugin.yml
13 |
14 |
15 |
16 | src/main/resources
17 | false
18 |
19 | **/plugin.yml
20 |
21 |
22 |
23 |
24 |
25 | org.apache.maven.plugins
26 | maven-compiler-plugin
27 | 3.14.0
28 |
29 | 17
30 | 17
31 |
32 |
33 |
34 |
35 |
36 | org.apache.maven.plugins
37 | maven-jar-plugin
38 | 3.4.2
39 |
40 |
41 |
42 | mojang
43 |
44 |
45 |
46 |
47 |
48 |
49 | org.apache.maven.plugins
50 | maven-shade-plugin
51 | 3.6.0
52 |
53 |
54 |
55 | org.bstats
56 | com.bobcat00.viaversionstatus.bstats
57 |
58 |
59 |
60 |
61 |
62 | package
63 |
64 | shade
65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 |
73 | spigot-repo
74 | https://hub.spigotmc.org/nexus/content/repositories/snapshots/
75 |
76 |
77 | viaversion-repo
78 | https://repo.viaversion.com/
79 |
80 |
81 |
82 |
83 | org.spigotmc
84 | spigot-api
85 | 1.18-R0.1-SNAPSHOT
86 | jar
87 | provided
88 |
89 |
90 | com.viaversion
91 | viaversion-api
92 | 5.3.2
93 | provided
94 |
95 |
96 |
97 | org.apache.logging.log4j
98 | log4j-api
99 | 2.20.0
100 | provided
101 |
102 |
103 | org.apache.logging.log4j
104 | log4j-core
105 | 2.20.0
106 | provided
107 |
108 |
109 |
110 | org.bstats
111 | bstats-bukkit
112 | 3.0.2
113 | compile
114 |
115 |
116 |
117 |
--------------------------------------------------------------------------------
/src/main/java/com/bobcat00/viaversionstatus/Config.java:
--------------------------------------------------------------------------------
1 | // ViaVersionStatus - Logs players' client versions
2 | // Copyright 2019 Bobcat00
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, either version 3 of the License, or
7 | // (at your option) any later version.
8 | //
9 | // This program is distributed in the hope that it will be useful,
10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | // GNU General Public License for more details.
13 | //
14 | // You should have received a copy of the GNU General Public License
15 | // along with this program. If not, see .
16 |
17 | package com.bobcat00.viaversionstatus;
18 |
19 | import java.io.BufferedWriter;
20 | import java.io.File;
21 | import java.io.FileOutputStream;
22 | import java.io.OutputStreamWriter;
23 | import java.nio.charset.Charset;
24 |
25 | public class Config
26 | {
27 | private ViaVersionStatus plugin;
28 |
29 | // Constructor
30 |
31 | public Config(ViaVersionStatus plugin)
32 | {
33 | this.plugin = plugin;
34 | }
35 |
36 | // Get the string to be sent to ops
37 |
38 | public boolean getNotifyOps()
39 | {
40 | return plugin.getConfig().getBoolean("notify-ops");
41 | }
42 |
43 | public String getNotifyString()
44 | {
45 | return plugin.getConfig().getString("notify-string");
46 | }
47 |
48 | public String getNotifyCommand()
49 | {
50 | return plugin.getConfig().getString("notify-command");
51 | }
52 |
53 | // Warning for players with mismatched version
54 |
55 | public boolean getOlderVersionWarnPlayers()
56 | {
57 | return plugin.getConfig().getBoolean("warn-players");
58 | }
59 |
60 | public String getOlderVersionWarnString()
61 | {
62 | return plugin.getConfig().getString("warn-string");
63 | }
64 |
65 | public String getOlderVersionWarnCommand()
66 | {
67 | return plugin.getConfig().getString("warn-command");
68 | }
69 |
70 | public boolean getNewerVersionWarnPlayers()
71 | {
72 | return plugin.getConfig().getBoolean("warn-players-newer");
73 | }
74 |
75 | public String getNewerVersionWarnString()
76 | {
77 | return plugin.getConfig().getString("warn-string-newer");
78 | }
79 |
80 | public String getNewerVersionWarnCommand()
81 | {
82 | return plugin.getConfig().getString("warn-command-newer");
83 | }
84 |
85 | // Listener priority
86 |
87 | public boolean getHighPriority()
88 | {
89 | return plugin.getConfig().getBoolean("high-priority");
90 | }
91 |
92 | // Supported protocols
93 |
94 | public boolean getListSupportedProtocols()
95 | {
96 | return plugin.getConfig().getBoolean("list-supported-protocols");
97 | }
98 |
99 | // Block no light data warnings
100 |
101 | public boolean getBlockNoLightDataWarnings()
102 | {
103 | return plugin.getConfig().getBoolean("block-no-light-data-warnings");
104 | }
105 |
106 | // Metrics
107 |
108 | public boolean getEnableMetrics()
109 | {
110 | return plugin.getConfig().getBoolean("enable-metrics");
111 | }
112 |
113 | // Prism integration
114 |
115 | public boolean getPrismIntegration()
116 | {
117 | return plugin.getConfig().getBoolean("prism-integration");
118 | }
119 |
120 | //--------------------------------------------------------------------------
121 |
122 | // Update the config file with new fields.
123 |
124 | private boolean contains(String path, boolean ignoreDefault)
125 | {
126 | // This duplicates the method added in 1.9, Bukkit commit facc9c353c3
127 | return ((ignoreDefault) ? plugin.getConfig().get(path, null) : plugin.getConfig().get(path)) != null;
128 | }
129 |
130 | public void updateConfig()
131 | {
132 | if (!contains("notify-ops", true))
133 | {
134 | plugin.getConfig().set("notify-ops", true);
135 | }
136 |
137 | if (!contains("notify-command", true))
138 | {
139 | plugin.getConfig().set("notify-command", "");
140 | }
141 |
142 | if (!contains("warn-command", true))
143 | {
144 | plugin.getConfig().set("warn-command", "");
145 | }
146 |
147 | if (!contains("warn-players-newer", true))
148 | {
149 | plugin.getConfig().set("warn-players-newer", plugin.getConfig().getBoolean("warn-players"));
150 | }
151 |
152 | if (!contains("warn-string-newer", true))
153 | {
154 | plugin.getConfig().set("warn-string-newer", plugin.getConfig().getString("warn-string"));
155 | }
156 |
157 | if (!contains("warn-command-newer", true))
158 | {
159 | plugin.getConfig().set("warn-command-newer", plugin.getConfig().getString("warn-command"));
160 | }
161 |
162 | if (!contains("list-supported-protocols", true))
163 | {
164 | plugin.getConfig().set("list-supported-protocols", true);
165 | }
166 |
167 | if (!contains("block-no-light-data-warnings", true))
168 | {
169 | plugin.getConfig().set("block-no-light-data-warnings", false);
170 | }
171 |
172 | if (!contains("enable-metrics", true))
173 | {
174 | plugin.getConfig().set("enable-metrics", true);
175 | }
176 |
177 | if (!contains("prism-integration", true))
178 | {
179 | plugin.getConfig().set("prism-integration", false);
180 | }
181 |
182 | saveConfig();
183 | }
184 |
185 | //--------------------------------------------------------------------------
186 |
187 | // Save config to disk with embedded comments. Any change to the config file
188 | // format must also be changed here. Newlines are written as \n so they will
189 | // be the same on all platforms.
190 |
191 | public void saveConfig()
192 | {
193 | try
194 | {
195 | File outFile = new File(plugin.getDataFolder(), "config.yml");
196 |
197 | BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(outFile.getAbsolutePath()), Charset.forName("UTF-8")));
198 |
199 | writer.write("# Strings should be enclosed in double quotes: \"...\"" + "\n");
200 | writer.write("# Supported variables are %player%, %displayname%, %version%, and %server%" + "\n");
201 | writer.write("# \\n can be used as a line break" + "\n");
202 | writer.write("\n");
203 |
204 | writer.write("# Notify ops when a player joins" + "\n");
205 | writer.write("notify-ops: " + plugin.getConfig().getBoolean("notify-ops") + "\n");
206 | writer.write("notify-string: \"" + plugin.getConfig().getString("notify-string").replaceAll("\n", "\\\\n") + "\"" + "\n");
207 | writer.write("notify-command: \"" + plugin.getConfig().getString("notify-command") + "\"" + "\n");
208 | writer.write("\n");
209 |
210 | writer.write("# Warn players when they are using an older version" + "\n");
211 | writer.write("warn-players: " + plugin.getConfig().getBoolean("warn-players") + "\n");
212 | writer.write("warn-string: \"" + plugin.getConfig().getString("warn-string").replaceAll("\n", "\\\\n") + "\"" + "\n");
213 | writer.write("warn-command: \"" + plugin.getConfig().getString("warn-command") + "\"" + "\n");
214 | writer.write("\n");
215 |
216 | writer.write("# Warn players when they are using a newer version" + "\n");
217 | writer.write("warn-players-newer: " + plugin.getConfig().getBoolean("warn-players-newer") + "\n");
218 | writer.write("warn-string-newer: \"" + plugin.getConfig().getString("warn-string-newer").replaceAll("\n", "\\\\n") + "\"" + "\n");
219 | writer.write("warn-command-newer: \"" + plugin.getConfig().getString("warn-command-newer") + "\"" + "\n");
220 | writer.write("\n");
221 |
222 | writer.write("# Run at the highest priority (MONITOR)" + "\n");
223 | writer.write("# Set to true if %displayname% doesn't work as expected" + "\n");
224 | writer.write("high-priority: " + plugin.getConfig().getBoolean("high-priority") + "\n");
225 | writer.write("\n");
226 |
227 | writer.write("# At startup, list the protocols supported by ViaVersion" + "\n");
228 | writer.write("list-supported-protocols: " + plugin.getConfig().getBoolean("list-supported-protocols") + "\n");
229 | writer.write("\n");
230 |
231 | writer.write("# Block \"No light data found for chunk\" warning messages" + "\n");
232 | writer.write("block-no-light-data-warnings: " + plugin.getConfig().getBoolean("block-no-light-data-warnings") + "\n");
233 | writer.write("\n");
234 |
235 | writer.write("# Enable metrics (subject to bStats global config)" + "\n");
236 | writer.write("enable-metrics: " + plugin.getConfig().getBoolean("enable-metrics") + "\n");
237 | writer.write("\n");
238 |
239 | writer.write("# Record data via Prism, with the action vvs-client-connect" + "\n");
240 | writer.write("prism-integration: " + plugin.getConfig().getBoolean("prism-integration") + "\n");
241 |
242 | writer.close();
243 | }
244 | catch(Exception e)
245 | {
246 | e.printStackTrace();
247 | //plugin.getLogger().info("Exception creating config file.");
248 | }
249 |
250 | plugin.reloadConfig();
251 |
252 | }
253 | }
254 |
--------------------------------------------------------------------------------
/src/main/java/com/bobcat00/viaversionstatus/Listeners.java:
--------------------------------------------------------------------------------
1 | // ViaVersionStatus - Logs players' client versions
2 | // Copyright 2019 Bobcat00
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, either version 3 of the License, or
7 | // (at your option) any later version.
8 | //
9 | // This program is distributed in the hope that it will be useful,
10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | // GNU General Public License for more details.
13 | //
14 | // You should have received a copy of the GNU General Public License
15 | // along with this program. If not, see .
16 |
17 | package com.bobcat00.viaversionstatus;
18 |
19 | import java.util.List;
20 |
21 | import org.bukkit.Bukkit;
22 | import org.bukkit.ChatColor;
23 | import org.bukkit.command.CommandException;
24 | import org.bukkit.entity.Player;
25 | import org.bukkit.event.Event;
26 | import org.bukkit.event.EventPriority;
27 | import org.bukkit.event.Listener;
28 | import org.bukkit.event.player.PlayerJoinEvent;
29 | import org.bukkit.plugin.EventExecutor;
30 | import org.bukkit.scheduler.BukkitRunnable;
31 |
32 | import com.bobcat00.viaversionstatus.connections.ProtocolVersion;
33 | import com.bobcat00.viaversionstatus.connections.ViaConnection;
34 |
35 | public final class Listeners implements Listener
36 | {
37 | private ViaVersionStatus plugin;
38 |
39 | private ViaConnection via;
40 |
41 | public enum UseConnection
42 | {
43 | USE_VIA,
44 | USE_NONE
45 | }
46 |
47 | private UseConnection useConnection = UseConnection.USE_NONE;
48 |
49 | // Variables for outputting supported protocols at startup
50 | private boolean outputVia = false;
51 | private int protocolListCounter = 0;
52 |
53 | // Constructor
54 |
55 | public Listeners(ViaVersionStatus plugin)
56 | {
57 | this.plugin = plugin;
58 |
59 | // Register listener
60 |
61 | EventPriority priority = EventPriority.NORMAL;
62 | if (plugin.config.getHighPriority())
63 | {
64 | // Use MONITOR if true
65 | priority = EventPriority.MONITOR;
66 | plugin.getLogger().info("Using listener priority " + priority.toString() + ".");
67 | }
68 |
69 | plugin.getServer().getPluginManager().registerEvent(PlayerJoinEvent.class, this, priority,
70 | new EventExecutor() { public void execute(Listener l, Event e) { onPlayerJoin((PlayerJoinEvent)e); }},
71 | plugin);
72 |
73 | // Determine which connection(s) to use
74 |
75 | via = new ViaConnection();
76 |
77 | if (via.isValid())
78 | {
79 | useConnection = UseConnection.USE_VIA;
80 | outputVia = true;
81 | //plugin.getLogger().info("Using ViaVersion to determine versions.");
82 | }
83 | else
84 | {
85 | plugin.getLogger().severe("This plugin requires ViaVersion.");
86 | plugin.shutdown();
87 | throw new RuntimeException("ViaVersion required."); // Get the user's attention
88 | }
89 |
90 | // Output supported protocols after giving ViaVersion time to populate them
91 |
92 | if (plugin.config.getListSupportedProtocols())
93 | {
94 | new BukkitRunnable()
95 | {
96 | @Override
97 | public void run()
98 | {
99 | if (outputVia)
100 | {
101 | List protocols = via.getSupportedProtocols();
102 |
103 | if ((protocols != null) && (!protocols.isEmpty()))
104 | {
105 | plugin.getLogger().info("ViaVersion supported protocols:");
106 | for(ProtocolVersion protocol : protocols)
107 | {
108 | plugin.getLogger().info(protocol.toString());
109 | }
110 | // Indicate done
111 | outputVia = false;
112 | }
113 | }
114 |
115 | ++protocolListCounter;
116 | // Cancel if nothing more is to be done or if we tried 10 times
117 | if (!outputVia || protocolListCounter >= 10)
118 | {
119 | this.cancel();
120 | }
121 | }
122 | }.runTaskTimer(plugin,
123 | 100L, // delay 5 sec
124 | 100L); // period 5 sec
125 | }
126 | }
127 |
128 | // Get connection used
129 |
130 | public UseConnection getConnectionUsed()
131 | {
132 | return useConnection;
133 | }
134 |
135 | // Player join event
136 |
137 | public void onPlayerJoin(PlayerJoinEvent e)
138 | {
139 | final Player player = e.getPlayer();
140 |
141 | if (player.hasPermission("viaversionstatus.exempt"))
142 | {
143 | return;
144 | }
145 |
146 | // Protocol consists of a Name and Id (toString returns both as a combined string)
147 | ProtocolVersion serverProtocol = null;
148 | ProtocolVersion clientProtocol = null;
149 |
150 | switch (useConnection)
151 | {
152 | case USE_VIA:
153 | serverProtocol = via.getServerProtocol();
154 | clientProtocol = via.getProtocol(player);
155 | break;
156 |
157 | case USE_NONE:
158 | // Should never get here
159 | return;
160 |
161 | default:
162 | // Should never get here
163 | return;
164 | }
165 |
166 | final String clientVersion = clientProtocol.getName();
167 | final String serverVersion = serverProtocol.getName();
168 |
169 | // 1. Write to log file
170 |
171 | if (!player.hasPermission("viaversionstatus.exempt.log"))
172 | {
173 | plugin.getLogger().info(player.getName() + " is using version " + clientProtocol.toString() + ".");
174 | }
175 |
176 | // 2. Notify any player with the viaversionstatus.notify permission (ops by default),
177 | // unless the player logging in has an exempt permission
178 |
179 | if (plugin.config.getNotifyOps() &&
180 | !player.hasPermission("viaversionstatus.exempt.notify"))
181 | {
182 | if (!player.hasPermission("viaversionstatus.exempt.notify.message"))
183 | {
184 | String notifyMessage = plugin.config.getNotifyString();
185 | if (!notifyMessage.isEmpty())
186 | {
187 | for (Player p : Bukkit.getServer().getOnlinePlayers())
188 | {
189 | if (p.hasPermission("viaversionstatus.notify") &&
190 | (!p.hasPermission("viaversionstatus.notify.ignoresame") || (clientProtocol.getId() != serverProtocol.getId())))
191 | {
192 | p.sendMessage(ChatColor.translateAlternateColorCodes('&',
193 | notifyMessage.replace("%player%", player.getName()).
194 | replace("%displayname%", player.getDisplayName()).
195 | replace("%version%", clientVersion).
196 | replace("%server%", serverVersion)));
197 | }
198 | }
199 | }
200 | }
201 |
202 | if (!player.hasPermission("viaversionstatus.exempt.notify.command"))
203 | {
204 | String notifyCommand = plugin.config.getNotifyCommand();
205 | if (!notifyCommand.isEmpty())
206 | {
207 | notifyCommand = notifyCommand.replace("%player%", player.getName()).
208 | replace("%displayname%", player.getDisplayName()).
209 | replace("%version%", clientVersion).
210 | replace("%server%", serverVersion);
211 | plugin.getLogger().info("Executing command " + notifyCommand);
212 | try
213 | {
214 | Bukkit.getServer().dispatchCommand(Bukkit.getConsoleSender(), notifyCommand);
215 | }
216 | catch (CommandException exc)
217 | {
218 | plugin.getLogger().warning("Command returned exception: " + exc.getMessage());
219 | }
220 | }
221 | }
222 | }
223 |
224 | // 3. Warn player if they are connecting using an older version
225 |
226 | if (plugin.config.getOlderVersionWarnPlayers() &&
227 | !serverVersion.equals("UNKNOWN") &&
228 | (clientProtocol.getId() < serverProtocol.getId()) &&
229 | !player.hasPermission("viaversionstatus.exempt.warn"))
230 | {
231 | handleMismatchedClientServerVersionsForTargetPlayer(player,
232 | "viaversionstatus.exempt.warn.message",
233 | "viaversionstatus.exempt.warn.command",
234 | plugin.config.getOlderVersionWarnString(),
235 | plugin.config.getOlderVersionWarnCommand(),
236 | clientVersion,
237 | serverVersion);
238 | }
239 |
240 | // 4. Warn player if they are connecting using a newer version
241 |
242 | if (plugin.config.getNewerVersionWarnPlayers() &&
243 | !serverVersion.equals("UNKNOWN") &&
244 | (clientProtocol.getId() > serverProtocol.getId()) &&
245 | !player.hasPermission("viaversionstatus.exempt.warn.newer"))
246 | {
247 | handleMismatchedClientServerVersionsForTargetPlayer(player,
248 | "viaversionstatus.exempt.warn.newer.message",
249 | "viaversionstatus.exempt.warn.newer.command",
250 | plugin.config.getNewerVersionWarnString(),
251 | plugin.config.getNewerVersionWarnCommand(),
252 | clientVersion,
253 | serverVersion);
254 | }
255 |
256 | // 5. Send to Prism
257 |
258 | if (plugin.prismHooked)
259 | {
260 | plugin.prismEvent.callPrismEvent(plugin, "vvs-client-connect", player, clientProtocol.toString());
261 | }
262 |
263 | }
264 |
265 | // Send warning message and execute warning command
266 |
267 | private void handleMismatchedClientServerVersionsForTargetPlayer(Player player,
268 | String messageExemptPermission,
269 | String commandExemptPermission,
270 | String warnMessage,
271 | String warnCommand,
272 | String clientVersion,
273 | String serverVersion)
274 | {
275 | if (!player.hasPermission(messageExemptPermission) &&
276 | !warnMessage.isEmpty())
277 | {
278 | // Delay by 250 msec (5 ticks) to make sure the player sees the message
279 | Bukkit.getScheduler().runTaskLater(plugin, new Runnable()
280 | {
281 | @Override
282 | public void run()
283 | {
284 | if (player.isOnline())
285 | {
286 | player.sendMessage(ChatColor.translateAlternateColorCodes('&',
287 | warnMessage.replace("%player%", player.getName()).
288 | replace("%displayname%", player.getDisplayName()).
289 | replace("%version%", clientVersion).
290 | replace("%server%", serverVersion)));
291 | }
292 | }
293 | }, 5L); // time delay (ticks)
294 | }
295 |
296 | if (!player.hasPermission(commandExemptPermission) &&
297 | !warnCommand.isEmpty())
298 | {
299 | warnCommand = warnCommand.replace("%player%", player.getName()).
300 | replace("%displayname%", player.getDisplayName()).
301 | replace("%version%", clientVersion).
302 | replace("%server%", serverVersion);
303 | plugin.getLogger().info("Executing command " + warnCommand);
304 | try
305 | {
306 | Bukkit.getServer().dispatchCommand(Bukkit.getConsoleSender(), warnCommand);
307 | }
308 | catch (CommandException exc)
309 | {
310 | plugin.getLogger().warning("Command returned exception: " + exc.getMessage());
311 | }
312 | }
313 | }
314 | }
315 |
--------------------------------------------------------------------------------
/src/main/java/com/bobcat00/viaversionstatus/LogFilter.java:
--------------------------------------------------------------------------------
1 | // ViaVersionStatus - Logs players' client versions
2 | // Copyright 2022 Bobcat00
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, either version 3 of the License, or
7 | // (at your option) any later version.
8 | //
9 | // This program is distributed in the hope that it will be useful,
10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | // GNU General Public License for more details.
13 | //
14 | // You should have received a copy of the GNU General Public License
15 | // along with this program. If not, see .
16 |
17 | package com.bobcat00.viaversionstatus;
18 |
19 | import org.apache.logging.log4j.Level;
20 | import org.apache.logging.log4j.Marker;
21 | import org.apache.logging.log4j.core.Filter;
22 | import org.apache.logging.log4j.core.LifeCycle;
23 | import org.apache.logging.log4j.core.LogEvent;
24 | import org.apache.logging.log4j.core.Logger;
25 | import org.apache.logging.log4j.message.Message;
26 |
27 | public class LogFilter implements Filter
28 | {
29 | private String filterStr;
30 |
31 | public LogFilter(String filterStr)
32 | {
33 | this.filterStr = filterStr;
34 | }
35 |
36 | public Filter.Result checkMessage(String message)
37 | {
38 | if (message.contains(filterStr))
39 | {
40 | return Filter.Result.DENY;
41 | }
42 | else
43 | {
44 | return Filter.Result.NEUTRAL;
45 | }
46 | }
47 |
48 | public LifeCycle.State getState()
49 | {
50 | try
51 | {
52 | return LifeCycle.State.STARTED;
53 | }
54 | catch (Exception localException)
55 | {
56 | }
57 | return null;
58 | }
59 |
60 | public void initialize()
61 | {
62 | }
63 |
64 | public boolean isStarted()
65 | {
66 | return true;
67 | }
68 |
69 | public boolean isStopped()
70 | {
71 | return false;
72 | }
73 |
74 | public void start()
75 | {
76 | }
77 |
78 | public void stop()
79 | {
80 | }
81 |
82 | public Filter.Result filter(LogEvent event)
83 | {
84 | return checkMessage(event.getMessage().getFormattedMessage());
85 | }
86 |
87 | public Filter.Result filter(Logger arg0, Level arg1, Marker arg2, String message, Object... arg4)
88 | {
89 | return checkMessage(message);
90 | }
91 |
92 | public Filter.Result filter(Logger arg0, Level arg1, Marker arg2, String message, Object arg4)
93 | {
94 | return checkMessage(message);
95 | }
96 |
97 | public Filter.Result filter(Logger arg0, Level arg1, Marker arg2, Object message, Throwable arg4)
98 | {
99 | return checkMessage(message.toString());
100 | }
101 |
102 | public Filter.Result filter(Logger arg0, Level arg1, Marker arg2, Message message, Throwable arg4)
103 | {
104 | return checkMessage(message.getFormattedMessage());
105 | }
106 |
107 | public Filter.Result filter(Logger arg0, Level arg1, Marker arg2, String message, Object arg4, Object arg5)
108 | {
109 | return checkMessage(message);
110 | }
111 |
112 | public Filter.Result filter(Logger arg0, Level arg1, Marker arg2, String message, Object arg4, Object arg5,
113 | Object arg6)
114 | {
115 | return checkMessage(message);
116 | }
117 |
118 | public Filter.Result filter(Logger arg0, Level arg1, Marker arg2, String message, Object arg4, Object arg5,
119 | Object arg6, Object arg7)
120 | {
121 | return checkMessage(message);
122 | }
123 |
124 | public Filter.Result filter(Logger arg0, Level arg1, Marker arg2, String message, Object arg4, Object arg5,
125 | Object arg6, Object arg7, Object arg8)
126 | {
127 | return checkMessage(message);
128 | }
129 |
130 | public Filter.Result filter(Logger arg0, Level arg1, Marker arg2, String message, Object arg4, Object arg5,
131 | Object arg6, Object arg7, Object arg8, Object arg9)
132 | {
133 | return checkMessage(message);
134 | }
135 |
136 | public Filter.Result filter(Logger arg0, Level arg1, Marker arg2, String message, Object arg4, Object arg5,
137 | Object arg6, Object arg7, Object arg8, Object arg9, Object arg10)
138 | {
139 | return checkMessage(message);
140 | }
141 |
142 | public Filter.Result filter(Logger arg0, Level arg1, Marker arg2, String message, Object arg4, Object arg5,
143 | Object arg6, Object arg7, Object arg8, Object arg9, Object arg10, Object arg11)
144 | {
145 | return checkMessage(message);
146 | }
147 |
148 | public Filter.Result filter(Logger arg0, Level arg1, Marker arg2, String message, Object arg4, Object arg5,
149 | Object arg6, Object arg7, Object arg8, Object arg9, Object arg10, Object arg11, Object arg12)
150 | {
151 | return checkMessage(message);
152 | }
153 |
154 | public Filter.Result filter(Logger arg0, Level arg1, Marker arg2, String message, Object arg4, Object arg5,
155 | Object arg6, Object arg7, Object arg8, Object arg9, Object arg10, Object arg11, Object arg12, Object arg13)
156 | {
157 | return checkMessage(message);
158 | }
159 |
160 | public Filter.Result getOnMatch()
161 | {
162 | return Filter.Result.NEUTRAL;
163 | }
164 |
165 | public Filter.Result getOnMismatch()
166 | {
167 | return Filter.Result.NEUTRAL;
168 | }
169 |
170 | }
171 |
--------------------------------------------------------------------------------
/src/main/java/com/bobcat00/viaversionstatus/PrismEvent.java:
--------------------------------------------------------------------------------
1 | // ViaVersionStatus - Logs players' client versions
2 | // Copyright 2021 Bobcat00
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, either version 3 of the License, or
7 | // (at your option) any later version.
8 | //
9 | // This program is distributed in the hope that it will be useful,
10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | // GNU General Public License for more details.
13 | //
14 | // You should have received a copy of the GNU General Public License
15 | // along with this program. If not, see .
16 |
17 | package com.bobcat00.viaversionstatus;
18 |
19 | import org.bukkit.entity.Player;
20 | import org.bukkit.plugin.Plugin;
21 |
22 | import network.darkhelmet.prism.events.PrismCustomPlayerActionEvent;
23 |
24 | public class PrismEvent implements PrismEventInterface
25 | {
26 | public void callPrismEvent(Plugin plugin, String actionTypeName, Player player, String message)
27 | {
28 | PrismCustomPlayerActionEvent prismEvent = new PrismCustomPlayerActionEvent(plugin, actionTypeName, player, message);
29 | plugin.getServer().getPluginManager().callEvent(prismEvent);
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/src/main/java/com/bobcat00/viaversionstatus/PrismEventInterface.java:
--------------------------------------------------------------------------------
1 | // ViaVersionStatus - Logs players' client versions
2 | // Copyright 2021 Bobcat00
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, either version 3 of the License, or
7 | // (at your option) any later version.
8 | //
9 | // This program is distributed in the hope that it will be useful,
10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | // GNU General Public License for more details.
13 | //
14 | // You should have received a copy of the GNU General Public License
15 | // along with this program. If not, see .
16 |
17 | package com.bobcat00.viaversionstatus;
18 |
19 | import org.bukkit.entity.Player;
20 | import org.bukkit.plugin.Plugin;
21 |
22 | public interface PrismEventInterface
23 | {
24 | public void callPrismEvent(Plugin plugin, String actionTypeName, Player player, String message);
25 | }
26 |
--------------------------------------------------------------------------------
/src/main/java/com/bobcat00/viaversionstatus/PrismPlayerAction.java:
--------------------------------------------------------------------------------
1 | // ViaVersionStatus - Logs players' client versions
2 | // Copyright 2021 Bobcat00
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, either version 3 of the License, or
7 | // (at your option) any later version.
8 | //
9 | // This program is distributed in the hope that it will be useful,
10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | // GNU General Public License for more details.
13 | //
14 | // You should have received a copy of the GNU General Public License
15 | // along with this program. If not, see .
16 |
17 | package com.bobcat00.viaversionstatus;
18 |
19 | import network.darkhelmet.prism.actions.GenericAction;
20 |
21 | public class PrismPlayerAction extends GenericAction
22 | {
23 | private String extraInfo;
24 |
25 | @Override
26 | public String getNiceName()
27 | {
28 | if (extraInfo != null && !extraInfo.isEmpty())
29 | {
30 | return extraInfo;
31 | }
32 | return "";
33 | }
34 |
35 | @Override
36 | public boolean hasExtraData()
37 | {
38 | return extraInfo != null;
39 | }
40 |
41 | @Override
42 | public String serialize()
43 | {
44 | return extraInfo;
45 | }
46 |
47 | @Override
48 | public void deserialize(String data)
49 | {
50 | extraInfo = data;
51 | }
52 | }
53 |
--------------------------------------------------------------------------------
/src/main/java/com/bobcat00/viaversionstatus/ViaVersionStatus.java:
--------------------------------------------------------------------------------
1 | // ViaVersionStatus - Logs players' client versions
2 | // Copyright 2019 Bobcat00
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, either version 3 of the License, or
7 | // (at your option) any later version.
8 | //
9 | // This program is distributed in the hope that it will be useful,
10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | // GNU General Public License for more details.
13 | //
14 | // You should have received a copy of the GNU General Public License
15 | // along with this program. If not, see .
16 |
17 | package com.bobcat00.viaversionstatus;
18 |
19 | import org.apache.logging.log4j.LogManager;
20 | import org.apache.logging.log4j.core.Logger;
21 | import org.bstats.bukkit.Metrics;
22 | import org.bstats.charts.SimplePie;
23 | import org.bukkit.Bukkit;
24 | import org.bukkit.plugin.Plugin;
25 | import org.bukkit.plugin.java.JavaPlugin;
26 | import org.bukkit.scheduler.BukkitRunnable;
27 |
28 | import network.darkhelmet.prism.Prism;
29 | import network.darkhelmet.prism.actionlibs.ActionTypeImpl;
30 | import network.darkhelmet.prism.exceptions.InvalidActionException;
31 |
32 | public final class ViaVersionStatus extends JavaPlugin
33 | {
34 | ViaVersionStatus plugin = this;
35 | Config config;
36 | Listeners listeners;
37 | Prism prism;
38 | String prismVersion = "unknown";
39 | PrismEvent prismEvent; // Used to send event to Prism
40 | boolean prismHooked = false;
41 | boolean prismReady = false;
42 | int prismCounter = 0;
43 |
44 | @Override
45 | public void onEnable()
46 | {
47 | config = new Config(this);
48 | saveDefaultConfig();
49 | // Update old config file
50 | config.updateConfig();
51 |
52 | listeners = new Listeners(this);
53 |
54 | // Block "No light data found for chunk" messages
55 | if (config.getBlockNoLightDataWarnings())
56 | {
57 | ((Logger) LogManager.getRootLogger()).addFilter(new LogFilter("No light data found for chunk"));
58 | }
59 |
60 | // Prism
61 | if (config.getPrismIntegration())
62 | {
63 | Plugin prismPlugin = Bukkit.getPluginManager().getPlugin("Prism");
64 | if (prismPlugin != null && prismPlugin.isEnabled())
65 | {
66 | try
67 | {
68 | prism = (Prism) prismPlugin;
69 | prismVersion = prism.getDescription().getVersion();
70 |
71 | // Register our custom event. We have to wait until Prism is fully up and running.
72 | // We do this by waiting for PurgeManager to be set.
73 |
74 | new BukkitRunnable()
75 | {
76 | @Override
77 | public void run()
78 | {
79 | if (prismReady)
80 | {
81 | try
82 | {
83 | // Register the custom event
84 | ActionTypeImpl actionType = new ActionTypeImpl("vvs-client-connect", PrismPlayerAction.class, "client version");
85 | Prism.getActionRegistry().registerCustomAction(plugin, actionType);
86 | prismEvent = new PrismEvent();
87 | prismHooked = true;
88 | getLogger().info("Hooked into Prism version " + prismVersion);
89 | this.cancel();
90 | }
91 | catch (InvalidActionException e)
92 | {
93 | // Exception thrown by Prism
94 | getLogger().warning("Unable to hook into Prism: ");
95 | getLogger().warning(e.getMessage());
96 | getLogger().warning("Check Prism's config to ensure that tracking.api is true");
97 | getLogger().warning("and ViaVersionStatus is in the allowed-plugins list.");
98 | this.cancel(); // only try once
99 | }
100 | }
101 | else
102 | {
103 | if (prism.getPurgeManager() != null)
104 | {
105 | // Wait until next invocation to hook into Prism
106 | prismReady = true;
107 | }
108 | ++prismCounter;
109 | // Cancel if we tried 50 times
110 | if (prismCounter >= 50)
111 | {
112 | getLogger().warning("Unable to hook into Prism. Check if Prism is working.");
113 | this.cancel();
114 | }
115 | }
116 | }
117 | }.runTaskTimer(this,
118 | 1L, // delay 1 tick
119 | 4L); // period 200 msec
120 | }
121 | catch (NoClassDefFoundError e)
122 | {
123 | getLogger().warning("Unable to hook into Prism. Make sure you are using Prism version 3.x or later.");
124 | }
125 | }
126 | else
127 | {
128 | getLogger().warning("prism-integration is true but Prism is not present or not enabled.");
129 | }
130 | }
131 |
132 | // Metrics
133 | if (config.getEnableMetrics())
134 | {
135 | int pluginId = 4834;
136 | Metrics metrics = new Metrics(this, pluginId);
137 |
138 | metrics.addCustomChart(new SimplePie("connection_used", () -> listeners.getConnectionUsed().toString()));
139 | metrics.addCustomChart(new SimplePie("viaversion", () -> Bukkit.getPluginManager().isPluginEnabled("ViaVersion") ? "Yes" : "No"));
140 | metrics.addCustomChart(new SimplePie("viabackwards", () -> Bukkit.getPluginManager().isPluginEnabled("ViaBackwards") ? "Yes" : "No"));
141 | metrics.addCustomChart(new SimplePie("viarewind", () -> Bukkit.getPluginManager().isPluginEnabled("ViaRewind") ? "Yes" : "No"));
142 | metrics.addCustomChart(new SimplePie("notify_ops", () -> config.getNotifyOps() && !config.getNotifyString().isEmpty() ? "Yes" : "No"));
143 | metrics.addCustomChart(new SimplePie("notify_command", () -> config.getNotifyOps() && !config.getNotifyCommand().isEmpty() ? "Yes" : "No"));
144 | metrics.addCustomChart(new SimplePie("warn_players", () -> config.getOlderVersionWarnPlayers() && !config.getOlderVersionWarnString().isEmpty() ? "Yes" : "No"));
145 | metrics.addCustomChart(new SimplePie("warn_command", () -> config.getOlderVersionWarnPlayers() && !config.getOlderVersionWarnCommand().isEmpty() ? "Yes" : "No"));
146 | metrics.addCustomChart(new SimplePie("warn_players_newer", () -> config.getNewerVersionWarnPlayers() && !config.getNewerVersionWarnString().isEmpty() ? "Yes" : "No"));
147 | metrics.addCustomChart(new SimplePie("warn_command_newer", () -> config.getNewerVersionWarnPlayers() && !config.getNewerVersionWarnCommand().isEmpty() ? "Yes" : "No"));
148 | metrics.addCustomChart(new SimplePie("listener_priority", () -> config.getHighPriority() ? "Monitor" : "Normal"));
149 | metrics.addCustomChart(new SimplePie("list_protocols", () -> config.getListSupportedProtocols() ? "Yes" : "No"));
150 | metrics.addCustomChart(new SimplePie("block_no_light", () -> config.getBlockNoLightDataWarnings() ? "Yes" : "No"));
151 | metrics.addCustomChart(new SimplePie("prism_integration", () -> config.getPrismIntegration() ? prismVersion : "No"));
152 |
153 | getLogger().info("Metrics enabled if allowed by plugins/bStats/config.yml");
154 | }
155 | }
156 |
157 | @Override
158 | public void onDisable()
159 | {
160 | }
161 |
162 | public void shutdown()
163 | {
164 | setEnabled(false);
165 | }
166 |
167 | }
168 |
--------------------------------------------------------------------------------
/src/main/java/com/bobcat00/viaversionstatus/connections/Connection.java:
--------------------------------------------------------------------------------
1 | // ViaVersionStatus - Logs players' client versions
2 | // Copyright 2019 Bobcat00
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, either version 3 of the License, or
7 | // (at your option) any later version.
8 | //
9 | // This program is distributed in the hope that it will be useful,
10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | // GNU General Public License for more details.
13 | //
14 | // You should have received a copy of the GNU General Public License
15 | // along with this program. If not, see .
16 |
17 | package com.bobcat00.viaversionstatus.connections;
18 |
19 | import java.util.List;
20 |
21 | import org.bukkit.entity.Player;
22 |
23 | public interface Connection
24 | {
25 | boolean isValid();
26 |
27 | ProtocolVersion getProtocol(Player player);
28 |
29 | ProtocolVersion getServerProtocol();
30 |
31 | List getSupportedProtocols();
32 | }
33 |
--------------------------------------------------------------------------------
/src/main/java/com/bobcat00/viaversionstatus/connections/ProtocolVersion.java:
--------------------------------------------------------------------------------
1 | // ViaVersionStatus - Logs players' client versions
2 | // Copyright 2019 Bobcat00
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, either version 3 of the License, or
7 | // (at your option) any later version.
8 | //
9 | // This program is distributed in the hope that it will be useful,
10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | // GNU General Public License for more details.
13 | //
14 | // You should have received a copy of the GNU General Public License
15 | // along with this program. If not, see .
16 |
17 | package com.bobcat00.viaversionstatus.connections;
18 |
19 | public class ProtocolVersion
20 | {
21 | int id;
22 | String name;
23 |
24 | // Constructors
25 |
26 | ProtocolVersion()
27 | {
28 | id = -1;
29 | name = "UNKNOWN";
30 | }
31 |
32 | ProtocolVersion(int id, String name)
33 | {
34 | this.id = id;
35 | this.name = name;
36 | }
37 |
38 | // Public methods
39 |
40 | public int getId()
41 | {
42 | return id;
43 | }
44 |
45 | public String getName()
46 | {
47 | return name;
48 | }
49 |
50 | public String toString()
51 | {
52 | return name + "(" + id + ")";
53 | }
54 |
55 | }
56 |
--------------------------------------------------------------------------------
/src/main/java/com/bobcat00/viaversionstatus/connections/ViaConnection.java:
--------------------------------------------------------------------------------
1 | // ViaVersionStatus - Logs players' client versions
2 | // Copyright 2019 Bobcat00
3 | //
4 | // This program is free software: you can redistribute it and/or modify
5 | // it under the terms of the GNU General Public License as published by
6 | // the Free Software Foundation, either version 3 of the License, or
7 | // (at your option) any later version.
8 | //
9 | // This program is distributed in the hope that it will be useful,
10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | // GNU General Public License for more details.
13 | //
14 | // You should have received a copy of the GNU General Public License
15 | // along with this program. If not, see .
16 |
17 | package com.bobcat00.viaversionstatus.connections;
18 |
19 | import java.util.ArrayList;
20 | import java.util.List;
21 | import java.util.SortedSet;
22 |
23 | import org.bukkit.Bukkit;
24 | import org.bukkit.entity.Player;
25 |
26 | import com.viaversion.viaversion.api.Via;
27 | import com.viaversion.viaversion.api.ViaAPI;
28 |
29 | public class ViaConnection implements Connection
30 | {
31 | private boolean valid;
32 | @SuppressWarnings("rawtypes")
33 | private ViaAPI api;
34 |
35 | // Constructor
36 |
37 | public ViaConnection()
38 | {
39 | valid = Bukkit.getPluginManager().isPluginEnabled("ViaVersion");
40 | if (valid)
41 | {
42 | api = Via.getAPI();
43 | }
44 | }
45 |
46 | // isValid
47 |
48 | public boolean isValid()
49 | {
50 | return valid;
51 | }
52 |
53 | // getProtocol
54 |
55 | @SuppressWarnings("unchecked")
56 | public ProtocolVersion getProtocol(Player player)
57 | {
58 | ProtocolVersion protocol = new ProtocolVersion();
59 |
60 | if (api != null)
61 | {
62 | protocol.id = api.getPlayerProtocolVersion(player).getVersion();
63 | protocol.name = com.viaversion.viaversion.api.protocol.version.ProtocolVersion.getProtocol(protocol.id).getName();
64 | }
65 |
66 | return protocol;
67 | }
68 |
69 | // getServerProtocol
70 |
71 | public ProtocolVersion getServerProtocol()
72 | {
73 | ProtocolVersion protocol = new ProtocolVersion();
74 |
75 | if (api != null)
76 | {
77 | protocol.id = api.getServerVersion().highestSupportedProtocolVersion().getVersion();
78 | protocol.name = com.viaversion.viaversion.api.protocol.version.ProtocolVersion.getProtocol(protocol.id).getName();
79 | }
80 |
81 | return protocol;
82 | }
83 |
84 | // getSupportedProtocols
85 |
86 | public List getSupportedProtocols()
87 | {
88 | List versions = new ArrayList();
89 |
90 | if (api != null)
91 | {
92 | @SuppressWarnings("unchecked")
93 | SortedSet protocols = api.getSupportedProtocolVersions();
94 |
95 | for (com.viaversion.viaversion.api.protocol.version.ProtocolVersion protocol : protocols)
96 | {
97 | versions.add(new ProtocolVersion(protocol.getVersion(),
98 | com.viaversion.viaversion.api.protocol.version.ProtocolVersion.getProtocol(protocol.getVersion()).getName()));
99 | }
100 | }
101 |
102 | return versions;
103 | }
104 |
105 | }
106 |
--------------------------------------------------------------------------------
/src/main/resources/config.yml:
--------------------------------------------------------------------------------
1 | # Strings should be enclosed in double quotes: "..."
2 | # Supported variables are %player%, %displayname%, %version%, and %server%
3 | # \n can be used as a line break
4 |
5 | # Notify ops when a player joins
6 | notify-ops: true
7 | notify-string: "&6Player &c%player% &6is using version &c%version%"
8 | notify-command: ""
9 |
10 | # Warn players when they are using an older version
11 | warn-players: true
12 | warn-string: "&cNOTICE: You are running Minecraft version &e%version%\n&cThe recommended version for this server is &a%server%"
13 | warn-command: ""
14 |
15 | # Warn players when they are using a newer version
16 | warn-players-newer: true
17 | warn-string-newer: "&cNOTICE: You are running Minecraft version &e%version%\n&cThe recommended version for this server is &a%server%"
18 | warn-command-newer: ""
19 |
20 | # Run at the highest priority (MONITOR)
21 | # Set to true if %displayname% doesn't work as expected
22 | high-priority: false
23 |
24 | # At startup, list the protocols supported by ViaVersion
25 | list-supported-protocols: true
26 |
27 | # Block "No light data found for chunk" warning messages
28 | block-no-light-data-warnings: false
29 |
30 | # Enable metrics (subject to bStats global config)
31 | enable-metrics: true
32 |
33 | # Record data via Prism, with the action vvs-client-connect
34 | prism-integration: false
35 |
--------------------------------------------------------------------------------
/src/main/resources/license.txt:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/src/main/resources/plugin.yml:
--------------------------------------------------------------------------------
1 | name: ViaVersionStatus
2 | main: com.bobcat00.viaversionstatus.ViaVersionStatus
3 | version: ${project.version}
4 | author: Bobcat00
5 | api-version: '1.18'
6 | depend: [ViaVersion]
7 | softdepend: [ViaBackwards, ViaRewind, Prism]
8 | permissions:
9 | viaversionstatus.exempt.*:
10 | description: Exempts this player from processing at join
11 | children:
12 | viaversionstatus.exempt: true
13 | viaversionstatus.exempt.log: true
14 | viaversionstatus.exempt.notify: true
15 | viaversionstatus.exempt.notify.message: true
16 | viaversionstatus.exempt.notify.command: true
17 | viaversionstatus.exempt.warn: true
18 | viaversionstatus.exempt.warn.message: true
19 | viaversionstatus.exempt.warn.command: true
20 | viaversionstatus.exempt.warn.newer: true
21 | viaversionstatus.exempt.warn.newer.message: true
22 | viaversionstatus.exempt.warn.newer.command: true
23 | viaversionstatus.exempt:
24 | description: Exempts this player from all processing at join
25 | default: false
26 | viaversionstatus.exempt.log:
27 | description: Exempts this player from client version being logged at join
28 | default: false
29 | viaversionstatus.exempt.notify:
30 | description: Exempts this player from notifying other players at join while also preventing them from triggering the configured join notification command
31 | default: false
32 | viaversionstatus.exempt.notify.message:
33 | description: Exempts this player from notifying other players at join
34 | default: false
35 | viaversionstatus.exempt.notify.command:
36 | description: Exempts this player from triggering the configured join notification command
37 | default: false
38 | viaversionstatus.exempt.warn:
39 | description: Exempts this player from receiving an older version warning while also preventing them from triggering the configured older version warning command
40 | default: false
41 | viaversionstatus.exempt.warn.message:
42 | description: Exempts this player from receiving an older version warning
43 | default: false
44 | viaversionstatus.exempt.warn.command:
45 | description: Exempts this player from triggering the configured older version warning command
46 | default: false
47 | viaversionstatus.exempt.warn.newer:
48 | description: Exempts this player from receiving an newer version warning while also preventing them from triggering the configured newer version warning command
49 | default: false
50 | viaversionstatus.exempt.warn.newer.message:
51 | description: Exempts this player from receiving a newer version warning
52 | default: false
53 | viaversionstatus.exempt.warn.newer.command:
54 | description: Exempts this player from triggering the configured newer version warning command
55 | default: false
56 | viaversionstatus.notify:
57 | description: Allows this player to receive messages for other players' client versions at join
58 | default: op
59 | viaversionstatus.notify.ignoresame:
60 | description: Do not display version if client version equals server version
61 | default: false
62 |
--------------------------------------------------------------------------------