This is the enes100 simulator replacing the old simulator
Clone the repository locally and run npm install to install all the dependencies.
To run the simulator, run npm run dev and click the link the appears in the terminal. Leave this terminal running, it will update the website as you make changes.
Start by learning the codebase. Look at pretty much every file in /src
- sim has the simulation code, including the js interpreter stuff.
- sim/libs has the simulated Arduino libraries (Like Arduino.h, Enes100.h, Tank.h). If you want to change these libraries, change this code.
- ui has the svelte code for the UI. If you want to change the UI, change this code.
Most likely you have been assigned to change an some library, so probably what you want to change is /src/sim/libs. There you will find "defines" (CRASH_SITE MATERIAL_TYPE, etc) and
functions like Enes100.begin. You'll get a sense for these functions and be able to add them.
Add your name to the list of contributors in src/ui/About.svelte. Even for small changes! You are awesome and deserve credit!
Make sure to test your changes locally (by interacting with the webpage that appears when you open the link after running npm run dev) and then push the changes to github. This will trigger a rebuild.
The old simulator used an AWS machine to compile Arduino code, simulate the mission, and then send it back to the students. It was moderately slow and maintaining the AWS machine was a pain.
The new simulator is a web app that runs on the client's machine. It is maintained centrally in this repo and allows for the simulation to run continously, and the code to just effect the simulation. A lot more like real life.
The app uses svelte.
/sim is where all of the code to actually do simulation and rendering is.
/ui is where all of the svelte components to do ui are.
JSCPP had some issues (mainly, not throwing exceptions in some cases) so I made my own fork, compiled it, and then put the result in public/JSCPP.es5.js (minified and map file). Which means that if you find an error with JSCPP and want to change it, you will probably need to contact me. (Forrest Milner).
The UI buttons uses Material UI from google. If you want to add a button download it from there and put it in ui/buttons (see Editor.svelte for an example on how to import and display images). I used all the default settings for the buttons. I think that is a 24px image size. But default.