1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-26 01:50:29 +00:00
CC-Tweaked/doc
Jonathan Coates c0643fadca
Build a web-based emulator for the documentation site (#1597)
Historically we've used copy-cat to provide a web-based emulator for
running example code on our documentation site. However, copy-cat is
often out-of-date with CC:T, which means example snippets fail when you
try to run them!

This commit vendors in copy-cat (or rather an updated version of it)
into CC:T itself, allowing us to ensure the emulator is always in sync
with the mod.

While the ARCHITECTURE.md documentation goes into a little bit more
detail here, the general implementation is as follows

 - In project/src/main we implement the core of the emulator. This
   includes a basic reimplementation of some of CC's classes to work on
   the web (mostly the HTTP API and ComputerThread), and some additional
   code to expose the computers to Javascript.

 - This is all then compiled to Javascript using [TeaVM][1] (we actually
   use a [personal fork of it][2] as there's a couple of changes I've
   not upstreamed yet).

 - The Javascript side then pulls in the these compiled classes (and
   the CC ROM) and hooks them up to [cc-web-term][3] to display the
   actual computer.

 - As we're no longer pulling in copy-cat, we can simplify our bundling
   system a little - we now just compile to ESM modules directly.

[1]: https://github.com/konsoletyper/teavm
[2]: https://github.com/SquidDev/teavm/tree/squid-patches
[3]: https://github.com/squiddev-cc/cc-web-term
2023-10-03 09:19:19 +01:00
..
events Build a web-based emulator for the documentation site (#1597) 2023-10-03 09:19:19 +01:00
guides Use standard Markdown link syntax for references 2023-08-24 11:23:33 +01:00
images Document setting up a gps constellation (#1070) 2022-07-02 10:09:38 +01:00
reference Re-license several more files under MPL-2.0 2023-03-28 10:28:59 +01:00
stub Use standard Markdown link syntax for references 2023-08-24 11:23:33 +01:00
head.html License CC:T according to the REUSE specification (#1351) 2023-03-15 21:52:13 +00:00
index.md Bump illuaminate version 2023-08-23 18:09:26 +01:00
logo-darkmode.png Add dark-mode compatible logo to README (#1521) 2023-07-18 19:26:45 +00:00
logo.png Optimise CC:T logo 2021-09-26 10:26:42 +01:00
mod-page.md Fix image links in Modrinth description 2023-05-24 22:35:45 +01:00