/robco_rootkit

Django application for the for the hacking of Robco terminals in the video game series Fallout by Bethesda.

Primary LanguagePythonMIT LicenseMIT

robco_rootkit

Django project for the for the hacking of Robco terminals in the video game series Fallout by Bethesda.

Installation

This project requires the django project to be installed. It has been tested on using Python 2 and Python 3 as well as Django 1.9 and 1.10.

API

This project is intended as a demonstration of utilizing Django as a JSON API. The processing is simple enough to not require an API, but I would like to see this project utilized in other mediums such as native apps.

All requests should be JSON objects posted to the /api URL. The service will respond with a response object as documented below.

Request Object Syntax

request = "{" "'words'" ":" "[" [ word  { "," word } ] "]"  ["'feedback'" ":" "[" [ feedback { "," feedback  } ] "]" ]  "}" .

feedback = "{" "'word'" ":" word "," "'feedback'" ":" feedback_score "}" .

Request:

EBNF Request Diagram

feedback:

EBNF Request Feedback Diagram

Response Object Syntax

response = "{" "'valid'" ":" ( true | false ) ","  [ "'message'" ":" message "," ]  "'words'" ":" "[" [ word_response {"," word_response} ] "]"  "}" .

word_response = "{" "'word'" ":" word ","  "'valid'" ":" ("true" | "false") ","  "'position'" ":" position ","  [ "'score'" ":" score "," ]  [ "'feedback'" ":" feedback_score ]  "}" .

Response:

EBNF Response Diagram

word_response:

EBNF Word Response Diagram