projectrixor.github.io/Tutorial.html at master · ProjectRixor/projectrixor.github.io · GitHub

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
<!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.0">
    <meta name="description" content="">
    <meta name="author" content="">
    <link rel="shortcut icon" href="https://avatars2.githubusercontent.com/u/6866854?s=35">
    <title>Rixor | Tutorial</title>
    <link href="css/bootstrap.css" rel="stylesheet">
    <script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
    <script src="js/bootstrap.js"></script>
    <link rel="stylesheet" href="font-awesome/css/font-awesome.css">
    <script type='text/javascript'>
        $(document).ready(function () {
         if ($("[rel=tooltip]").length) {
         $("[rel=tooltip]").tooltip();
         }
        });
    </script>
  </head>

  <body style="padding-top: 30px;">
    <div class="container">

    <div class="navbar navbar-default" role="navigation">
      <div class="container">
        <div class="navbar-header">
          <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
            <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" href="https://github.com/ProjectRixor"><img src="https://avatars2.githubusercontent.com/u/6866854?s=20"> Rixor</a>
        </div>
        <div class="collapse navbar-collapse">
          <ul class="nav navbar-nav">
            <li class="divider"></li>
            <li rel="tooltip" data-placement="bottom" title="Main Site"><a href="index.html"><i class="fa fa-home"></i> Home</a></li>
            <li class="active" rel="tooltip" data-placement="bottom" title="How to setup Rixor"><a href="Tutorial.html"><i class="fa fa-info-circle"></i> Tutorial</a></li>
            <li rel="tooltip" data-placement="bottom" title="Full Rixor Documentation"><a href="Docs.html"><i class="fa fa-book"></i> Docs</a></li>
            <li rel="tooltip" data-placement="bottom" title="View Code"><a href="https://github.com/ProjectRixor/Rixor"><i class="fa fa-code"></i> Code</a></li>
            <li id="dl" style="display:none;"></li>
            </ul>
            <p class="navbar-text navbar-right"><a href="https://github.com" class="navbar-link"><i class="fa fa-github"></i> Github</a></p>
            <p></p>
        </div>
      </div>
    </div>

        <div class="btn-group btn-group-justified">
              <a class="btn btn-primary disabled" disabled href="#">English</a>
              <a class="btn btn-default" href="es/Tutorial.html">Español</a>
          </div>

          <hr/>

    <!--Navbar End / Start of the content-->
        <div class="alert alert-warning">
        <p><strong><i class="fa fa-exclamation-circle"></i> Important</strong> Rixor requires Java 7!</p>
        </div>
        <div class="panel panel-default">
            <div class="panel-heading">
                <h1 class="panel-title">General Info</h1>
            </div>
            <div class="panel-body">
                <p>Overcast Scrimmage plugin utilising the OCN XML system!<br/>
                    This plugin is a fork of ParaPGM by ParaPenguin. Thanks to him, we have the base for this plugin</p>
            </div>
        </div>

        <div class="panel panel-default">
            <div class="panel-heading">
                <h1 class="panel-title">1. Downloading the files</h1>
            </div>
            <div class="panel-body">
                <p>
                    Before you can setup your server, you will need to download some files. Here is a list.<br>
                    <strong>BarAPI.jar</strong> = Download at the <a href="https://github.com/ProjectRixor/Rixor/releases">Releases</a> section of this GitHub.<br>
                    <strong>Dom4j.jar</strong> = Download at the <a href="https://github.com/ProjectRixor/Rixor/releases">Releases</a> section of this GitHub.<br>
                    <strong>Rixor.jar</strong> = Download at the <a href="https://github.com/ProjectRixor/Rixor/releases">Releases</a> section of this GitHub.<br>
                    <strong>WorldEdit</strong> = <a href="http://dev.bukkit.org/bukkit-plugins/worldedit/">http://dev.bukkit.org/bukkit-plugins/worldedit/</a>
                </p>
            </div>
        </div>

        <div class="panel panel-default">
            <div class="panel-heading">
                <h1 class="panel-title">2. Getting the libraries you need</h1>
            </div>
            <div class="panel-body">
                <p>
                    First, place the BarAPI.jar in the "plugins" folder in your server folder.<br>
                    It would look something like this:<br>
                    <em class="text-info">.../Server Folder/plugins/BarAPI.jar</em><hr/>
                    Then, make a folder named "libs" in your server folder then place the Dom4j.jar in that folder.<br>
                    It would look something like this:<br>
                    <em class="text-info">.../Server Folder/libs/Dom4j.jar</em><hr/>
                    Then, place the Rixor.jar in the "plugins" folder as well.<br>
                    It would look something like this:<br>
                    <em class="text-info">.../Server Folder/plugins/Rixor.jar</em><hr/>
                    Lastly, place the 2 WorldEdit files "contrib" folder and WorldEdit.jar inside the "plugins" as well.<br>
                    It would look something like this:<br>
                    <em class="text-info">.../Server Folder/plugins/contrib/</em><br>
                    <em class="text-info">.../Server Folder/plugins/WorldEdit.jar</em>
                </p>
            </div>
        </div>

        <div class="panel panel-default">
            <div class="panel-heading">
                <h1 class="panel-title">3. Creating and adding to the maps repository</h1>
            </div>
            <div class="panel-body">
                <p>
                    Before you can go any further, you must make sure that your Maps repository contains AT LEAST 1 map, without this the plugin will have a little cry and fail to load correctly.
                </p>
                <p>
                    The format of the folder should be <em class="text-info">.../Server Folder/maps/{MAP FOLDER}/</em><br> So if I wanted to use RFV2 then it would be <em class="text-info">.../Server Folder/maps/RFV2/</em>
                </p>
                <p>
                    Also make sure that there is a map.xml located in the map folder that would look something like this.<br>
                    <em class="text-info">.../Server Folder/maps/{MAP FOLDER}/map.xml</em><br>
                    So if I wanted to use RFV2 then it would be <em class="text-info">.../Server Folder/maps/RFV2/map.xml</em>
                </p>
            </div>
        </div>

        <div class="panel panel-default">
            <div class="panel-heading">
                <h1 class="panel-title">4. Config</h1>
            </div>
            <div class="panel-body">
                <p>
                Your config.yml (<em class="text-info">/plugins/Rixor/config.yml</em>) should look like this:</p>
                    <pre>team: TeamName<br/>rotation:<br/>- Map 1<br/>- Map 2<br/>- Map 3<br/></pre>
            </div>
        </div>

      <div class="panel panel-default">
            <div class="panel-heading">
                <h1 class="panel-title">5. To recap</h1>
            </div>
            <div class="panel-body">
                <p>
                    Your server folder should look something like this (The maps in the <em>maps</em> folder can be different):<hr/>
                    <img src="img/Example.png" class="img-thumbnail"><hr/>
                    <strong class="text-danger">Make sure that your maps have a map.xml file!</strong><br/>
                    It's okay if some folders are missing, they will be automatically generated once you start up the server.<br/>
                    Also don't worry about the "world" folder, it's not going to be loaded.
                </p>
            </div>
        </div>

        <div class="panel panel-default">
            <div class="panel-heading">
                <h1 class="panel-title">Compiling your own version of ParaPGM <em>(for developers only)</em></h1>
            </div>
            <div class="panel-body">

<p>You can get the jars from Maven. </p>

<p>After that, export the plugin and you're ready to roll! Just add it to your plugins folder, and follow the setup process below.</p>
            </div>
        </div>

    </div><!-- /Main container -->
      <script type="text/javascript">
            jQuery.extend({
                getValues: function(url) {
                    $.ajax({
                        url: url,
                        type: 'get',
                        dataType: 'JSON',
                        async: false,
                        success: function(data) {
                            result = data;
                        }
                    });
                    return result;
                }
            });
            $.getValues("https://api.github.com/repos/ProjectRixor/Rixor/releases");
            var dlbtn = '<li rel="tooltip" data-placement="bottom" title="'+result[0].name+'"><a href="'+result[0].html_url+'" target="blank"><i class="fa fa-cloud-download"></i> Download</a></li>';
            window.document.getElementById('dl').outerHTML=dlbtn;
        </script>
  </body>
</html>