- One Word Story is a common creativity game where a group of participants take turns contributing a word to a story with no communication on the story's heading. We thought this would be a perfect game to port online, where anyone can visit a website, join a game, and contribute words to a story with random people around the world!
- To play the game, you would navigate to the website, enter a display name, and hit play! You would be connected to other players and could begin contributing words to a story. When a game ends, the story is saved to the blog. Anyone can view the blog of all stories, like them, suggest titles, or add comments!
Early on, we defined 4 core roles which were distributed among the group members. Quality managers are in charge of keeping track of proper testing, Documentation managers ensure documentation conventions are satisfied, Architects work on design, and Coordinator organizes/runs meetings and maintains GitHub Project management.
| Name | Role(s) |
|---|---|
| Aleksey Panas | Coordinator, Architect |
| Andrii Serdiuk | Architect |
| Patrick Fidler | Architect |
| Mariana Piz | Quality Manager |
| Alexander Ryabchenko | Quality/Documentation Manager |
| Daniel Honciuc Menendez | Quality Manager |
| Sohail Sarkar | Documentation Manager |
| Joel Mathew | Documentation Manager |
In this project, we used the following design patterns. Many of them were implemented after scrupulous process of refactoring.
| Design Pattern | Examples in our project |
|---|---|
| Strategy | Validity Checkers for Titles and Comments |
| Facade | ValidityChecker is a facade for Punctuation and Word checkers |
| Observer | PlayerPoolListener |
| Simple Factory | Game, Player |
| Factory Method | Response (from Exception) |
| Builder | GameDisplayData |
Although, we aimed to satisfy Clean Architecture design as much as possible, in certain places we made a conscious decision not to adhere to certain rules.
- In Pull Game Ended (PGE) use-case, we save RecursiveSymboledIntegerHashMap (RSIH) and pass it to output to the net.onewordstory.core.adapters layer despite it being an entity. Although RSIH is an entity, it does not have any ties to actual fundamental net.onewordstory.core.entities; in fact, it is a utility data structure which is effectively independent of net.onewordstory.core.entities. This being said, instead of pointlessly transferring it to a duplicate object by a different name, we will pass it directly. We do not believe that this crosses layers. In fact, we even store these classes in a separate "net.onewordstory.core.util" folder.
- In the new view model structure, we directly return use-case-layer objects - StoryRepoData, TitleRepoData, CommentRepoData, and the Response object - to the view. this means that the view crosses into the use case layer. This is not unfixable since alternatively, we could create a duplicate object with the same fields. Moreover, there is not much more manipulation needed for the view to display the situation.
- Clone the repository and open the project in IntelliJ
- Run
git checkout 58-view-spring-viewin terminal to switch to the latest version of the project - Ensure that Gradle and SDK versions in Intellij are configured to Java 17
- Setup a configuration to start the
net.onewordstory.core.Mainmethod in therunnersubmodule:
- Run the configuration
- You should observe Spring launching in the terminal. You can now navigate to http://localhost:8080 and use the application!
- Typing "shutdown" in the terminal of the running server will close the application (currently doesn't work in specific situations)
- Visit releases and download
runner.jarfor ReleaseOne Word Story v1.0.0+pre - With java 17 from command line, run the jar
java -jar runner.jar, or find another way to run the jar - You should observe Spring launching in the terminal. You can now navigate to http://localhost:8080 and use the application!
- Typing "shutdown" in the terminal of the running server will close the application (currently doesn't work in specific situations)
- Visit https://onewordstory.net to enjoy our current deployed release of One Word Story
This project must be run in Java 17
- Shutdown Messages: Design a nice structure for use cases to send a message back to the shutdown server use case to display in the view’s terminal (e.g “Sw shutdown successfully”). This would require some cleanup and potentially putting shutdown on its own thread to not block the view
- Time and Round-based Games: Game ends when either a timer runs out or a certain number of turns pass
- Kicking AFK players: Keep integer count of how many turns a player missed. If player missed a certain number of turns, remove them
- Multiple Public Lobbies and Matchmaking Settings: Settings can be selected and sent to the server when joining a public lobby so that you are sorted into a lobby with those desired settings. Weekly Topic. Join a public lobby where the topic is the “weekly topic”. These stories will be filed separately when complete and there will be a “best weekly topic story” vote.
- Lobby Restoration: Constantly save lobby information to the repository so that if the server ever crashes, previously active lobbies could be restored. Obviously the players would all have been disconnected if the server crashed. We’d need to decide the exact protocol.
- Comment Replies: As the title implies, comments may be replied to!
- Website Rework A restructuring of the current website's design to make it more intuitive and appealing.