Skip to content

Latest commit

 

History

History
116 lines (84 loc) · 4.84 KB

README.md

File metadata and controls

116 lines (84 loc) · 4.84 KB
Raw

Mimic

Temporary maintenance by EveryOS.

Do not expect this to continue.

Message from EveryOS: This is temporary maintenance. I plan on looking into doppio in order to write my own emulator.

A fully featured emulator for the Minecraft mod ComputerCraft that runs straight in your browser.

PRs are usually welcome. Please PR if you have a solution to any of the following problems:

  • In scripts/apis/fs.js, there is some commented code for a JS implementation of fs.open. It works for the first few opened handle, but lua5.1.js was not made for this, and will stop working after many files being opened. The problem, I believe, is in the handling of registering js functions. If you can fix this, please PR, as it will be a step closer to removing prebios.lua.
  • BrowserFS does not support links or symlinks.
  • Lua does not support C.luaL_error - meaning no stacktrace. This can quickly be modified in the original repo as F("luaL_error", str_byte_ptr, [*LuaState]); or something like that and than compiled but it will only give the stacktrace, not the error.

Here is the plan on updates:

  • Continue to update the graphics engine (TODO)
  • Use websockets to emulate the http.websocket api (TODO)
  • Configuration screen (TODO)
  • Download folders (TODO)
  • Upload files/folders (TODO)
  • Remove pre-bios (Not Immediate)
  • Screen Resize (in both contexts, resolution and canvas size) (TODO)
  • notes/todo.txt (TODO)
  • Anything I forgot (TODO)

Mimic makes use of

  • Emscripten - allowing a direct port of Lua 5.1 into JavaScript
  • asm.js - the engine behind Emscripten
  • lua5.1.js - a library built by Emscripten
  • Jquery - a DOM manipulation library
  • Ace Editor - a Lua editor written in pure JavaScript
  • Bootstrap - a CSS framework
  • BrowserFS.js - an emulation of the Node.JS filesystem API using LocalStorage and read-only ZIP backends
  • Purl - parsing of URL parameters
  • PrefixFree - removes the need for vendor prefixes in CSS
  • FileSaver.js Polyfill - library to download content to the computer
  • Blob.js Polyfill - a FileSaver.js dependency
  • The default rom files that come with ComputerCraft

Credits

License

Mimic is (as of October 2016, long ago) licensed under The MIT license

Copyright (c) 2016 Jason Chu (1lann) and Bennett Anderson (GravityScore).

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the 'Software'), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Note this license does not (necessarily) apply for material used in Mimic that we do not own.

lua5.1.js License

lua5.1.js is licensed under the MIT license, shown above.

lua5.1.js: Copyright (c) 2013, LogicEditor <info@logiceditor.com>
           Copyright (c) 2013, lua5.1.js authors (see AUTHORS)

Link: lua5.1.js

Emscripten License

Emscripten is licensed under the MIT license, shown above.

Copyright (c) 2010-2014 Emscripten authors, see AUTHORS file.

Link: Emscripten

Purl License

Purl is licensed under the MIT license, shown above.

Copyright (c) 2012 Mark Perkins, http://allmarkedup.com/

Link: Purl