readme.mkd 8.55 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
12
13
14
15
16
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
engine which is written in C is available and it offers a lightweight method
of code execution.

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

18
 * Copyright (C) 2013-2020 Stephanie Gawroriski
19
   <xer@multiphasicapps.net>
20
 * "SquirrelJME" and "Lex" are trademarked by Stephanie Gawroriski 2016-2020
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
28
29
Dedicated to Emily (1998-2020), the developer of
[Mu](https://github.com/meepingsnesroms/Mu), you will not be forgotten.
Rest in peace.
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
30

31
32
Badges:

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
33
 * ![Commit Activity](
34
https://img.shields.io/github/commit-activity/w/SquirrelJME/SquirrelJME.svg)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
35
36
37
 * [![Patreon](
   https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2FSquirrelJME%2Fpledges&style=flat)](
   https://www.patreon.com/SquirrelJME)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
38
 * [![Liberapay](
39
  https://img.shields.io/liberapay/receives/xershadowtail.svg?logo=liberapay)](
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
40
   https://liberapay.com/xershadowtail)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
41
 * [![CircleCI](
42
43
   https://img.shields.io/circleci/build/github/SquirrelJME/SquirrelJME/trunk.svg)](
   https://circleci.com/gh/SquirrelJME/SquirrelJME/tree/trunk)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
44
45
 * [![Discord](https://img.shields.io/discord/278929900893634560.svg)](
   https://discord.gg/9PkMMKt)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
46
47
48
 * [![Twitter](
 https://img.shields.io/twitter/follow/MultiPhasicApps.svg?label=Follow)](
   https://twitter.com/MultiPhasicApps)
49
50
51
52
53
54
 * [![Docker](
   https://img.shields.io/docker/automated/xerthesquirrel/squirreljme)](
   https://hub.docker.com/r/xerthesquirrel/squirreljme)
 * [![Docker Build](
   https://img.shields.io/docker/build/xerthesquirrel/squirreljme)](
   https://hub.docker.com/r/xerthesquirrel/squirreljme/builds)
55
56
57
 * [![Download SquirrelJME](
   https://img.shields.io/sourceforge/dm/squirreljme.svg)](
   https://sourceforge.net/projects/squirreljme/files/latest/download)
58

59
60
Information:

61
 * [Code of Conduct](code-of-conduct.mkd)
62
63
64
 * [License](license.mkd)
   * _Source_: GNU General Public License, Version 3 or later
   * _Assets_: Creative Commons CC-BY-SA 4.0
65
   * _Fonts_ : SIL Open Font License Version 1.1
66
67
68
69
70
71
 * [Contributing to SquirrelJME](contributing.mkd)
 * _End-User Documents_
   * [Building](building.mkd)
   * [Changelog](changelog.mkd)
   * [Compatibility](compatibility.mkd)
   * [History](history.mkd)
72
   * [Release Roadmap](route.mkd)
73
 * _Developer Resources_
74
   * [CircleCI Status](
75
     https://circleci.com/gh/SquirrelJME/SquirrelJME/tree/trunk)
76
   * [Developer Guide](developer-guide.mkd)
77
78
   * [Developer Notes](assets/developer-notes/index.mkd)
   * [Design Document](design.mkd)
79
   * [Porting SquirrelJME](porting.mkd)
80
81
82
   * [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
83

84
85
## Repository

86
87
 * [Online repository](http://squirreljme.cc/)
   ([HTTPS](https://squirreljme.cc/),
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
88
   [Tor (A)](http://hrkzpyi33og6j5z3anfpjuqkawvkw4kxyasrp64elg3i6dffihmdhxad.onion/),
89
   [Tor (B)](http://squirrelmfbf2udn.onion/))
90
 * SquirrelJME uses `fossil` <http://fossil-scm.org/>.
91
92
 * The repository may be cloned using Fossil:
   * One of these commands:
93
94
     * `fossil clone -u http://squirreljme.cc/ squirreljme.fossil`
     * `fossil clone -u https://squirreljme.cc/ squirreljme.fossil`
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
95
     * `fossil clone -u http://hrkzpyi33og6j5z3anfpjuqkawvkw4kxyasrp64elg3i6dffihmdhxad.onion/ squirreljme.fossil`
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
96
     * `fossil clone -u http://squirrelmfbf2udn.onion/ squirreljme.fossil`
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
97
   * `mkdir squirreljme`
98
99
   * `cd squirreljme`
   * `fossil open ../squirreljme.fossil`
100
101
 * Alternatively via [GitHub](https://github.com/SquirrelJME/SquirrelJME):
   * `git clone https://github.com/SquirrelJME/SquirrelJME`
102
   * `cd SquirrelJME`
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
103
104
105
 * Alternatively via [repo.or.cz](https://repo.or.cz/SquirrelJME.git):
   * `git clone https://repo.or.cz/SquirrelJME.git`
   * `cd SquirrelJME`
106
 * Trunk Source Snapshot (Main website or `fossil serve` only):
107
108
   * [TAR.GZ](/tarball/squirreljme-trunk.tar.gz?uuid=trunk)
   * [ZIP](/zip/squirreljme-trunk.zip?uuid=trunk)
109
 * [SourceForge](https://sourceforge.net/p/squirreljme/)
110

111
## Links
112

113
 * [My Portfolio](https://shadowtail.dev/)
114
 * [My Public PGP Key](public-key.gpg.mkd)
115
 * [SquirrelJME Twitter](https://twitter.com/MultiPhasicApps)
116
 * Locations where you can get support:
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
117
   * [Discord](https://discord.gg/9PkMMKt)
118
 * Front facing social media:
119
120
   * [YouTube](
     https://www.youtube.com/playlist?list=PLpBpyrtWn1U3motx3AUOm70qG5zraCepD)
121
 * [Docker Hub](https://hub.docker.com/r/xerthesquirrel/squirreljme)
122
 * Personal Accounts (If you wish to contact me this way)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
123
   * [GitHub](https://github.com/XerTheSquirrel/)
124
   * [Keybase](https://keybase.io/xerthesquirrel)
125
   * [LinkedIn](https://www.linkedin.com/in/xerthesquirrel/)
126
   * [Mastodon (awoo.space)](https://awoo.space/@XerTheSquirrel)
127
   * [Twitter](https://twitter.com/XerShadowTail)
128
   * E-Mail: <xer@multiphasicapps.net>
129

130
131
132
133
134
135
136
137
## 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
138
139
140
   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
141
142
143
144
145
146
147
 * _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
   only supports the *FRDM-K64F* and the *Raspberry Pi*. 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_).
148
149
150

## Donations

151
152
153
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.
154

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
155
 * [Ko-Fi](http://ko-fi.com/xerthesquirrel)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
156
 * [Patreon](https://www.patreon.com/SquirrelJME)
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
157
 * [Liberapay](https://liberapay.com/xershadowtail)
158
159
160
161
162
163
164
165
166
167
 * BitCoin (**BTC/XBT**):
   `3NEF6Pyt2JfWnb6hn7WFcwH5jpkHYPkTNj`
 * BitCoin Cash (**BCH**):
   `qrgww4z9aalgxyyddh5ax8jyy34c89phxuklp3hcwd`
 * Ethereum (**ETH**):
   `0x7C2316f5336C63855C199784a6e145921145B74a`
 * Ethereum Classic (**ETC**):
   `0x1b30e6411bd7da6dd72cA35dabD5b98BA25A0Ae7`
 * LiteCoin (**LTC**):
   `MAogNXdjPQ7ZABtpeXztCHf4UXvfiwTuGX`
168
169
 * Stellar Lumens (**XLM**):
   `GB4O2MAMTINKS6GM6RH34KO32TJMF4QZKZTFJBE4HIPFMKRBXFQ7IAF6`.
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
170
171
172
 * XRP (**XRP**):
   * Tag: `2912047087`
   * Address: `rw2ciyaNshpHe7bCHo4bRWq6pqqynnWKQg`
173
174
 * ZCash (**ZEC**):
   `t1cBD4dJYNWs5TQk1JKFNy1Qkg3TBx8noXQ`
175

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
176
## Important Statements
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
177

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

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

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
183
184
185
186
***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
187
ME 8. THE IMPLEMENTATIONS OF THE JAVA ME 8
Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
188
189
190
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
191

Stephanie Gawroriski's avatar
Stephanie Gawroriski committed
192
***THIS SOFTWARE IS INCOMPLETE AND IN ITS CURRENT STATE IS NOT CURRENTLY
193
194
195
196
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
197
198