Readme-elona122-prealpha1 (Releases.Readme-elona122-prealpha1)

= Elona on HSPlet =

4

5

This is the README file for Elona 1.22 on HSPlet Pre-Alpha 1.

== Introduction ==

It's been over two years years since I've embarked on this journey to get Elona running on HSPlet. Over the years, I've put the project aside and returned to it many times. March 2011 brought one of the most influential events to the project (via Daedric): making it public. Since then, many people have joined this project to help. Through their efforts, we've reached a milestone after 1 year and 8 months.

10

11

The time has come to announce the first public distribution of Elona on HSPlet, Pre-Alpha 1.

12

13

Elona on HSPlet PA1 is the result of many months of work from the developers, testers, translators, and supporters. It's only the beginning of a journey, however; there is still much work ahead. PA1 only gives a preview of what's possible.

14

15

== Bugs / RFEs / Unimplemented Features ==

16

17

Expect PA1 to contain bugs and unimplemented features. Many of these unimplemented features (for example, DirectSound, DirectMusic, auto numlock support, water effects, etc.) are already known. PA1 includes a configuration file (config.txt) which permits Elona to run with a sane set of default options that avoid unimplemented features.

=== Contributing ===

Feel free to contribute by updating the wiki at http://elonadev.myxwiki.org/[[http://elonadev.myxwiki.org/]] to document unimplemented features.

22

23

==== Discussions ====

24

25

Discussion should be directed to the Continuation Project topic in the Elona forum, which can be found at http://elona.squares.net/forum/viewtopic.php?f=3&t=4777[[http://elona.squares.net/forum/viewtopic.php?f=3&t=4777]]. Bugs can be posted to the Redmine installation at [[HostedRedmine>>http://www.hostedredmine.com/]].

26

27

==== Filing Issues ====

28

29

There are several categories for issues:

30

31

|=Type|=Description|=Project name|=URL

32

|Elona-specific|These issues can be reproduced in the original builds of Elona that do not run on HSPlet. Examples include the well-known Blackjack bug in Elona 1.22, eating Maintains Luck items resulting in a crash, etc.|elona|https://www.hostedredmine.com/projects/hsplet/issues/new

33

|Elona on HSPlet|These new issues created by running Elona on HSPlet that cannot be reproduced in the original builds of Elona. You are most likely to interact with this project. If you aren't sure where a particular bug belongs, it probably belongs here.|hsplet-elona|https://www.hostedredmine.com/projects/hsplet-elona/issues/new

34

|HSPlet|These are issues within the HSPlet engine itself. Typically, these are bugs promoted from the Elona on HSPlet project, though this may also include global feature requests from other HSPlet users.|hsplet|https://www.hostedredmine.com/projects/hsplet/issues/new

35

36

Issues start out in a triage area for confirmation before they are promoted to bugs.

== Legal ==

Elona is copyright Noa.

41

42

Elona on HSPlet is a derived work (machine translation) of Elona, and as such, licensed under the terms given by Noa. Additionally, Elona on HSPlet is a derived work of HSPlet.

=== Notices ===

{{{This product includes software developed by the Indiana University Extreme! Lab (http://www.extreme.indiana.edu/).

47

}}}

48

49

=== HSPlet modifications ===

50

51

Some parts of HSPlet are licensed under the Apache License 2.0:

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file

58

except in compliance with the License. You may obtain a copy of the License at

59

60

http://www.apache.org/licenses/LICENSE-2.0

61

62

Unless required by applicable law or agreed to in writing, software distributed under the

63

License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,

64

either express or implied. See the License for the specific language governing permissions

65

and limitations under the License.

66

}}}

67

68

=== HSPlet original code ===

69

70

The original code to HSPlet is licensed under the following license:

71

72

{{{You can freely use and modify and publish HSPLet for any purpose anytime and anywhere as

73

long as it is based on good intentions.

}}}

=== Note ===

While the Apache License 2.0 does not place any restrictions on additional license restrictions, the GPL requires that no additional restrictions may be placed on further distribution; as such, you should clarify with your lawyer if the "good intention" restriction of HSPlet is suitable for inclusion in any copy-left licensed software.

81

82

=== License Texts ===

83

84

License texts may be found in the doc/hsplet/license/ directory.

=== Libraries ===

HSPlet relies on several additional libraries to perform its work.

89

90

You should clarify with your lawyer if the any of the restrictions below may preclude your use of HSPlet.

91

92

The following libraries may be included in HSPlet. Their license text is included below.

==== WrapLog ====

//

//Redistribution and use in source and binary forms, with or without

100

//modification, are permitted provided that the following conditions are met:

101

//

102

// * Redistributions of source code must retain the above copyright

103

//notice, this list of conditions and the following disclaimer.

104

//

105

// * Redistributions in binary form must reproduce the above copyright

106

//notice, this list of conditions and the following disclaimer in the

107

//documentation and/or other materials provided with the distribution.

108

//

109

// * Neither the name of the author nor the names of its contributors

110

//may be used to endorse or promote products derived from this software

111

//without specific prior written permission.

112

//

113

//THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS

114

//IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,

115

//THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

116

//PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR

117

//CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

118

//EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

119

//PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

120

//PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

121

//LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

122

//NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

123

//SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

124

}}}

125

126

==== OW2 Consortium ASM ====

Redistribution and use in source and binary forms, with or without

132

modification, are permitted provided that the following conditions

133

are met:

134

135

1. Redistributions of source code must retain the above copyright

136

notice, this list of conditions and the following disclaimer.

137

138

2. Redistributions in binary form must reproduce the above copyright

139

notice, this list of conditions and the following disclaimer in the

140

documentation and/or other materials provided with the distribution.

141

142

3. Neither the name of the copyright holders nor the names of its

143

contributors may be used to endorse or promote products derived from

144

this software without specific prior written permission.

145

146

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

147

AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

148

IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

149

ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE

150

LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

151

CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

152

SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

153

INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

154

CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

155

ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF

156

THE POSSIBILITY OF SUCH DAMAGE.

157

}}}

158

159

==== BrowserLauncher2 ====

160

161

{{{/************************************************

162

163

164

This file is part of BrowserLauncher2.

165

166

BrowserLauncher2 is free software; you can redistribute it and/or modify

167

it under the terms of the GNU Lesser General Public License as published by

168

the Free Software Foundation; either version 2 of the License, or

169

(at your option) any later version.

170

171

BrowserLauncher2 is distributed in the hope that it will be useful,

172

but WITHOUT ANY WARRANTY; without even the implied warranty of

173

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

174

GNU Lesser General Public License for more details.

175

176

You should have received a copy of the GNU Lesser General Public License

177

along with BrowserLauncher2; if not, write to the Free Software

178

Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

179

180

************************************************/

}}}

==== JLayer 1.0 ====

{{{/*

*-----------------------------------------------------------------------

187

* This program is free software; you can redistribute it and/or modify

188

* it under the terms of the GNU Library General Public License as published

189

* by the Free Software Foundation; either version 2 of the License, or

190

* (at your option) any later version.

191

*

192

* This program is distributed in the hope that it will be useful,

193

* but WITHOUT ANY WARRANTY; without even the implied warranty of

194

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

195

* GNU Library General Public License for more details.

196

*

197

* You should have received a copy of the GNU Library General Public

198

* License along with this program; if not, write to the Free Software

199

* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

200

*----------------------------------------------------------------------

*/

}}}

==== Javolution ====

{{{/*

* Javolution - Java(tm) Solution for Real-Time and Embedded Systems

*

* Redistribution and use in source and binary forms, with or without

212

* modification, are permitted provided that the following conditions are met:

213

*

214

* 1. Redistributions of source code must retain the above copyright

215

* notice, this list of conditions and the following disclaimer.

216

*

217

* 2. Redistributions in binary form must reproduce the above copyright

218

* notice, this list of conditions and the following disclaimer in the

219

* documentation and/or other materials provided with the distribution.

220

*

221

* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

222

* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

223

* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

224

* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR

225

* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

226

* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

227

* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

228

* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

229

* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

230

* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

231

* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

}}}

==== Henrik Bengtsson's Java printf ====

The official URL of the Java printf() site is http://www.braju.com/

240

241

Redistribution and use in binary forms, without modification, are permitted

242

for the unregistered version provided that the following condition are met:

243

1. You can use the Java printf package free of charge for private use or

244

research/educational use. Any commerical usage of the package requires a

245

commercial license.

246

2. Redistributions is ONLY permitted for the unregistered version and in a

247

non-profit purpose. The redistribution must reproduce the above copyright

248

notice, the offical URL, these conditions, the following disclaimer in the

249

documentation and the following acknowledgement and/orother materials provided

250

with the distribution.

251

3. Redistribution of the commercial version is ONLY permitted if it is

252

redistributed internally as part of a software that requires the Java printf

253

package and is developed by anyone who paid for the commercial license. The

254

commercial version may not be redistributed in the purpose of making the Java

255

printf API available to third-party software developers.

DISCLAIMER

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY

260

EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

261

WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.

262

IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,

263

INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

264

LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

265

PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,

266

WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

267

ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

268

POSSIBILITY OF SUCH DAMAGE.

ACKNOWLEDGEMENT

By downloading and/or using the package you acknowledge that you have read this

273

statement, understand it, and agree to be bound by its terms and conditions.

274

}}}

275

276

==== SQLite JDBC ====

{{{/*

*

* Permission to use, copy, modify, and/or distribute this software for any

282

* purpose with or without fee is hereby granted, provided that the above

283

* copyright notice and this permission notice appear in all copies.

284

*

285

* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES

286

* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

287

* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR

288

* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES

289

* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN

290

* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF

291

* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

*/

}}}

Redistribution and use in source and binary forms, with or without

298

modification, are permitted provided that the following conditions

299

are met:

300

301

1. Redistributions of source code must retain the above copyright

302

notice, this list of conditions and the following disclaimer.

303

2. Redistributions in binary form must reproduce the above copyright

304

notice, this list of conditions and the following disclaimer in the

305

documentation and/or other materials provided with the distribution.

306

307

THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND

308

ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

309

IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

310

ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE

311

FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

312

DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS

313

OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

314

HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

315

LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

316

OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

SUCH DAMAGE.

}}}

{{{Licensed under the Apache License, Version 2.0 (the "License");

321

you may not use this file except in compliance with the License.

322

You may obtain a copy of the License at

323

324

http://www.apache.org/licenses/LICENSE-2.0

325

326

Unless required by applicable law or agreed to in writing, software

327

distributed under the License is distributed on an "AS IS" BASIS,

328

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

329

See the License for the specific language governing permissions and

330

limitations under the License.

331

}}}

332

333

==== XML Pull Parser 3rd Edition ====

334

335

{{{Indiana University Extreme! Lab Software License

Version 1.1.1

Redistribution and use in source and binary forms, with or without

342

modification, are permitted provided that the following conditions

343

are met:

344

345

1. Redistributions of source code must retain the above copyright notice,

346

this list of conditions and the following disclaimer.

347

348

2. Redistributions in binary form must reproduce the above copyright

349

notice, this list of conditions and the following disclaimer in

350

the documentation and/or other materials provided with the distribution.

351

352

3. The end-user documentation included with the redistribution, if any,

353

must include the following acknowledgment:

354

355

"This product includes software developed by the Indiana University

356

Extreme! Lab (http://www.extreme.indiana.edu/)."

357

358

Alternately, this acknowledgment may appear in the software itself,

359

if and wherever such third-party acknowledgments normally appear.

360

361

4. The names "Indiana Univeristy" and "Indiana Univeristy Extreme! Lab"

362

must not be used to endorse or promote products derived from this

363

software without prior written permission. For written permission,

364

please contact http://www.extreme.indiana.edu/.

365

366

5. Products derived from this software may not use "Indiana Univeristy"

367

name nor may "Indiana Univeristy" appear in their name, without prior

368

written permission of the Indiana University.

369

370

THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED

371

WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

372

MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.

373

IN NO EVENT SHALL THE AUTHORS, COPYRIGHT HOLDERS OR ITS CONTRIBUTORS

374

BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

375

CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

376

SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR

377

BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,

378

WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR

379

OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF

380

ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

}}}

==== XStream ====

Redistribution and use in source and binary forms, with or without

390

modification, are permitted provided that the following conditions are met:

391

392

1. Redistributions of source code must retain the above copyright notice, this list of

393

conditions and the following disclaimer.

394

395

2. Redistributions in binary form must reproduce the above copyright notice, this list of

396

conditions and the following disclaimer in the documentation and/or other materials provided

397

with the distribution.

398

399

3. Neither the name of XStream nor the names of its contributors may be used to endorse

400

or promote products derived from this software without specific prior written

401

permission.

402

403

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY

404

EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES

405

OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT

406

SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,

407

INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED

408

TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR

409

BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

410

CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY

411

WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH

DAMAGE.

}}}

== QuickStart ==

Download [[http://noaneko.squares.net/dev/elona122.zip]].

418

Extract elona122.zip.

419

Extract elona122.j.zip to the same directory as elona122.zip.

420

Double click on release.cmd.

== What's this? ==

Elona on HSPlet brings Elona to the Java platform through the HSPlet framework.

425

426

This package only includes the code to run Elona 1.22 on HSPlet and its configuration data.

427

428

Elona on HSPlet does not come with the resources required to play. You must extract the contents of this package into a directory containing Elona 1.22.

429

430

You can obtain this package from Noa's website:

431

432

http://noaneko.squares.net/dev/elona122.zip

433

434

=== Platform Requirements ===

435

436

You need Java 1.7.0 or later to run Elona on HSPlet. You can download Java here:

http://java.com/en/

Elona on HSPlet has been tested on Windows. Linux support is incomplete, and Solaris, BSD, and OS X have not been tested. You are encouraged to test other platforms to report success and failure.

441

442

== Running Elona on HSPlet ==

443

444

Extract both the release archive and elona122.zip to the same directory. Run release.cmd to start Elona on HSPlet.

445

446

As with any other software, you should keep a backup copy of all your files before running Elona on HSPlet. We cannot be held responsible for any damages to you or your property caused by anything you do with this software. Be sure to back up your saved games before running Elona on HSPlet.

447

448

== Acknowledgements ==

449

450

Thanks for all of those who have supported this effort.

451

452

Special thanks to Noa, Kejardon, Doorknob, Daedric, Fellstar, Chrusable, sxu, JammyHammy; thanks to BitBucket / Atlassian for hosting this project, and the XWiki team for hosting the wiki for this project.

453

454

Be sure to thank our early testers for volunteering their time and providing their input.

== What's Next? ==

* Testing on more platforms (Mac, Linux, Solaris, *BSD).

459

* Elona+, ELM, OreHack, Elona 1.16xmas on HSPlet

460