Assignment

Refactor, improve, and extend the adventure game from two weeks ago to support adding and removing items from rooms. Also, build a web server to allow your game to be played from the browser.

Before you start, you will need to create a new branch on your amazing-adventures GitHub repository. We suggest naming it part-2, or something similar.

The rubric can be found here.

The user interface (UI) for Part 3 option 2 can be found here: https://courses.engr.illinois.edu/cs126/sp2020/adventure/#/.

Suggestions on how to test I/O can be found here: https://github.com/CS126SP20/NumberGuesser

Gradescope

There is no autograder for this assignment, but you still must submit your GitHub repository to Gradescope. When submitting to Gradescope, make sure you use the correct branch.

Goals

• Deciphering previously written code
• Understand and utilize HTTP
• Learn how servers and HTTP APIs work

Getting Started

You will develop this assignment in the same repository as last week, using your existing code. You should a) create a new branch in your repository, and b) work, commit, and push your engine modifications to that branch (and not to the master branch). See here and here for some instructions that may help.

Part 1: Improving Your Code

Review your original Amazing Adventures feedback in Gradescope and implement the changes that your moderator suggested. Make sure you click through each section of the Gradescope rubric to see comments specific to each topic.

Part 2: Extending the Game, I

Loading the JSON

Your game engine must be able to support loading JSON either from a local file or from a URL on the Internet, and gracefully handle the situations when an error occurs. With Jackson, here is how to read from a URL:

URL url = new URL("https://courses.grainger.illinois.edu/cs126/sp2020/resources/siebel.json");
Layout layout = new ObjectMapper().readValue(url, Layout.class);

You will need to accomplish this task using command-line arguments.

Support for new commands

You will need to support the following commands:

• add <item> - adds an item into a room if it does not already exist
• remove <item> - removes an existing item from the room
• examine - prints out the description of the current room and any items present in the room

Example

You are on Matthews, outside the Siebel Center
From here, you can go: East
Items visible: coin
> add laptop
> examine
You are on Matthews, outside the Siebel Center
From here, you can go: East
Items visible: coin, laptop
> add laptop
The item 'laptop' is already in this room.
> go EAST
You are in the west entry of Siebel Center. You can see the elevator, the ACM office, and hallways to the north and east.
From here, you can go: West, Northeast, North, or East
Items visible: sweatshirt, key
> remove phone
There is no item 'phone' to remove.
> remove sweatshirt
> examine
You are in the west entry of Siebel Center. You can see the elevator, the ACM office, and hallways to the north and east.
From here, you can go: West, Northeast, North, or East
Items visible: key
> go wesT
You are on Matthews, outside the Siebel Center
From here, you can go: East
Items visible: coin, laptop
...

This is just an example implementation: your game does not need to have the exact same text as shown above.

Part 3: Choose One

For part 3, you will have the option to choose one of the following extensions.

Option 1: Custom Extensions

You must extend your game engine in a substantial and interesting way. You should create your own map following the JSON schema from Amazing Adventures part 1. You are allowed to extend the JSON schema in order to make your extensions work.

The extension must be of sufficient complexity and technical difficulty; if you are unsure whether your extension meets that criteria, make a private post on Piazza. Extensions that are trivial will receive a reduced grade.

Examples of reasonable extensions include:

• Add monsters that can be fought
• Add items that allow teleportation
• Add the ability to play with more than one player
• Add simple puzzles and challenges for picking up keys
• Keep track of the total moves/time spent playing, and add a leaderboard
• Add additional commands that allow the player to do more interesting things

Be creative!

Option 2: Web Server

See the template repository here for the files you will need for the server. In particular, your project structure should look something like this:

.
├── pom.xml
├── README.md
└── src
    ├── main
    │   ├── java
    │   │   ├── Main.java
    │   │   └── student
    │   │       ├── adventure
    │   │       │   ├── Adventure.java
    │   │       │   ├── Direction.java
    │   │       │   ├── Layout.java
    │   │       │   └── Room.java
    │   │       └── server
    │   │           ├── AdventureResource.java
    │   │           ├── AdventureService.java
    │   │           ├── CS126Server.java
    │   │           ├── Requests.java
    │   │           └── Responses.java
    │   └── resources
    │       ├── client.cert
    │       ├── keystore_client
    │       ├── keystore_server
    │       ├── server.cert
    │       ├── truststore_client
    │       └── truststore_server
    └── test
        └── java
            └── student
                ├── adventure
                │   └── AdventureTest.java
                └── server
                    └── ServerTest.java

12 directories, 20 files

Don't worry if your project structure doesn't exactly match what is above. The main idea is that the new files should be placed in the correct location. After you finish adding these files and fixing any resulting compile errors, make sure to commit and push your changes.

After the above is complete, start the server and visit the following url: https://localhost:8080/adventure/v1/ping. This is where your server is running on your computer. You should see something saying "Your connection is not private. danger blah blah security blah blah risk blah ...". You need to click "Advanced/Show Details" and proceed to "localhost (unsafe)/Accept the risk and continue/Visit this website". Then you'll see a blank screen or some text; this means you are ready to begin testing out the UI. To see more about why your browser is warning you, see the section on "More about servers, ..., SSL, ...".

WARNING: If you are running Mac OS and facing problems, please read @405 on Piazza.

You need to utilize your Adventure game engine to implement the methods in src/main/java/student/server/AdventureService.java. You may need to change some of the code in src/main/java/student/server/AdventureResource.java to get the code to compile.

You can find descriptions about what each of the methods should do here. You will also be able to test your game engine server using that site or the Swagger UI.

To start up the server, you will need to do the following:

HttpServer server = CS126Server.createServer(AdventureResource.class);
server.start();

We have given you most of the code for the server. All that needs to be done here is to connect the web server with your Adventure game engine.

You can test different JSON files by specifying the url query parameter, like the following:

https://courses.engr.illinois.edu/cs126/sp2020/adventure/#/?url=https://pastebin.com/raw/9kX4Kidz

There are even host and port query parameters that can be used to specify the server the UI should attempt to connect to. By default, host=localhost and port=8080.