This repository was archived by the owner on Sep 3, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathindex.html
290 lines (290 loc) · 13.9 KB
/
index.html
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>League Sandbox by LeagueSandbox</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" type="text/css" href="stylesheets/normalize.css" media="screen">
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/github-light.css" media="screen">
</head>
<body>
<section class="page-header">
<h1 class="project-name">League Sandbox</h1>
<h2 class="project-tagline"></h2>
</section>
<section class="main-content">
<h1>
<a id="leaguesandbox" class="anchor" href="#leaguesandbox" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>LeagueSandbox
</h1>
<p>
DotNet port and continuation of <a href="https://github.com/MythicManiac/IntWars/">IntWars</a>
<br>
Project chat on Discord: <a href="https://discord.gg/Bz3znAM">https://discord.gg/Bz3znAM</a>
</p>
<h1>
<a id="project-repositories" class="anchor" href="#project-repositories" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Project repositories
</h1>
<ul>
<li><a href="https://github.com/LeagueSandbox/leaguesandbox.github.io">leaguesandbox.github.io</a></li>
<li><a href="https://github.com/LeagueSandbox/ContentSerializer">ContentSerializer</a></li>
<li><a href="https://github.com/LeagueSandbox/LobbyClient">LobbyClient</a></li>
<li><a href="https://github.com/LeagueSandbox/LobbyServer">LobbyServer</a></li>
<li><a href="https://github.com/LeagueSandbox/GameServer">GameServer</a></li>
</ul>
<h1>
<a id="c-contributing" class="anchor" href="#contributing" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Contributing
</h1>
<p>
We're looking for people interested in contributing to the project.
Currently the technologies we use include:
</p>
<ul>
<li>C#</li>
<li>Electron</li>
<li>Node.js</li>
<li>Vue</li>
<li>Socket.io</li>
</ul>
<p>
If you're interested in contributing, come find us from <a href="https://discord.gg/Bz3znAM">Discord</a> and let us know
</p>
<h1>
<a id="documents-and-specifications" class="anchor" href="#documents-and-specifications" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Documents and specifications
</h1>
<ul>
<li><a href="/lobby-system-specifications">Lobby system use cases and networking protocol specification</a></li>
<li><a href="/networking-infrastructure">Networking infrastructure</a></li>
</ul>
<h1>
<a id="c-guidelines" class="anchor" href="#c-guidelines" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>C# guidelines
</h1>
<ul>
<li>Function names in <code>CamelCase</code></li>
<li>Constants in <code>ALL_CAPS</code></li>
<li>Private variables in <code>_pascalCaseWithUnderscore</code></li>
<li>Public properties as getters / setters in <code>CamelCase</code></li>
<li>All public variable access should happen through getters / setters</li>
</ul>
<h1>
<a id="custom-content-data-structure" class="anchor" href="#custom-content-data-structure" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Custom content data structure
</h1>
<pre><code>
Data
LeagueSandbox-Default // A content package by "LeagueSandbox" called "Default"
Champions
Items
Buffs
...
SomeAuthor-SomePackage // A content package by "SomeAuthor" called "SomePackage"
Champions
...
GameMode
LeagueSandbox-Default // Game mode by "LeagueSandbox" called "Default"
Data // Data that's local to this gamemode only
Champions
Items
Buffs
...
Scripts // Game mode related logic
SomeScript.lua
SomeOtherScript.lua
...
GameMode.json // Game mode configuration file
</code></pre>
<ul>
<li>
Two kinds of packages
<ul>
<li>
Data packages
<ul>
<li>Contain data and logic for things such as champions, items, buffs, etc...</li>
</ul>
</li>
<li>
Game mode packages
<ul>
<li>Contain configuration and logic for the gamemode</li>
<li>Configuration that determines what data this mode depends on</li>
</ul>
</li>
</ul>
</li>
<li>
Data should be stored in JSON files
<ul>
<li>So for example, damage, range, health, etc...</li>
</ul>
</li>
<li>
Logic should be stored in lua files
<ul>
<li>Lua is capable of using the data stored in the mentioned JSON files</li>
</ul>
</li>
<li>
These two should be always separate, so no mixing data into lua
<ul>
<li>All predetermined values in JSON</li>
</ul>
</li>
<li>
Packages are to be named using a {author}/{package} format
<ul>
<li>This to avoid collisions with similarly named packages</li>
</ul>
</li>
<li>Content will be identified in a {author}/{package}/{type}/{name} format, thus why namespacing is required</li>
</ul>
<h1>
<a id="planned-overall-configurationinfrastructure" class="anchor" href="#planned-overall-configurationinfrastructure" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Planned overall configuration/infrastructure
</h1>
<p>5 different components:</p>
<ul>
<li>
League of Legends 4.20 Client
<ul>
<li>By Riot</li>
<li>Will be modified only by the client patcher</li>
</ul>
</li>
<li>
Content serializer
<ul>
<li>Patches custom content into the game client's files</li>
<li>Serializes custom content into a format the game can understand</li>
<li>Deserializes the game's content into our custom content format</li>
<li>Builds single file packages out of custom content packages</li>
</ul>
</li>
<li>
Lobby client
<ul>
<li>Client that can connect to lobby servers</li>
<li>Game mode selection</li>
<li>User settings (champion, summoner spells, etc)</li>
<li>
Game mode settings (if a gamemode has configurable settings, say, kill limit for a deathmatch victory)
<ul>
<li>Host only</li>
</ul>
</li>
<li>Receives custom content from the lobby server before the game is started</li>
</ul>
</li>
<li>
Lobby server
<ul>
<li>
Lobby clients can create lobbies
<ul>
<li>Lobby creator gets host privileges</li>
</ul>
</li>
<li>Lobby clients can connect to existing lobbies</li>
<li>Sends lobby clients the gamemode specific custom content</li>
<li>Takes care of launching the game server when the game is started</li>
</ul>
</li>
<li>Game server
<ul>
<li>Receives game settings from the lobby server</li>
<li>Runs the game according to the received settings</li>
</ul>
</li>
</ul>
<h1>
<a id="beta-milestone" class="anchor" href="#beta-release-goals" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Beta release goals
</h1>
<p>A graph of features that should be done before a beta release</p>
<img src="media/beta-milestone.png"></img>
<h1>
<a id="credits" class="anchor" href="#credits" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Credits
</h1>
<table>
<thead>
<tr>
<th></th>
<th></th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td>Intline9</td>
<td>Original creator</td>
<td><a href="https://github.com/Intline9">https://github.com/Intline9</a></td>
</tr>
<tr>
<td>Ltsstar</td>
<td>Contributor</td>
<td><a href="https://github.com/ltsstar">https://github.com/ltsstar</a></td>
</tr>
<tr>
<td>Elyotna</td>
<td>Old project lead</td>
<td><a href="https://github.com/Elyotna">https://github.com/Elyotna</a></td>
</tr>
<tr>
<td>Horato</td>
<td>C# port original author</td>
<td><a href="https://github.com/horato">https://github.com/horato</a></td>
</tr>
<tr>
<td>Eddy5641</td>
<td>Contributor</td>
<td><a href="https://github.com/eddy5641">https://github.com/eddy5641</a></td>
</tr>
<tr>
<td>Chutch1122</td>
<td>Contributor</td>
<td><a href="https://github.com/chutch1122">https://github.com/chutch1122</a></td>
</tr>
<tr>
<td>Spudgy</td>
<td>Contributor</td>
<td><a href="https://github.com/spudgy">https://github.com/spudgy</a></td>
</tr>
<tr>
<td>Mythic</td>
<td>
Project manager<br>
Lead developer
</td>
<td><a href="https://github.com/MythicManiac">https://github.com/MythicManiac</a></td>
</tr>
<tr>
<td>Coquicox</td>
<td>Contributor</td>
<td><a href="https://github.com/coquicox">https://github.com/coquicox</a></td>
</tr>
<tr>
<td>NitroXenon</td>
<td>Contributor</td>
<td><a href="https://github.com/NitroXenon">https://github.com/NitroXenon</a></td>
</tr>
<tr>
<td>Fighter19</td>
<td>Contributor</td>
<td><a href="https://github.com/Fighter19">https://github.com/Fighter19</a></td>
</tr>
<tr>
<td>Molenzwiebel</td>
<td>Contributor</td>
<td><a href="https://github.com/molenzwiebel">https://github.com/molenzwiebel</a></td>
</tr>
<tr>
<td>TheWebs</td>
<td>Contributor</td>
<td><a href="https://github.com/TheWebs">https://github.com/TheWebs</a></td>
</tr>
</tbody>
</table>
<footer class="site-footer">
<span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a> using the <a href="https://github.com/jasonlong/cayman-theme">Cayman theme</a> by <a href="https://twitter.com/jasonlong">Jason Long</a>.</span>
</footer>
</section>
</body>
</html>