SimonDrives is a software that allows the user to drive the car in the SMCE client using a controller. The application is compatible with both Xbox(360 and newer)- and Playstation(dualshock 2 or newer) controllers. SimonDrives allows you to compete versus yourself or friends through a multitude of game modes and custom designed maps. The best scores on each map and mode will be stored in their respective leaderboard to provide a fun and competitive enviroment.
Check out the demo video
As a result of the ongoing pandemic, isolation and boredom has become prevalent issues which we want to battle with this software. We believe that usage of our software will provide lots of fun moments and bring joy to all who chooses to try it.
In broad strokes, the application provides a UI which is created using the Electron framwork. The UI is written in html, css and node. The connection and mapping regarding the controller is done in java(Credits to https://github.com/williamahartman/Jamepad). The car-behavior is written using C++ in Arduino. The communication between Arduino and the other parts of the software is handled by MQTT.
UI Information* - Information such as messages for resetting the game and to set speed for survival mode.
Gamecar information** - Information such as how far the car has travelled during TimeTrial as well as if the card has reached the finish line in the race mode.
In order to use this application to its full potential, the user needs to have one compatible controller alongside a functioning PC or Mac.
Start off by pressing "Code" followed by "Download ZIP" and then specify the preferred directory. You will need an archive-software in order to extract the files.
The following programs need to be downloaded before you can start the actual set-up process.
Follow instructions provided here: https://github.com/ItJustWorksTM/smce-gd/wiki
Link to downloading MQTT can be found here: https://mosquitto.org/download/
The JDK can be installed here: https://www.oracle.com/java/technologies/javase-downloads.html
Installer for Node can be found here: https://nodejs.org/en/download/ When Node is installed, run the commandprompt as an administrator(or terminal if you are using a MAC). In the command prompt, type "cd group-11". Then type: "npm install electron --save-dev", this will install the electron framework.
In order to add the extra tracks, download the files found in the links below. Then place the ".zip" in ./Godot/app_userdata/SMCE/mods. When the SMCE client is started, choose the desired track in the drop down menu.
Racetrack "myWorld": https://drive.google.com/file/d/1lHe_47g0P4kTZjiYb3MuHVucRUDM6wJ2/view?usp=sharing (Created by: Johan Axell)
Survival Map: https://drive.google.com/file/d/177es0sBwbxdldIHiEGzbwY_RNfrJIuvE/view?usp=sharing (Created by: Robin Hansen)
Racetrack "PlankRace": https://drive.google.com/file/d/1eHmO1ZvyJ8qMFUZYMPBYEjsX4qQn7E58/view?usp=sharing (Created by: Christofer Jidarv)
When the installation of the softwares listed above is complete, in order to play the actual game you will have follow the steps below.
Either you can compile the Java-code in your commandprompt, using "javac gamepad.java" to compile and then "java gamepad.java" to run, or use an IDE of your choice. You should receive a confirmation saying "Controller connected" if a compatible controller is plugged in.
In the command prompt, navigate to the Mosquitto root folder(using the "cd"-command as shown above), such as C:\Program Files (x86)\mosquitto and then start by running the command "net start mosquitto".
Start the client by opening the SMCE executable followed by "Start Fresh". On the next page, click the "+" and then go to "/group-11/arduino/smartcar/smartCar.ino. You can also click "=" to choose the desired map in the drop down menu. More about this in section 3.
In the commandprompt, find your way to /group-11/node/, in order to start the user interface, type "npm start".
You find the leaderboard-option on the first screen when you run "npm start". The leaderboard sports 4 different sections, depending on what mode and map you choose to play. As of right now, the top 5 scores will be saved for each mode and map.
On the first screen, choose "Start". You can then choose what mode you want to play, do note that as of now, the modes are only compatible with certain maps. More information on that can be found below.
When you choose Race Mode, you will be forwarded to a new screen containing the two different compatible maps. Do note that before you click on the map you want to play, you have to choose the corresponding one in the SMCE client before you click it. For race mode, you can choose to play "myWorld" or "PlankRace". When the map is chosen, click the "=" button followed by "Compile". When you have chosen what map you want to play, a screen counting down will show followed by the actual gamescreen.
As opposed to the Race Mode, when you choose the mode you will be starting the game right away, no map selection will be available. Do note that the map still needs to be chosen before you choose the game mode. For the survival mode, choose the map fittingly named "Survival mode" and for Time trial, choose "Playground".
In order to get the full functionality that survival mode provides, the user need to change sketch to the file found in "/group-11/arduino/survivalCar/survivalCar.ino". Skipping this step prevents the user from getting a better experience.
Note that you need to have SMCE, and then start the survival mode in the application.
Once you have started SMCE, pressed 'Start', followed by 'Follow', you can then click on 'Survival mode' in the application. You will then be presented with a screen counting down(3..2..1..). Once this countdown is finished, you will then be greated with the gamescreen, and the car will accelerate automatically. Your object is to avoid obstacles that may be in your way, and to survive for as long as possible.
As of now, there are no suitable ways to connect the UI to the actual SMCE client. This results in the user having to manage settings both in the SMCE client and the UI. This also means that in theory, maps that are not created for a specific gamemode can still be played which may skew the leaderboard-results.
Future plans include hosting the leaderboard online in order to compete versus players all around the globe, adding more tracks and the option to modify the appearence of the car. We also hope to add multiplayer at some point, so you are able to compete in real-time versus other players, as well as competing vs AI-controlled cars.
Information regarding creating and modifying current maps and car can be found here: https://github.com/ItJustWorksTM/smce-gd/wiki/Modding