• Elona on HSPlet
  • Introduction
  • Bugs / RFEs / Unimplemented Features
    • Contributing
      • Discussions
      • Filing Issues
  • Legal
    • Notices
    • HSPlet modifications
    • HSPlet original code
    • Note
    • License Texts
    • Libraries
      • WrapLog
      • OW2 Consortium ASM
      • BrowserLauncher2
      • JLayer 1.0
      • Javolution
      • Henrik Bengtsson's Java printf
      • SQLite JDBC
      • XML Pull Parser 3rd Edition
      • XStream
  • QuickStart
  • What's this?
    • Platform Requirements
  • Running Elona on HSPlet
  • Acknowledgements
  • What's Next?
    • Known Issues

Elona on HSPlet

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.

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

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.

Bugs / RFEs / Unimplemented Features

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.

Discussions

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=4777http://elona.squares.net/forum/viewtopic.php?f=3&t=4777.  Bugs can be posted to the Redmine installation at HostedRedmine.

Filing Issues

There are several categories for issues:

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

Legal

Elona is copyright Noa.

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/).

HSPlet modifications

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

Portions copyright 2010-2012 John Stroy
Portions copyright 2011-2012 Shen Chen Xu
Portions copyright 2012 Kejardon

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file 
except in compliance with the License.  You may obtain a copy of the License at

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

Unless required by applicable law or agreed to in writing, software distributed under the 
License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 
either express or implied.  See the License for the specific language governing permissions 
and limitations under the License.

HSPlet original code

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

You can freely use and modify and publish HSPLet for any purpose anytime and anywhere as 
long as it is based on good intentions.

Copyright 2005-2006 Yuki/group-finity and others.

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.

License Texts

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

Libraries

HSPlet relies on several additional libraries to perform its work.

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

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

WrapLog

//Copyright (c) 2005, Thomas Aglassinger
//All rights reserved.
//
//Redistribution and use in source and binary forms, with or without
//modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright
//notice, this list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright
//notice, this list of conditions and the following disclaimer in the
//documentation and/or other materials provided with the distribution.
//
// * Neither the name of the author nor the names of its contributors
//may be used to endorse or promote products derived from this software
//without specific prior written permission.
//
//THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
//IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
//THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
//PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
//CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
//EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
//PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
//PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
//LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
//NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

OW2 Consortium ASM

Copyright (c) 2000-2011 INRIA, France Telecom
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holders nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
THE POSSIBILITY OF SUCH DAMAGE.

BrowserLauncher2

/************************************************
    Copyright 2004,2005,2006,2007 Markus Gebhard, Jeff Chapman

    This file is part of BrowserLauncher2.

    BrowserLauncher2 is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    BrowserLauncher2 is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with BrowserLauncher2; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

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

JLayer 1.0

/*  
 *-----------------------------------------------------------------------
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU Library General Public License as published
 *   by the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU Library General Public License for more details.
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this program; if not, write to the Free Software
 *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *----------------------------------------------------------------------
 */

Javolution

/*
 * Javolution - Java(tm) Solution for Real-Time and Embedded Systems
 * Copyright (c) 2012, Javolution (http://javolution.org/)
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

Henrik Bengtsson's Java printf

Copyright 1997-2003 by Henrik Bengtsson. All rights reserved. 

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

 Redistribution and use in binary forms, without modification, are permitted 
for the unregistered version provided that the following condition are met:
 1. You can use the Java printf package free of charge for private use or 
research/educational use. Any commerical usage of the package requires a 
commercial license.
 2. Redistributions is ONLY permitted for the unregistered version and in a 
non-profit purpose. The redistribution must reproduce the above copyright 
notice, the offical URL, these conditions, the following disclaimer in the 
documentation and the following acknowledgement and/orother materials provided 
with the distribution.
 3. Redistribution of the commercial version is ONLY permitted if it is 
redistributed internally as part of a software that requires the Java printf 
package and is developed by anyone who paid for the commercial license. The 
commercial version may not be redistributed in the purpose of making the Java 
printf API available to third-party software developers. 

DISCLAIMER 

 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY 
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE. 

ACKNOWLEDGEMENT 

 By downloading and/or using the package you acknowledge that you have read this 
statement, understand it, and agree to be bound by its terms and conditions.

SQLite JDBC

/*
 * Copyright (c) 2007 David Crawshaw <david@zentus.com>
 * 
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

Copyright (c) 2006, David Crawshaw.  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
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");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

XML Pull Parser 3rd Edition

Indiana University Extreme! Lab Software License

Version 1.1.1

Copyright (c) 2002 Extreme! Lab, Indiana University. All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions 
are met:

1. Redistributions of source code must retain the above copyright notice, 
   this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright 
   notice, this list of conditions and the following disclaimer in 
   the documentation and/or other materials provided with the distribution.

3. The end-user documentation included with the redistribution, if any, 
   must include the following acknowledgment:

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

Alternately, this acknowledgment may appear in the software itself, 
if and wherever such third-party acknowledgments normally appear.

4. The names "Indiana Univeristy" and "Indiana Univeristy Extreme! Lab" 
must not be used to endorse or promote products derived from this 
software without prior written permission. For written permission, 
please contact http://www.extreme.indiana.edu/.

5. Products derived from this software may not use "Indiana Univeristy" 
name nor may "Indiana Univeristy" appear in their name, without prior 
written permission of the Indiana University.

THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHORS, COPYRIGHT HOLDERS OR ITS CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

XStream

Copyright (c) 2003-2006, Joe Walnes
Copyright (c) 2006-2009, 2011 XStream Committers
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of
conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of
conditions and the following disclaimer in the documentation and/or other materials provided
with the distribution.

3. Neither the name of XStream nor the names of its contributors may be used to endorse
or promote products derived from this software without specific prior written
permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
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.
Extract elona122.zip.
Extract elona122.j.zip to the same directory as elona122.zip.
Double click on release.cmd.

What's this?

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

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

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.

You can obtain this package from Noa's website:

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

Platform Requirements

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.

Running Elona on HSPlet

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

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.

Acknowledgements

Thanks for all of those who have supported this effort.

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.

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).
• Elona+, ELM, OreHack, Elona 1.16xmas on HSPlet
• Bypassing and rewriting Elona's original code entirely ;)

Known Issues

• Certain path information (tmp directory) is incorrect when run on Linux
• Graphics rendering performance is slow (though better than Elona under Wine on Linux)
• DirectSound/DirectMusic is unimplemented
• DirectInput (gamepad/joystick) is unimplemented
• Network access (chat and vote) is unimplemented
• Water effect is unimplemented
• Graphics corruption in introduction screens
• Graphics corruption on non-default window sizes in title screen
• Auto numlock is not supported
• Shadows (elona.dll:grotate) are still not quite right
• HSPlet does not handle spaces in file paths.