readme.mkd

   1 # SquirrelJME
   2
   3 **SquirrelJME** is a Java ME 8 Virtual Machine for embedded and Internet of
   4 Things devices, it also is a platform for the _Software Preservation_ of
   5 mobile Java ME devices. This includes Japanese Keitai software as well! It
   6 has the ultimate goal of being _99.9%_ compatible with the Java ME standard.
   7
   8 **SquirrelJME**'s runtime library is written purely in Java with a simple
   9 abstraction layer on top of native hardware, or otherwise. This allows the
  10 runtime to be portable across various different systems along with
  11 separation of concerns between software running in Java and the hardware. All
  12 native access is performed via this abstraction layer and as such there are
  13 no usages of `native` in any specific class, thus only the classes in the
  14 abstraction layer require a native implementation.
  15
  16 There additionally is _NanoCoat_, which is an execution engine written in C
  17 to allow for running SquirrelJME in a cross-platform way without a dependent
  18 host virtual machine.
  19
  20 Additionally, there is a port of SquirrelJME to RetroArch which enables the
  21 ability to play older J2ME software and games designed for flip-phones.
  22
  23  * Copyright (C) 2013-2024 Stephanie Gawroriski <xer@multiphasicapps.net>
  24  * "SquirrelJME" and "Lex" are trademarked by Stephanie Gawroriski 2016-2024
  25  * _Lex_ and The _SquirrelJME_ Logo were illustrated by...
  26    * Kat Adam-MacEwen
  27    * Kat@CMYKat Designs & Illustrations <http://www.cmykat-designs.com/>
  28
  29 Please support me on [Patreon](https://www.patreon.com/SquirrelJME)!
  30
  31 Thank you to [Hit Save!](https://hitsave.org/) for sponsoring **SquirrelJME**!
  32
  33 > Dedicated to _Emily_ (1998-2020), the developer
  34 > of [Mu](https://github.com/meepingsnesroms/Mu), I valued our friendship
  35 > greatly and all the time we would spend together nerding about technical
  36 > stuff, programming, and random topics. I do miss when we would play SNES
  37 > and NeoGeo games for hours, they were cherished moments. The times goofing
  38 > about in Kirby's Dream Course (SNES) were some of the most fun times spent
  39 > with you. We both loves PalmOS devices and I always loved to hear about the
  40 > new odd and quirky things you discovered about them.
  41 > -- You will not be forgotten, rest in peace.
  42
  43 And...
  44
  45 > Dedicated to _Near_ (1983-2021), the developer of Higan, Ares, etc. and
  46 > otherwise. You were and still are one of the kindest and most caring person
  47 > that I knew. You showed me lots of support and encouragement with my own
  48 > preservation work, and also helped me find the right people to connect with
  49 > to further that goal. I still do miss our daily conversations, even though
  50 > it is ironic that we rarely if ever spoke about emulation development there
  51 > were so many other topics of conversation to go through. Honestly without
  52 > you, I would not be where I am today and to this day I am holding you close
  53 > and true to my heart. I push forward for you while holding myself high, I
  54 > know that you would be proud of where I am today.
  55 > -- You will not be forgotten, rest in peace.
  56
  57 _SquirrelJME_ utilizes _Install4J_ for cross-platform installers, you can
  58 read more about it and check out their product page at:
  59
  60  * [Install4J Multi-Platform Installer Builder](
  61     https://www.ej-technologies.com/products/install4j/overview.html)
  62
  63 Badges:
  64
  65  * _Checks and Quality_
  66    * [![CircleCI](
  67      https://img.shields.io/circleci/build/github/SquirrelJME/SquirrelJME/trunk.svg?label=CircleCI%20Build)](
  68      https://circleci.com/gh/SquirrelJME/SquirrelJME/tree/trunk)
  69    * [![Code Climate Maintainability](
  70      https://img.shields.io/codeclimate/maintainability-percentage/SquirrelJME/SquirrelJME)](
  71      https://codeclimate.com/github/SquirrelJME/SquirrelJME)
  72      [![Code Climate technical debt](
  73      https://img.shields.io/codeclimate/tech-debt/SquirrelJME/SquirrelJME)](
  74      https://codeclimate.com/github/SquirrelJME/SquirrelJME)
  75    * [![Docker Build](
  76      https://img.shields.io/docker/cloud/build/xerthesquirrel/squirreljme.svg?label=Docker%20Container)](
  77      https://hub.docker.com/r/xerthesquirrel/squirreljme/builds)
  78    * [![RetroArch Core](
  79      https://git.libretro.com/libretro/SquirrelJME/badges/trunk/pipeline.svg?key_text=RetroArch%20Core&key_width=115)](
  80      https://git.libretro.org/libretro/SquirrelJME)
  81  * _Social and Community_
  82    * [![Discord](https://img.shields.io/discord/278929900893634560.svg?label=Discord%20Server)](
  83      https://discord.gg/9PkMMKt)
  84    * [![Twitter](
  85      https://img.shields.io/twitter/follow/SquirrelJME.svg?label=Follow%20on%20Twitter)](
  86      https://twitter.com/SquirrelJME)
  87  * _Downloads and Activity_
  88    * ![Commit Activity](
  89      https://img.shields.io/github/commit-activity/w/SquirrelJME/SquirrelJME.svg?label=Code%20Commits)
  90    * [![Docker Pulls](
  91      https://img.shields.io/docker/pulls/xerthesquirrel/squirreljme?label=Docker%20Pulls)](
  92      https://hub.docker.com/r/xerthesquirrel/squirreljme)
  93    * [![SourceForge Downloads](
  94      https://img.shields.io/sourceforge/dm/squirreljme.svg?label=SourceForge%20Downloads)](
  95      https://sourceforge.net/projects/squirreljme/files/)
  96  * _Donations_
  97    * [![Liberapay](
  98      https://img.shields.io/liberapay/receives/xershadowtail.svg?logo=liberapay&label=LiberaPay)](
  99      https://liberapay.com/xershadowtail)
 100
 101 Information:
 102
 103  * [User Guide](assets/user-guide/readme.mkd)
 104  * [Code of Conduct](code-of-conduct.mkd)
 105  * [License](license.mkd)
 106    * _Source_: Mozilla Public License 2.0
 107    * _Assets_: Creative Commons CC-BY-SA 4.0
 108    * _Fonts_ : SIL Open Font License Version 1.1
 109    * [Third Party Licenses](third-party.mkd)
 110  * [Contributing to SquirrelJME](contributing.mkd)
 111    * [Credits of Contributions](credits.mkd)
 112    * [Test Writing](test-writing.mkd)
 113  * _End-User Documents_
 114    * [Building](building.mkd)
 115    * [Changelog](changelog.mkd)
 116    * [Compatibility](compatibility.mkd)
 117    * [History](history.mkd)
 118    * [Release Roadmap](route.mkd)
 119  * _Developer Resources_
 120    * [CircleCI Status](
 121      https://circleci.com/gh/SquirrelJME/SquirrelJME/tree/trunk)
 122    * [Developer Guide](developer-guide.mkd)
 123    * [Developer Notes](assets/developer-notes/index.mkd)
 124    * [Design Document](design.mkd)
 125    * [Porting SquirrelJME](porting.mkd)
 126    * [Project Scope](scope.mkd)
 127    * [CLDC 1.8 API (docs.oracle.com)](
 128      https://docs.oracle.com/javame/8.0/api/cldc/api/overview-summary.html)
 129
 130 ## Repository
 131
 132  * [Online repository](http://squirreljme.cc/)
 133    ([HTTPS](https://squirreljme.cc/),
 134    [Tor (A)](http://vzwveldr7djnlpg7ujslaqre632htbl3unkmfbltpgumevw63jn47dad.onion/),
 135    [Tor (B)](http://hrkzpyi33og6j5z3anfpjuqkawvkw4kxyasrp64elg3i6dffihmdhxad.onion/))
 136  * SquirrelJME uses `fossil` <http://fossil-scm.org/>.
 137  * The repository may be cloned using Fossil:
 138    * One of these commands:
 139      * `fossil clone -u http://squirreljme.cc/ squirreljme.fossil`
 140      * `fossil clone -u https://squirreljme.cc/ squirreljme.fossil`
 141      * `fossil clone -u http://vzwveldr7djnlpg7ujslaqre632htbl3unkmfbltpgumevw63jn47dad.onion/ squirreljme.fossil`
 142      * `fossil clone -u http://hrkzpyi33og6j5z3anfpjuqkawvkw4kxyasrp64elg3i6dffihmdhxad.onion/ squirreljme.fossil`
 143      * `fossil clone -u http://squirrelmfbf2udn.onion/ squirreljme.fossil`
 144    * `mkdir squirreljme`
 145    * `cd squirreljme`
 146    * `fossil open ../squirreljme.fossil`
 147  * Alternatively via [GitHub](https://github.com/SquirrelJME/SquirrelJME):
 148    * `git clone https://github.com/SquirrelJME/SquirrelJME`
 149    * `cd SquirrelJME`
 150  * Alternatively via [repo.or.cz](https://repo.or.cz/SquirrelJME.git):
 151    * `git clone https://repo.or.cz/SquirrelJME.git`
 152    * `cd SquirrelJME`
 153  * Trunk Source Snapshot (Main website or `fossil serve` only):
 154    * [TAR.GZ](/tarball/squirreljme-trunk.tar.gz?uuid=trunk)
 155    * [ZIP](/zip/squirreljme-trunk.zip?uuid=trunk)
 156
 157 ## Links
 158
 159  * [My Portfolio](https://shadowtail.dev/)
 160  * [My Public PGP Key](public-key.gpg.mkd)
 161  * [SquirrelJME BlueSky](https://bsky.app/profile/squirreljme.bsky.social)
 162  * [SquirrelJME Twitter](https://twitter.com/SquirrelJME)
 163  * [SquirrelJME Mastodon](https://mastodon.online/@SquirrelJME)
 164  * Locations where you can get support:
 165    * [Discord](https://discord.gg/9PkMMKt)
 166    * _LiberaChat (IRC)_ (Bridged to _Discord_)
 167      * [#squirreljme](ircs://irc.libera.chat:6697/squirreljme) -- Main Support
 168      * [#squirreljme-softwares](ircs://irc.libera.chat:6697/squirreljme-software) -- Software channel
 169      * [##squirreljme](ircs://irc.libera.chat:6697/#squirreljme) -- Off-Topic
 170    * [Reddit](https://reddit.com/r/SquirrelJME)
 171  * Front facing social media:
 172    * [BlueSky](https://bsky.app/profile/squirreljme.bsky.social)
 173    * [Mastodon (mastodon.online)](https://mastodon.online/@SquirrelJME)
 174    * [YouTube](https://www.youtube.com/channel/UCbmC7qQjeXUEUyE5XfDX5RA/)
 175    * [Twitter](https://twitter.com/SquirrelJME)
 176  * [Docker Hub](https://hub.docker.com/r/xerthesquirrel/squirreljme)
 177  * [SourceForge](https://sourceforge.net/p/squirreljme/)
 178  * Personal Accounts (If you wish to contact me this way)
 179    * [GitHub](https://github.com/XerTheSquirrel/)
 180    * [Keybase](https://keybase.io/xerthesquirrel)
 181    * [LinkedIn](https://www.linkedin.com/in/xerthesquirrel/)
 182    * [Mastodon (chitter.xyz)](https://chitter.xyz/@XerShadowTail)
 183    * [BlueSky](https://bsky.app/profile/xershadowtail.bsky.social)
 184    * [Twitter](https://twitter.com/XerShadowTail)
 185    * [Cohost](https://cohost.org/XerShadowTail)
 186    * [YouTube (Personal)](
 187      https://www.youtube.com/channel/UCJ4QrvbDhjtd7u6EpfBQ__g)
 188    * E-Mail: <xer@multiphasicapps.net>
 189
 190 ## Goals
 191
 192  * _To be small_ - Smaller programs are easier to maintain and are usually
 193    simpler.
 194  * _To be fast_ - With the potential of AOT/JIT, systems that do not normally
 195    have a port of an existing virtual machine will usually only have an
 196    interpreter.
 197  * _To be compatible_ - So that existing Java ME 8 applications can run on this
 198    virtual machine, along with J2ME applications when required. This has the
 199    added bonus of allowing one to use older software to catalog for
 200    preservation.
 201  * _To compile once and run anywhere_ - Current and up to date Java
 202    implementations are limited only to a few select systems (_Solaris_,
 203    _Linux_, _BSD_, _Mac OS X_, and _Windows_). Java ME 8 as of this writing
 204    only supports the *FRDM-K64F* (dropped), *STM32429I-EVAL*, *Raspberry Pi*,
 205    *Intel Galileo Gen2* (preview), and *STM 32F746G DISCOVERY* (preview) all
 206    of which are either out of date or discontinued by their manufacturers.
 207    There are multitudes of devices that support **J2ME**, however that is
 208    horribly out of date when compared with the Java that is used today
 209    (**J2ME** is equal to Java 1.4 which was released in _2002_).
 210
 211 ## Donations
 212
 213 You may donate to SquirrelJME to which would be used by the author to keep the
 214 web server online, the purchasing of new hardware/software, and for the
 215 purchasing of food items for consumption.
 216
 217  * Traditional
 218    * [Ko-Fi](http://ko-fi.com/xerthesquirrel)
 219    * [Patreon](https://www.patreon.com/SquirrelJME)
 220    * [Liberapay](https://liberapay.com/xershadowtail)
 221
 222 ## Important Statements
 223
 224 ***JAVA AND ALL OTHER RELATED TRADEMARKS AND COPYRIGHTS ARE OWNED BY ORACLE
 225 CORPORATION <http://www.oracle.com/>.***
 226
 227 ***SQUIRRELJME IS NEITHER PRODUCED BY, ENDORSED BY, NOR SUPPORTED BY
 228 _ORACLE CORPORATION_.***
 229
 230 ***ALL SOURCE CODE IS WRITTEN BY MYSELF WITH FUNCTIONALITY DETERMINED BY THE
 231 DOCUMENTED APIS AND RUN-TIME BEHAVIOR. I HAVE NOT LOOKED AT THE SOURCE CODE FOR
 232 OTHER IMPLEMENTATIONS, NEITHER FREE SOFTWARE NOR PROPRIETARY IMPLEMENTATIONS.
 233 ESSENTIALLY SQUIRRELJME IS A CLEAN-ROOM IMPLEMENTATION OF THE DESIGN OF JAVA
 234 ME 8. THE IMPLEMENTATIONS OF THE JAVA ME 8 APIS AND ASSOCIATED JSRS/JEPS IS
 235 CONSIDERED BY MYSELF (STEPHANIE GAWRORISKI) TO BE IN THE FAIR USE.***
 236
 237 ***THIS SOFTWARE IS INCOMPLETE AND IN ITS CURRENT STATE IS NOT CURRENTLY
 238 100% COMPATIBLE WITH JAVA ME 8. THERE ARE CURRENTLY NO STABLE RELEASED VERSIONS
 239 OF THIS SOFTWARE. AS SUCH THE FIRST MAJOR VERSION RELEASE WILL BE WHEN IT IS
 240 COMPATIBLE SO AS TO NOT VIOLATE POTENTIAL LICENSES, AND IF POSSIBLE BE VERIFIED
 241 WITH ANY APPLICABLE TCKS (SO IT WOULD BE AN "OFFICIAL" IMPLEMENTATION).***
 242