readme.mkd 10.2 KB
Newer Older
1
# SquirrelJME
2

3
4
5
**SquirrelJME** is a Java ME 8 Virtual Machine for embedded and Internet of
Things devices. It has the ultimate goal of being 99.9% compatible with the
Java ME standard.
6

7
8
9
10
11
This project is purely written in Java, with a small secondary C project, and 
is very easy to port to different hardware. For running on native hardware, a
compiler handles the conversion of Java byte code to machine code (in an
intermediate format). Any system specific APIs are accessed via standardized
system calls that handle the logic the compiler cannot provide. An execution
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
12
13
engine which is written in C, it offers a lightweight method of code
execution.
14
15
16

Additionally, there is a port of SquirrelJME to RetroArch which enables the
ability to play older J2ME software and games designed for flip-phones.
17

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
18
 * Copyright (C) 2013-2021 Stephanie Gawroriski
19
   <xer@multiphasicapps.net>
20
 * "SquirrelJME" and "Lex" are trademarked by Stephanie Gawroriski 2016-2021
21
 * _Lex_ and The _SquirrelJME_ Logo were illustrated by...
22
   * Kat Adam-MacEwen
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
23
   * Kat@CMYKat Designs & Illustrations <http://www.cmykat-designs.com/>
24

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
25
Please support me on [Patreon](https://www.patreon.com/SquirrelJME)!
26

27
Dedicated to _Emily_ (1998-2020), the developer of
28
29
[Mu](https://github.com/meepingsnesroms/Mu), you will not be forgotten.
Rest in peace.
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
30

31
32
33
Dedicated to _Near_ (2021), the developer of Higan, Ares, etc., may
your soul rest in peace. You will not be forgotten.

34
35
Badges:

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
36
37
 * _Checks and Quality_
   * [![CircleCI](
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
38
     https://img.shields.io/circleci/build/github/SquirrelJME/SquirrelJME/trunk.svg?label=CircleCI%20Build)](
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
39
     https://circleci.com/gh/SquirrelJME/SquirrelJME/tree/trunk)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
40
   * [![Code Climate Maintainability](
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
41
42
43
44
45
     https://img.shields.io/codeclimate/maintainability-percentage/SquirrelJME/SquirrelJME)](
     https://codeclimate.com/github/SquirrelJME/SquirrelJME)
     [![Code Climate technical debt](
     https://img.shields.io/codeclimate/tech-debt/SquirrelJME/SquirrelJME)](
     https://codeclimate.com/github/SquirrelJME/SquirrelJME)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
46
   * [![Docker Build](
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
47
     https://img.shields.io/docker/cloud/build/xerthesquirrel/squirreljme.svg?label=Docker%20Container)](
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
48
     https://hub.docker.com/r/xerthesquirrel/squirreljme/builds)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
49
50
51
   * [![RetroArch Core](
     https://git.libretro.com/libretro/SquirrelJME/badges/trunk/pipeline.svg?key_text=RetroArch%20Core&key_width=115)](
     https://git.libretro.org/libretro/SquirrelJME)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
52
 * _Social and Community_
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
53
   * [![Discord](https://img.shields.io/discord/278929900893634560.svg?label=Discord%20Server)](
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
54
55
     https://discord.gg/9PkMMKt)
   * [![Twitter](
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
56
     https://img.shields.io/twitter/follow/MultiPhasicApps.svg?label=Follow%20on%20Twitter)](
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
57
58
59
     https://twitter.com/MultiPhasicApps)
 * _Downloads and Activity_
   * ![Commit Activity](
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
60
     https://img.shields.io/github/commit-activity/w/SquirrelJME/SquirrelJME.svg?label=Code%20Commits)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
61
   * [![Docker Pulls](
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
62
     https://img.shields.io/docker/pulls/xerthesquirrel/squirreljme?label=Docker%20Pulls)](
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
63
64
     https://hub.docker.com/r/xerthesquirrel/squirreljme)
   * [![SourceForge Downloads](
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
65
     https://img.shields.io/sourceforge/dm/squirreljme.svg?label=SourceForge%20Downloads)](
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
66
     https://sourceforge.net/projects/squirreljme/files/)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
67
68
69
70
 * _Donations_
   * [![Liberapay](
     https://img.shields.io/liberapay/receives/xershadowtail.svg?logo=liberapay&label=LiberaPay)](
     https://liberapay.com/xershadowtail)
71

72
73
Information:

74
 * [User Guide](assets/user-guide/readme.mkd)
75
 * [Code of Conduct](code-of-conduct.mkd)
76
77
78
 * [License](license.mkd)
   * _Source_: GNU General Public License, Version 3 or later
   * _Assets_: Creative Commons CC-BY-SA 4.0
79
   * _Fonts_ : SIL Open Font License Version 1.1
80
81
82
83
84
85
 * [Contributing to SquirrelJME](contributing.mkd)
 * _End-User Documents_
   * [Building](building.mkd)
   * [Changelog](changelog.mkd)
   * [Compatibility](compatibility.mkd)
   * [History](history.mkd)
86
   * [Release Roadmap](route.mkd)
87
 * _Developer Resources_
88
   * [CircleCI Status](
89
     https://circleci.com/gh/SquirrelJME/SquirrelJME/tree/trunk)
90
   * [Developer Guide](developer-guide.mkd)
91
92
   * [Developer Notes](assets/developer-notes/index.mkd)
   * [Design Document](design.mkd)
93
   * [Porting SquirrelJME](porting.mkd)
94
95
96
   * [Project Scope](scope.mkd)
   * [CLDC 1.8 API (docs.oracle.com)](
     https://docs.oracle.com/javame/8.0/api/cldc/api/overview-summary.html)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
97

98
99
## Repository

100
101
 * [Online repository](http://squirreljme.cc/)
   ([HTTPS](https://squirreljme.cc/),
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
102
103
   [Tor (A)](http://vzwveldr7djnlpg7ujslaqre632htbl3unkmfbltpgumevw63jn47dad.onion/),
   [Tor (B)](http://hrkzpyi33og6j5z3anfpjuqkawvkw4kxyasrp64elg3i6dffihmdhxad.onion/))
104
 * SquirrelJME uses `fossil` <http://fossil-scm.org/>.
105
106
 * The repository may be cloned using Fossil:
   * One of these commands:
107
108
     * `fossil clone -u http://squirreljme.cc/ squirreljme.fossil`
     * `fossil clone -u https://squirreljme.cc/ squirreljme.fossil`
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
109
     * `fossil clone -u http://vzwveldr7djnlpg7ujslaqre632htbl3unkmfbltpgumevw63jn47dad.onion/ squirreljme.fossil`
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
110
     * `fossil clone -u http://hrkzpyi33og6j5z3anfpjuqkawvkw4kxyasrp64elg3i6dffihmdhxad.onion/ squirreljme.fossil`
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
111
     * `fossil clone -u http://squirrelmfbf2udn.onion/ squirreljme.fossil`
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
112
   * `mkdir squirreljme`
113
114
   * `cd squirreljme`
   * `fossil open ../squirreljme.fossil`
115
116
 * Alternatively via [GitHub](https://github.com/SquirrelJME/SquirrelJME):
   * `git clone https://github.com/SquirrelJME/SquirrelJME`
117
   * `cd SquirrelJME`
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
118
119
120
 * Alternatively via [repo.or.cz](https://repo.or.cz/SquirrelJME.git):
   * `git clone https://repo.or.cz/SquirrelJME.git`
   * `cd SquirrelJME`
121
 * Trunk Source Snapshot (Main website or `fossil serve` only):
122
123
   * [TAR.GZ](/tarball/squirreljme-trunk.tar.gz?uuid=trunk)
   * [ZIP](/zip/squirreljme-trunk.zip?uuid=trunk)
124

125
## Links
126

127
 * [My Portfolio](https://shadowtail.dev/)
128
 * [My Public PGP Key](public-key.gpg.mkd)
129
 * [SquirrelJME Twitter](https://twitter.com/MultiPhasicApps)
130
 * [SquirrelJME Mastodon](https://mastodon.online/@SquirrelJME)
131
 * Locations where you can get support:
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
132
   * [Discord](https://discord.gg/9PkMMKt)
133
134
135
136
   * _LiberaChat (IRC)_ (Bridged to _Discord_)
     * [#squirreljme](ircs://irc.libera.chat:6697/squirreljme) -- Main Support
     * [#squirreljme-softwares](ircs://irc.libera.chat:6697/squirreljme-software) -- Software channel
     * [##squirreljme](ircs://irc.libera.chat:6697/#squirreljme) -- Off-Topic
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
137
   * [Reddit](https://reddit.com/r/SquirrelJME)
138
 * Front facing social media:
139
   * [YouTube](https://www.youtube.com/channel/UCbmC7qQjeXUEUyE5XfDX5RA/)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
140
   * [Twitter](https://twitter.com/MultiPhasicApps)
141
 * [Docker Hub](https://hub.docker.com/r/xerthesquirrel/squirreljme)
142
 * [SourceForge](https://sourceforge.net/p/squirreljme/)
143
 * Personal Accounts (If you wish to contact me this way)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
144
   * [GitHub](https://github.com/XerTheSquirrel/)
145
   * [Keybase](https://keybase.io/xerthesquirrel)
146
   * [LinkedIn](https://www.linkedin.com/in/xerthesquirrel/)
147
   * [Mastodon (awoo.space)](https://awoo.space/@XerTheSquirrel)
148
   * [Twitter](https://twitter.com/XerShadowTail)
149
150
   * [YouTube (Personal)](
     https://www.youtube.com/channel/UCJ4QrvbDhjtd7u6EpfBQ__g)
151
   * E-Mail: <xer@multiphasicapps.net>
152

153
154
155
156
157
158
159
160
## Goals

 * _To be small_ - Smaller programs are easier to maintain and are usually
   simpler.
 * _To be fast_ - With the potential of AOT/JIT, systems that do not normally
   have a port of an existing virtual machine will usually only have an
   interpreter.
 * _To be compatible_ - So that existing Java ME 8 applications can run on this
161
162
163
   virtual machine, along with J2ME applications when required. This has the
   added bonus of allowing one to use older software to catalog for
   preservation.
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
164
165
166
 * _To compile once and run anywhere_ - Current and up to date Java
   implementations are limited only to a few select systems (_Solaris_,
   _Linux_, _BSD_, _Mac OS X_, and _Windows_). Java ME 8 as of this writing
167
168
169
170
171
172
   only supports the *FRDM-K64F* (dropped), *STM32429I-EVAL*, *Raspberry Pi*,
   *Intel Galileo Gen2* (preview), and *STM 32F746G DISCOVERY* (preview) all
   of which are either out of date or discontinued by their manufacturers.
   There are multitudes of devices that support **J2ME**, however that is
   horribly out of date when compared with the Java that is used today
   (**J2ME** is equal to Java 1.4 which was released in _2002_).
173
174
175

## Donations

176
177
178
You may donate to SquirrelJME to which would be used by the author to keep the
web server online, the purchasing of new hardware/software, and for the
purchasing of food items for consumption.
179

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
180
 * [Ko-Fi](http://ko-fi.com/xerthesquirrel)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
181
 * [Patreon](https://www.patreon.com/SquirrelJME)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
182
 * [Liberapay](https://liberapay.com/xershadowtail)
183
184
185
186
187
188
189
190
191
192
 * BitCoin (**BTC/XBT**):
   `3NEF6Pyt2JfWnb6hn7WFcwH5jpkHYPkTNj`
 * BitCoin Cash (**BCH**):
   `qrgww4z9aalgxyyddh5ax8jyy34c89phxuklp3hcwd`
 * Ethereum (**ETH**):
   `0x7C2316f5336C63855C199784a6e145921145B74a`
 * Ethereum Classic (**ETC**):
   `0x1b30e6411bd7da6dd72cA35dabD5b98BA25A0Ae7`
 * LiteCoin (**LTC**):
   `MAogNXdjPQ7ZABtpeXztCHf4UXvfiwTuGX`
193
194
 * Stellar Lumens (**XLM**):
   `GB4O2MAMTINKS6GM6RH34KO32TJMF4QZKZTFJBE4HIPFMKRBXFQ7IAF6`.
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
195
196
197
 * XRP (**XRP**):
   * Tag: `2912047087`
   * Address: `rw2ciyaNshpHe7bCHo4bRWq6pqqynnWKQg`
198
199
 * ZCash (**ZEC**):
   `t1cBD4dJYNWs5TQk1JKFNy1Qkg3TBx8noXQ`
200

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
201
## Important Statements
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
202

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
203
204
205
***JAVA AND ALL OTHER RELATED TRADEMARKS AND COPYRIGHTS ARE OWNED BY ORACLE
CORPORATION <http://www.oracle.com/>.***

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
206
***SQUIRRELJME IS NEITHER PRODUCED BY NOR ENDORSED BY ORACLE CORPORATION.***
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
207

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
208
209
210
211
***ALL SOURCE CODE IS WRITTEN BY MYSELF WITH FUNCTIONALITY DETERMINED BY THE
DOCUMENTED APIS AND RUN-TIME BEHAVIOR. I HAVE NOT LOOKED AT THE SOURCE CODE FOR
OTHER IMPLEMENTATIONS, NEITHER FREE SOFTWARE NOR PROPRIETARY IMPLEMENTATIONS.
ESSENTIALLY SQUIRRELJME IS A CLEAN-ROOM IMPLEMENTATION OF THE DESIGN OF JAVA
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
212
ME 8. THE IMPLEMENTATIONS OF THE JAVA ME 8
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
213
214
215
APIS AND ASSOCIATED JSRS/JEPS IS CONSIDERED BY MYSELF TO BE IN THE FAIR USE
(AND IT ALSO HELPS THE JAVA ECOSYSTEM BY PERMITTING IT TO RUN IN MORE PLACES
WHERE IT IS NOT SUPPORTED BY ORACLE).***
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
216

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
217
***THIS SOFTWARE IS INCOMPLETE AND IN ITS CURRENT STATE IS NOT CURRENTLY
218
219
220
221
100% COMPATIBLE WITH JAVA ME 8. THERE ARE CURRENTLY NO STABLE RELEASED VERSIONS
OF THIS SOFTWARE. AS SUCH THE FIRST MAJOR VERSION RELEASE WILL BE WHEN IT IS
COMPATIBLE SO AS TO NOT VIOLATE POTENTIAL LICENSES, AND IF POSSIBLE BE VERIFIED
WITH ANY APPLICABLE TCKS (SO IT WOULD BE AN "OFFICIAL" IMPLEMENTATION).***
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
222