-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.html
More file actions
192 lines (164 loc) · 7.73 KB
/
api.html
File metadata and controls
192 lines (164 loc) · 7.73 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Server Assistant - Minecraft Server Monitoring and issue reporting/handling tool">
<meta name="author" content="storm345">
<title>Server Assistant</title>
<link rel="icon"
type="image/png"
href="img/brand/logo_icon.png">
<!-- Bootstrap Core CSS -->
<link href="css/bootstrap.min.css" rel="stylesheet">
<!-- Custom CSS -->
<link href="css/landing-page.css" rel="stylesheet">
<!-- Custom Fonts -->
<link href="font-awesome/css/font-awesome.min.css" rel="stylesheet" type="text/css">
<link href="https://fonts.googleapis.com/css?family=Lato:300,400,700,300italic,400italic,700italic" rel="stylesheet" type="text/css">
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body data-spy="scroll" data-target=".navbar" data-offset="50">
<!-- Navigation -->
<nav class="navbar navbar-default navbar-fixed-top topnav" role="navigation">
<div class="container topnav">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand topnav" href="index.html" style="padding-top:0px;"><img src="img/brand/logo_reduced.png" style="height:50px;" alt="Server Assistant" /></a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right">
<li>
<a href="index.html#about">About</a>
</li>
<li>
<a href="index.html#download">Download</a>
</li>
<li>
<a href="index.html#documentation">Documentation</a>
</li>
<li>
<a href="index.html#api">API</a>
</li>
<li>
<a href="https://github.com/storm345/ServerAssistantIssues/issues" target="_blank" >Report Issue</a>
</li>
</ul>
</div>
<!-- /.navbar-collapse -->
</div>
<!-- /.container -->
</nav>
<div class="content-section-a" id="pagecontent" style="padding-bottom:5px;">
<div class="container">
<a href="index.html#api" class="lead"><span class="fa fa-toggle-left"></span> Back to homepage</a>
</div>
<!-- /.container -->
</div>
<a name="content"></a>
<div class="content-section-a" id="pagecontent" style="padding-top:5px;">
<div class="container">
<h1>The Server Assistant API</h1>
<div id="javadocs">
<h2>Javadocs</h2>
<p class="lead">You can find the Javadocs for the API <a href="javadoc/index.html" target="_blank">here</a>. If you know what you are doing, the Javadocs should be all you need to help you program.</p>
</div>
<div class="apiTutorialContainer">
<h2>Basic Tutorial</h2>
<div class="apiTutorial" id="depedencyTutorial">
<h3>Adding ServerAssistant as a dependency to your plugin:</h3>
<ol>
<li>
<p>In your plugin.yml you will need to add ServerAssistant as a dependency. After, your plugin.yml should look something like this:</p>
<pre>name: <Plugin Name>
author: '<Your Name>'
main: <PluginMainClass>
version: <Version>
depend: [ServerAssistant]</pre>
<p>This now means that your plugin will load after Server Assistant.</p>
</li>
<li>
<p>You will next need to add the 'ServerAssistant.jar' as a compile time dependency in your IDE/Dependency Management system.</p>
<h4>With gradle:</h4>
<ol>
<li>
<p>Since Server Assistant isn't in a maven repository, you'll need to tell gradle to look for dependencies in the filesystem. Add the following to your gradle script:</p>
<pre>repositories {
flatDir {
dirs 'C:/ServerAssistant/'
}
}</pre>
<p>Make sure that the directory you specify (Eg. C:/ServerAssistant/) isn't part of the your code repository. <strong>You may not include ServerAssistant in any public code or maven repository.</strong></p>
</li>
<li>
<p>Next, place your downloaded ServerAssistant JAR into the directory you specified in the script. The jar should be named something like 'ServerAssistant-1.0.jar'.</p>
</li>
<li>
<p>Finally, you will need to add the following to your gradle script</p>
<pre>dependencies {
compile name: 'ServerAssistant-1.0'
}</pre><p>Make sure that the name specified matches the name of your ServerAssistant JAR</p>
</li>
</ol>
<h4>With eclipse:</h4>
<ol>
<li>Right click on your project and then click on properties.<br><img src="img/api/setup/eclipse/1.png" /></li>
<li>Open the 'Java Build Path' page, go to the 'Libraries' tab and click 'Add External JARs'<br><img src="img/api/setup/eclipse/2.png" /></li>
<li>Navigate to where your JAR is located, select it and then press 'Open'. Make sure the JAR isn't included in your code repository. <strong>You may not include ServerAssistant in any public code or maven repository.</strong><br><img src="img/api/setup/eclipse/3.png" /></li>
<li>Press the 'Ok' button to finish.</li>
</ol>
</li>
</ol>
</div>
<div class="apiTutorial" id="example">
<h3>Getting an instance of the API:</h3>
<pre class="codeExample">ServerMonitorAPI api = ServerMonitorAPIProvider.getAPI();</pre>
<p>Once you have an instance of the API, you can use the javadocs to find out what you are able to do. <br><b>For example, if you want to broadcast a message to the server when it is lagging:</b></p>
<span>On enable: </span><pre class="codeExample">api.getResponseManager().addResponder(new LagBroadcastResponder());</pre>
<span>LagBroadcastResponder class: </span><pre class="codeExample">public class LagBroadcastResponder implements Responder {
@Override
public ServerEventType[] getListenedEvents() {
return new ServerEventType[]{ServerEventType.LAG};
}
@Override
public void respond(ServerEvent event) {
LagReport report = (LagReport) event.getReport();
Bukkit.broadcastMessage("The server is lagging! TPS is "+report.getTps());
}
}</pre>
</div>
</div>
<p class="lead"></p>
</div>
<!-- /.container -->
</div>
<!-- /.content-section-a -->
<!-- Footer -->
<footer>
<div class="container">
<div class="row">
<div class="col-lg-12">
<p class="copyright text-muted small">Copyright © storm345 2016. All Rights Reserved</p>
</div>
</div>
</div>
</footer>
<!-- jQuery -->
<script src="js/jquery.js"></script>
<!-- Bootstrap Core JavaScript -->
<script src="js/bootstrap.min.js"></script>
</body>
</html>