LeviParadis / RoboSport370

My project for my Intermediate Software Engineering class. Contains code for my project as well as documentation.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

RobotSport370 Project

What is it?

The RoboSport370 Project is a group project made by a team of 5 in CMPT 370, a computer science software engineering class offered by the University of Saskatchewan. The project’s purpose is to simulate a battle between robots that have had their AI written in forth code. The simulation is developed to work with any forth code so long as it meets the RoboSport370 Standards.

The RoboSport program also uses the RobotLibrarian as a module the RobotLibrarian is an online server capable of storing and searching through JSON files that contain information about Robots.

The Latest Version

Details of the latest version can be found in the implementation document. The project is currently in an alpha stage of development. Also as of version 0.0.1 a cleaner changelog is being used. See the file CHANGELOG

Documentation

The documentation available includes a Javadoc in the robosport/docs/ *directory, a requirements document in the docs/reqts/RequirementsDoc, a design document in the docs/design/DesignDoc, an implementation document in docs/impl/ImplmentationDoc, and finally a manual in docs/UserManual

The changelog is currently only available through the git repository by viewing the commit messages.

Libraries

Currently the program uses only a few different libraries:

  1. Java Libraries: this includes the standard libraries that are included with the current release of Java
  2. LibGdx: This is a third party open source library, this is used for many of the GUI elements and animations. For more information visit https://libgdx.badlogicgames.com/
  3. JSON: The JSON standard library is used for reading data from the Robot Librarian sub-module which is an online based program used for storing and mantaining robots written in Forth code.

Installation

Download the RoboSport370.zip project from the following path robosport370/Runnable/RoboSport370.zip. Unzip the folder and then run the .jar file. If issues occur make sure the .jar file is in the same folder as the other downloaded files.

License

The project is currently unlicensed

Contacts

If you have any questions/concerns about the project or would like to know more about the development process please email ldp343@mail.usask.ca

About

My project for my Intermediate Software Engineering class. Contains code for my project as well as documentation.


Languages

Language:HTML 84.5%Language:Java 14.7%Language:CSS 0.7%Language:JavaScript 0.0%