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