readme.mkd

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